summaryrefslogtreecommitdiff
path: root/hifi/xaf/hifi-dpf/core/xf-io.c
diff options
context:
space:
mode:
Diffstat (limited to 'hifi/xaf/hifi-dpf/core/xf-io.c')
-rw-r--r--hifi/xaf/hifi-dpf/core/xf-io.c644
1 files changed, 644 insertions, 0 deletions
diff --git a/hifi/xaf/hifi-dpf/core/xf-io.c b/hifi/xaf/hifi-dpf/core/xf-io.c
new file mode 100644
index 00000000..09f8e3e6
--- /dev/null
+++ b/hifi/xaf/hifi-dpf/core/xf-io.c
@@ -0,0 +1,644 @@
+/*******************************************************************************
+* Copyright (C) 2018 Cadence Design Systems, Inc.
+*
+* Permission is hereby granted, free of charge, to any person obtaining
+* a copy of this software and associated documentation files (the
+* "Software"), to use this Software with Cadence processor cores only and
+* not with any other processors and platforms, subject to
+* the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+******************************************************************************/
+
+/*******************************************************************************
+ * xf-io.c
+ *
+ * Generic input/output ports handling
+ *
+ ******************************************************************************/
+
+#define MODULE_TAG IO
+
+/*******************************************************************************
+ * Includes
+ ******************************************************************************/
+
+#include "xf.h"
+
+/*******************************************************************************
+ * Tracing configuration
+ ******************************************************************************/
+
+TRACE_TAG(INIT, 1);
+TRACE_TAG(INPUT, 1);
+TRACE_TAG(OUTPUT, 1);
+TRACE_TAG(ROUTE, 1);
+
+/*******************************************************************************
+ * Input port API
+ ******************************************************************************/
+
+/* ...initialize input port structure */
+int xf_input_port_init(xf_input_port_t *port, u32 size, u32 align, u32 core)
+{
+ /* ...allocate local internal buffer of particular size and alignment */
+ if (size)
+ {
+ /* ...internal buffer is used */
+ XF_CHK_ERR(port->buffer = xf_mem_alloc(size, align, core, 0), -ENOMEM);
+ }
+ else
+ {
+ /* ...no internal buffering is used */
+ port->buffer = NULL;
+ }
+
+ /* ...initialize message queue */
+ xf_msg_queue_init(&port->queue);
+
+ /* ...set buffer size */
+ port->length = size;
+
+ /* ...enable input by default */
+ port->flags = XF_INPUT_FLAG_ENABLED | XF_INPUT_FLAG_CREATED;
+
+ /* ...mark buffer is empty */
+ port->filled = 0, port->access = NULL;
+
+ TRACE(INIT, _b("input-port[%p] created - %p@%u[%u]"), port, port->buffer, align, size);
+
+ return 0;
+}
+
+/* ...put message into input port queue; return non-zero if queue was empty */
+int xf_input_port_put(xf_input_port_t *port, xf_message_t *m)
+{
+ /* ...check if input is enabled */
+ if ((port->flags & XF_INPUT_FLAG_ENABLED) == 0)
+ {
+ /* ...input disabled; this is an error condition, likely */
+ TRACE(INPUT, _b("input-port[%p] disabled"), port);
+
+ /* ...release the message instantly */
+ xf_response_ok(m);
+
+ /* ...buffer has not been accepted - no actions to take */
+ return 0;
+ }
+ else if (m->length == 0)
+ {
+ /* ...it is forbidden to pass more than one zero-length message */
+ BUG(port->flags & XF_INPUT_FLAG_EOS, _x("invalid state: %x"), port->flags);
+
+ /* ...received a message with zero-length; mark end-of-stream condition */
+ port->flags ^= XF_INPUT_FLAG_ENABLED | XF_INPUT_FLAG_EOS;
+
+ /* ...still enqueue that zero-length message; it will be processed afterwards */
+ TRACE(INPUT, _b("input-port[%p]: zero-length buffer received"), port);
+ }
+ else
+ {
+ TRACE(INPUT, _b("input-port[%p]: buffer received - %u bytes"), port, m->length);
+ }
+
+ /* ...enqueue message and set access pointer as needed */
+ if (xf_msg_enqueue(&port->queue, m))
+ {
+ /* ...first message put - set access pointer and length */
+ port->access = m->buffer, port->remaining = m->length;
+
+ /* ...if first message is empty, mark port is done */
+ (!port->access ? port->flags ^= XF_INPUT_FLAG_EOS | XF_INPUT_FLAG_DONE : 0);
+
+ /* ...return non-zero to indicate the first buffer is placed into port */
+ return 1;
+ }
+ else
+ {
+ /* ...subsequent message placed into buffer */
+ return 0;
+ }
+}
+
+/* ...internal helper - input message completion */
+static inline int xf_input_port_complete(xf_input_port_t *port)
+{
+ /* ...dequeue message from queue */
+ xf_message_t *m = xf_msg_dequeue(&port->queue);
+
+ /* ...message cannot be NULL */
+ BUG(m == NULL, _x("invalid port state"));
+
+ /* ...complete current message (EMPTY-THIS-BUFFER always; no length adjustment) */
+ xf_response(m);
+
+ /* ...set up next head */
+ if ((m = xf_msg_queue_head(&port->queue)) != NULL)
+ {
+ /* ...set new access pointers */
+ port->access = m->buffer, port->remaining = m->length;
+
+ /* ...return indication that there is an input message */
+ return 1;
+ }
+ else
+ {
+ /* ...no more messages; reset access pointer */
+ port->access = NULL;
+
+ /* ...return indication that input port has no data available */
+ return 0;
+ }
+}
+
+/* ...fill-in required amount of data into input port buffer */
+int xf_input_port_fill(xf_input_port_t *port)
+{
+ u32 filled = port->filled;
+ u32 remaining = port->remaining;
+ u32 copied = 0;
+ s32 n;
+
+ /* ...function shall not be called if no internal buffering is used */
+ BUG(xf_input_port_bypass(port), _x("Invalid transaction"));
+
+ /* ...if there is no message pending, bail out */
+ if (!xf_msg_queue_head(&port->queue))
+ {
+ TRACE(INPUT, _b("No message ready"));
+ return 0;
+ }
+
+ /* ...calculate total amount of bytes we need to copy */
+ n = (s32)(port->length - filled);
+
+ /* ...get at most "n" bytes from input message(s) buffer(s) */
+ while (n > 0)
+ {
+ u32 k;
+
+ /* ...determine the size of the chunk to copy */
+ ((k = remaining) > n ? k = n : 0);
+
+ /* ...process zero-length input message separately */
+ if (k == 0)
+ {
+ /* ...end-of-stream condition must be set */
+ BUG((port->flags & XF_INPUT_FLAG_EOS) == 0, _x("port[%p]: invalid state: %x"), port, port->flags);
+
+ /* ...mark stream is completed */
+ port->flags ^= XF_INPUT_FLAG_EOS | XF_INPUT_FLAG_DONE;
+
+ /* ...reset total amount of bytes to fill */
+ n = 0;
+
+ /* ...do not release message yet */
+ TRACE(INPUT, _b("input-port[%p] done"), port);
+
+ /* ...and break the loop */
+ break;
+ }
+
+ /* ...buffer must be set */
+ BUG(!port->access, _x("invalid port state"));
+
+ /* ...get required amount from input buffer */
+ memcpy(port->buffer + filled, port->access, k), port->access += k;
+
+ /* ...advance buffer positions */
+ filled += k, copied += k, n -= k;
+
+ /* ...check if input buffer is processed completely */
+ if ((remaining -= k) == 0)
+ {
+ if (!xf_input_port_complete(port))
+ {
+ /* ...no more input messages; break the loop */
+ break;
+ }
+ else
+ {
+ /* ...update remaining counter */
+ remaining = port->remaining;
+ }
+ }
+ }
+
+ /* ...update buffer positions */
+ port->filled = filled, port->remaining = remaining;
+
+ /* ...return indicator whether input buffer is prefilled */
+ return (n == 0);
+}
+
+/* ...pad input buffer with given pattern */
+void xf_input_port_pad(xf_input_port_t *port, u8 pad)
+{
+ u32 filled = port->filled;
+ s32 k;
+
+ /* ...do padding if port buffer is not filled */
+ if ((k = port->length - filled) > 0)
+ {
+ memset(port->buffer + filled, pad, k);
+
+ /* ...indicate port is filled */
+ port->filled = port->length;
+ }
+}
+
+/* ...consume input buffer data */
+void xf_input_port_consume(xf_input_port_t *port, u32 n)
+{
+ /* ...check whether input port is in bypass mode */
+ if (xf_input_port_bypass(port))
+ {
+ /* ...port is in bypass mode; advance access pointer */
+ if ((port->remaining -= n) == 0)
+ {
+ /* ...complete message and try to rearm input port */
+ xf_input_port_complete(port);
+
+ /* ...check if end-of-stream flag is set */
+ if (xf_msg_queue_head(&port->queue) && !port->access)
+ {
+ BUG((port->flags & XF_INPUT_FLAG_EOS) == 0, _x("port[%p]: invalid state: %x"), port, port->flags);
+
+ /* ...mark stream is completed */
+ port->flags ^= XF_INPUT_FLAG_EOS | XF_INPUT_FLAG_DONE;
+
+ TRACE(INPUT, _b("input-port[%p] done"), port);
+ }
+ }
+ else
+ {
+ /* ...advance message buffer pointer */
+ port->access += n;
+ }
+ }
+ else if (port->filled > n)
+ {
+ u32 k = port->filled - n;
+
+ /* ...move tail of buffer to the head (safe to use memcpy) */
+ memcpy(port->buffer, port->buffer + n, k);
+
+ /* ...adjust filled position */
+ port->filled = k;
+ }
+ else
+ {
+ /* ...entire buffer is consumed; reset fill level */
+ port->filled = 0;
+ }
+}
+
+/* ...purge input port queue */
+void xf_input_port_purge(xf_input_port_t *port)
+{
+ xf_message_t *m;
+
+ /* ...bail out early if port is not created */
+ if (!xf_input_port_created(port)) return;
+
+ /* ...free all queued messages with generic "ok" response */
+ while ((m = xf_msg_dequeue(&port->queue)) != NULL)
+ {
+ xf_response_ok(m);
+ }
+
+ /* ...reset internal buffer position */
+ port->filled = 0, port->access = NULL;
+
+ /* ...reset port flags */
+ port->flags = (port->flags & ~__XF_INPUT_FLAGS(~0)) | XF_INPUT_FLAG_ENABLED | XF_INPUT_FLAG_CREATED;
+
+ TRACE(INPUT, _b("input-port[%p] purged"), port);
+}
+
+/* ...save flow-control message for propagated input port purging sequence */
+void xf_input_port_control_save(xf_input_port_t *port, xf_message_t *m)
+{
+ /* ...make sure purging sequence is not active */
+ BUG(port->flags & XF_INPUT_FLAG_PURGING, _x("invalid state: %x"), port->flags);
+
+ /* ...place message into internal queue */
+ xf_msg_enqueue(&port->queue, m);
+
+ /* ...set port purging flag */
+ port->flags ^= XF_INPUT_FLAG_PURGING;
+
+ TRACE(INPUT, _b("port[%p] start purge sequence"), port);
+}
+
+/* ...mark flushing sequence is completed */
+void xf_input_port_purge_done(xf_input_port_t *port)
+{
+ /* ...make sure flushing sequence is ongoing */
+ BUG((port->flags & XF_INPUT_FLAG_PURGING) == 0, _x("invalid state: %x"), port->flags);
+
+ /* ...complete saved flow-control message */
+ xf_response_ok(xf_msg_dequeue(&port->queue));
+
+ /* ...clear port purging flag */
+ port->flags ^= XF_INPUT_FLAG_PURGING;
+
+ TRACE(INPUT, _b("port[%p] purge sequence completed"), port);
+}
+
+/* ...destroy input port data */
+void xf_input_port_destroy(xf_input_port_t *port, u32 core)
+{
+ /* ...bail out earlier if port is not created */
+ if (!xf_input_port_created(port)) return;
+
+ /* ...deallocate input buffer if needed */
+ (port->buffer ? xf_mem_free(port->buffer, port->length, core, 0), port->buffer = NULL : 0);
+
+ /* ...reset input port flags */
+ port->flags = 0;
+
+ TRACE(INIT, _b("input-port[%p] destroyed"), port);
+}
+
+/*******************************************************************************
+ * Output port API
+ ******************************************************************************/
+
+/* ...initialize output port (structure must be zero-initialized) */
+int xf_output_port_init(xf_output_port_t *port, u32 size)
+{
+ /* ...initialize message queue */
+ xf_msg_queue_init(&port->queue);
+
+ /* ...set output buffer length */
+ port->length = size;
+
+ /* ...mark port is created */
+ port->flags = XF_OUTPUT_FLAG_CREATED;
+
+ TRACE(INIT, _b("output-port[%p] initialized"), port);
+
+ return 0;
+}
+
+/* ...route output port */
+int xf_output_port_route(xf_output_port_t *port, u32 id, u32 n, u32 length, u32 align)
+{
+ u32 core = XF_MSG_DST_CORE(id);
+ u32 shared = XF_MSG_SHARED(id);
+ xf_message_t *m;
+ u32 i;
+
+ /* ...allocate message pool for a port; extra message for control */
+ XF_CHK_API(xf_msg_pool_init(&port->pool, n + 1, core));
+
+ /* ...allocate required amount of buffers */
+ for (i = 1; i <= n; i++)
+ {
+ /* ...get message from pool (directly; bypass that "get" interface) */
+ m = xf_msg_pool_item(&port->pool, i);
+
+ /* ...wipe out message link pointer (debugging) */
+ m->next = NULL;
+
+ /* ...set message parameters */
+ m->id = id;
+ m->opcode = XF_FILL_THIS_BUFFER;
+ m->length = length;
+ m->buffer = xf_mem_alloc(length, align, core, shared);
+
+ /* ...if allocation failed, do a cleanup */
+ if (!m->buffer) goto error;
+
+ /* ...place message into output port */
+ xf_msg_enqueue(&port->queue, m);
+ }
+
+ /* ...setup flow-control message */
+ m = xf_output_port_control_msg(port);
+ m->id = id;
+ m->length = 0;
+ m->buffer = NULL;
+
+ /* ...wipe out message link pointer (debugging) */
+ m->next = NULL;
+
+ /* ...save port length */
+ port->length = length;
+
+ /* ...mark port is routed */
+ port->flags |= XF_OUTPUT_FLAG_ROUTED | XF_OUTPUT_FLAG_IDLE;
+
+ TRACE(ROUTE, _b("output-port[%p] routed: %x -> %x"), port, XF_MSG_DST(id), XF_MSG_SRC(id));
+
+ return 0;
+
+error:
+ /* ...allocation failed; do a cleanup */
+ while (--i)
+ {
+ m = xf_msg_pool_item(&port->pool, i);
+
+ /* ...free item */
+ xf_mem_free(m->buffer, length, core, shared);
+ }
+
+ /* ...destroy pool data */
+ xf_msg_pool_destroy(&port->pool, core);
+
+ return -ENOMEM;
+}
+
+/* ...start output port unrouting sequence */
+void xf_output_port_unroute_start(xf_output_port_t *port, xf_message_t *m)
+{
+ /* ...port must be routed */
+ BUG(!xf_output_port_routed(port), _x("invalid state: %x"), port->flags);
+
+ /* ...save message in the queue */
+ port->unroute = m;
+
+ /* ...put port unrouting flag */
+ port->flags |= XF_OUTPUT_FLAG_UNROUTING;
+}
+
+/* ...complete port unrouting sequence */
+void xf_output_port_unroute_done(xf_output_port_t *port)
+{
+ xf_message_t *m;
+
+ /* ...make sure we have an outstanding port unrouting sequence */
+ BUG(!xf_output_port_unrouting(port), _x("invalid state: %x"), port->flags);
+
+ /* ...retrieve enqueued control-flow message */
+ m = port->unroute, port->unroute = NULL;
+
+ /* ...destroy port buffers */
+ xf_output_port_unroute(port);
+
+ /* ...and pass response to the caller */
+ xf_response_ok(m);
+}
+
+/* ...unroute output port and destroy all memory buffers allocated */
+void xf_output_port_unroute(xf_output_port_t *port)
+{
+ xf_message_t *m = xf_output_port_control_msg(port);
+ u32 core = XF_MSG_DST_CORE(m->id);
+ u32 shared = XF_MSG_SHARED(m->id);
+ u32 n = port->pool.n - 1;
+ u32 i;
+
+ /* ...free all messages (we are running on "dst" core) */
+ for (i = 1; i <= n; i++)
+ {
+ /* ...directly obtain message item */
+ m = xf_msg_pool_item(&port->pool, i);
+
+ /* ...free message buffer (must exist) */
+ xf_mem_free(m->buffer, port->length, core, shared);
+ }
+
+ /* ...destroy pool data */
+ xf_msg_pool_destroy(&port->pool, core);
+
+ /* ...reset all flags */
+ port->flags = XF_OUTPUT_FLAG_CREATED;
+
+ /* ...reset message queue (it is empty again) */
+ xf_msg_queue_init(&port->queue);
+
+ TRACE(ROUTE, _b("output-port[%p] unrouted"), port);
+}
+
+/* ...put next message to the port */
+int xf_output_port_put(xf_output_port_t *port, xf_message_t *m)
+{
+ /* ...in case of port unrouting sequence the flag returned will always be 0 */
+ return xf_msg_enqueue(&port->queue, m);
+}
+
+/* ...retrieve next message from the port */
+void * xf_output_port_data(xf_output_port_t *port)
+{
+ xf_message_t *m = xf_msg_queue_head(&port->queue);
+
+ /* ...bail out if there is nothing enqueued */
+ if (m == NULL) return NULL;
+
+ /* ...it is not permitted to access port data when port is being unrouted */
+ BUG(xf_output_port_unrouting(port), _x("invalid transaction"));
+
+ /* ...make sure message length is valid */
+ BUG(m->length < port->length, _x("Insufficient buffer length: %u < %u"), m->length, port->length);
+
+ /* ...return access buffer pointer */
+ return m->buffer;
+}
+
+/* ...produce output message marking amount of bytes produced */
+int xf_output_port_produce(xf_output_port_t *port, u32 n)
+{
+ xf_message_t *m = xf_msg_dequeue(&port->queue);
+
+ /* ...message cannot be NULL */
+ BUG(m == NULL, _x("Invalid transaction"));
+
+ /* ...it is not permitted to invoke this when port is being unrouted (or flushed - tbd) */
+ BUG(xf_output_port_unrouting(port), _x("invalid transaction"));
+
+ /* ...complete message with specified amount of bytes produced */
+ xf_response_data(m, n);
+
+ /* ...clear port idle flag (technically, not needed for unrouted port) */
+ port->flags &= ~XF_OUTPUT_FLAG_IDLE;
+
+ /* ...return indication of pending message availability */
+ return (xf_msg_queue_head(&port->queue) != NULL);
+}
+
+/* ...flush output port */
+int xf_output_port_flush(xf_output_port_t *port, u32 opcode)
+{
+ xf_message_t *m;
+
+ /* ...if port is routed, we shall pass flush command to sink port */
+ if (xf_output_port_routed(port))
+ {
+ /* ...if port is idle, satisfy immediately */
+ if (port->flags & XF_OUTPUT_FLAG_IDLE) return 1;
+
+ /* ...start flushing sequence if not already started */
+ if ((port->flags & XF_OUTPUT_FLAG_FLUSHING) == 0)
+ {
+ /* ...put flushing flag */
+ port->flags ^= XF_OUTPUT_FLAG_FLUSHING;
+
+ /* ...get control message from associated pool */
+ m = xf_output_port_control_msg(port);
+
+ /* ...set flow-control operation */
+ m->opcode = opcode;
+
+ /* ...message is a command, but source and destination are swapped */
+ xf_response(m);
+ }
+
+ /* ...zero-result indicates the flushing is in progress */
+ return 0;
+ }
+ else
+ {
+ /* ...for non-routed port just complete all queued messages */
+ while ((m = xf_msg_dequeue(&port->queue)) != NULL)
+ {
+ /* ...pass generic zero-length "okay" response - tbd */
+ xf_response_ok(m);
+ }
+
+ /* ...non-zero result indicates the flushing is done */
+ return 1;
+ }
+}
+
+/* ...mark flushing sequence is completed */
+void xf_output_port_flush_done(xf_output_port_t *port)
+{
+ /* ...make sure flushing sequence is ongoing */
+ BUG((port->flags & XF_OUTPUT_FLAG_FLUSHING) == 0, _x("invalid state: %x"), port->flags);
+
+ /* ...clear flushing flag and set idle flag */
+ port->flags ^= XF_OUTPUT_FLAG_IDLE | XF_OUTPUT_FLAG_FLUSHING;
+
+ TRACE(OUTPUT, _b("port[%p] flush sequence completed"), port);
+}
+
+/* ...destroy output port */
+void xf_output_port_destroy(xf_output_port_t *port, u32 core)
+{
+ /* ...check if port is routed */
+ if (xf_output_port_routed(port))
+ {
+ /* ...port must be in idle state */
+ BUG(!xf_output_port_idle(port), _x("destroying non-idle port[%p]"), port);
+
+ /* ...unroute port */
+ xf_output_port_unroute(port);
+ }
+
+ /* ...reset port flags */
+ port->flags = 0;
+
+ TRACE(INIT, _b("output-port[%p] destroyed"), port);
+}
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-29 15:39:52 +0000