Write Shared Memory Endpoint API - Qualcomm Dragonwing Documentation

Header: spf/api/modules/wr_sh_mem_ep_api.h

Structures

`data_cmd_wr_sh_mem_ep_data_buffer_t`

Members

uint32_t

Lower 32 bits of the address of the buffer containing the data.

uint32_t

Upper 32 bits of the address of the buffer containing the data.

uint32_t

Unique identifier for the shared memory address.

uint32_t

Number of valid bytes available in the buffer for processing.

uint32_t

Lower 32 bits of the 64-bit timestamp in microseconds of the first buffer sample.

uint32_t

Upper 32 bits of the 64-bit timestamp in microseconds of the first buffer sample.

uint32_t

Bitfield of flags.

`data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t`

Members

uint32_t

Lower 32 bits of the address of the buffer being returned.

uint32_t

Upper 32 bits of the address of the buffer being returned.

uint32_t

Unique identifier for the shared memory address.

uint32_t

Status message (error code) that indicates whether the referenced buffer has been successfully consumed.

`data_cmd_wr_sh_mem_ep_data_buffer_v2_t`

Members

uint32_t

Lower 32 bits of the address of the buffer containing the data.

uint32_t

Upper 32 bits of the address of the buffer containing the data.

uint32_t

Unique identifier for the shared memory corresponding to data buffer address.

uint32_t

Number of valid bytes available in the buffer for processing.

uint32_t

Lower 32 bits of the 64-bit timestamp in microseconds of the first data buffer sample.

uint32_t

Upper 32 bits of the 64-bit timestamp in microseconds of the first data buffer sample.

uint32_t

Bitfield of flags.

uint32_t

Lower 32 bits of the address of the buffer containing the metadata.

uint32_t

Upper 32 bits of the address of the buffer containing the metadata.

uint32_t

Unique identifier for the shared memory corresponding to metadata buffer address.

uint32_t

Number of valid bytes available in the metadata buffer for processing.

`data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t`

Members

uint32_t

Lower 32 bits of the address of the data buffer being returned.

uint32_t

Upper 32 bits of the address of the data buffer being returned.

uint32_t

Unique identifier for the shared memory corresponding to data buffer address.

uint32_t

Status message (error code) that indicates whether the referenced data buffer has been successfully consumed.

uint32_t

Lower 32 bits of the address of the metadata buffer being returned.

uint32_t

Upper 32 bits of the address of the metadata buffer being returned.

uint32_t

Unique identifier for the shared memory corresponding to metadata buffer address.

uint32_t

Status message (error code) that indicates whether the referenced metadata buffer has been successfully consumed.

`data_cmd_wr_sh_mem_ep_eos_t`

Members

uint32_t

Policy used to raise DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED WR_SH_MEM_EP_EOS_POLICY_LAST WR_SH_MEM_EP_EOS_POLICY_EACH.

`data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t`

Members

uint32_t

module instance id from which the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED is being raised Invalid (0) when dropped.

uint32_t

Render status - 1 - Rendered.

Type Definitions

`data_cmd_wr_sh_mem_ep_data_buffer_t`

Structure for DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER.

typedef struct data_cmd_wr_sh_mem_ep_data_buffer_t data_cmd_wr_sh_mem_ep_data_buffer_t

`data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t`

typedef struct data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t

`data_cmd_wr_sh_mem_ep_data_buffer_v2_t`

Structure for DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER_V2.

typedef struct data_cmd_wr_sh_mem_ep_data_buffer_v2_t data_cmd_wr_sh_mem_ep_data_buffer_v2_t

`data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t`

typedef struct data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t

`data_cmd_wr_sh_mem_ep_eos_t`

Structure for DATA_CMD_WR_SH_MEM_EP_EOS.

typedef struct data_cmd_wr_sh_mem_ep_eos_t data_cmd_wr_sh_mem_ep_eos_t

`data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t`

Structure for DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED.

typedef struct data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t

Macros

`DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER`

#define DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER 0x04001000

`WR_SH_MEM_EP_BIT_MASK_TIMESTAMP_VALID_FLAG`

Definition of a timestamp valid flag bitmask.

#define WR_SH_MEM_EP_BIT_MASK_TIMESTAMP_VALID_FLAG AR_NON_GUID(0x80000000)

`WR_SH_MEM_EP_SHIFT_TIMESTAMP_VALID_FLAG`

Definition of a timestamp valid flag shift value.

#define WR_SH_MEM_EP_SHIFT_TIMESTAMP_VALID_FLAG 31

`WR_SH_MEM_EP_BIT_MASK_LAST_BUFFER_FLAG`

Definition of the last buffer flag bitmask.

#define WR_SH_MEM_EP_BIT_MASK_LAST_BUFFER_FLAG AR_NON_GUID(0x40000000)

`WR_SH_MEM_EP_SHIFT_LAST_BUFFER_FLAG`

Definition of the last buffer flag shift value.

#define WR_SH_MEM_EP_SHIFT_LAST_BUFFER_FLAG 30

`WR_SH_MEM_EP_BIT_MASK_TS_CONTINUE_FLAG`

Definition of the shift value for the timestamp continue flag.

#define WR_SH_MEM_EP_BIT_MASK_TS_CONTINUE_FLAG AR_NON_GUID(0x20000000)

`WR_SH_MEM_EP_SHIFT_TS_CONTINUE_FLAG`

Definition of the shift value for the timestamp continue flag.

#define WR_SH_MEM_EP_SHIFT_TS_CONTINUE_FLAG 29

`WR_SH_MEM_EP_BIT_MASK_EOF_FLAG`

Definition of an End of Frame (EOF) flag bitmask.

#define WR_SH_MEM_EP_BIT_MASK_EOF_FLAG AR_NON_GUID(0x00000010)

`WR_SH_MEM_EP_SHIFT_EOF_FLAG`

Definition of an EOF flag shift value.

#define WR_SH_MEM_EP_SHIFT_EOF_FLAG 4

`DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE`

Indicates that the referenced buffer has been fully consumed and is again available to the client.

#define DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE 0x05001000

`DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER_V2`

Data command to write a buffer and associated metadata to the shared memory end point module.

#define DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER_V2 0x0400100A

`DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE_V2`

Indicates that the referenced write buffer has been fully consumed and is again available to the client.

#define DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE_V2 0x05001004

`DATA_CMD_WR_SH_MEM_EP_MEDIA_FORMAT`

Indicates an update to the media format, which applies to future buffers written to this stream.

#define DATA_CMD_WR_SH_MEM_EP_MEDIA_FORMAT 0x04001001

`DATA_CMD_WR_SH_MEM_EP_EOS`

Communicates an EoS marker, which indicates that the last buffer in a stream was delivered.

#define DATA_CMD_WR_SH_MEM_EP_EOS 0x04001002

`WR_SH_MEM_EP_EOS_POLICY_LAST`

EoS policy according to which last of the final end point raises the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED OR the last container which drops/renders the EoS raises the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED event.

#define WR_SH_MEM_EP_EOS_POLICY_LAST 1

`WR_SH_MEM_EP_EOS_POLICY_EACH`

EoS policy according to which each of the final EP raises the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED OR the each container which drop the EoS raises the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED event.

#define WR_SH_MEM_EP_EOS_POLICY_EACH 2

`DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED`

Indicates that DATA_CMD_WR_SH_MEM_EP_EOS has been received by the final end-point.

#define DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED 0x05001001

`WR_SH_MEM_EP_EOS_RENDER_STATUS_RENDERED`

Render status of EoS, where EoS message is rendered on final end device.

#define WR_SH_MEM_EP_EOS_RENDER_STATUS_RENDERED 1

`WR_SH_MEM_EP_EOS_RENDER_STATUS_DROPPED`

Render status of EoS, where EoS message is dropped before it reached the final end device.

#define WR_SH_MEM_EP_EOS_RENDER_STATUS_DROPPED 2

`PORT_ID_WR_SHARED_MEM_EP_OUTPUT`

Output port ID of the Write Shared Memory EP.

#define PORT_ID_WR_SHARED_MEM_EP_OUTPUT 0x1

`PORT_ID_WR_SHARED_MEM_EP_INPUT`

Input port ID of the Write Shared Memory EP This Port is connected only in OFFLOAD(MDF) use-cases.

#define PORT_ID_WR_SHARED_MEM_EP_INPUT 0x2

`MODULE_ID_WR_SHARED_MEM_EP`

ID of the Write Shared Memory End-Point Module.

#define MODULE_ID_WR_SHARED_MEM_EP 0x07001000

​Structures

​data_cmd_wr_sh_mem_ep_data_buffer_t

​data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t

​data_cmd_wr_sh_mem_ep_data_buffer_v2_t

​data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t

​data_cmd_wr_sh_mem_ep_eos_t

​data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t

​Type Definitions

​data_cmd_wr_sh_mem_ep_data_buffer_t

​data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t

​data_cmd_wr_sh_mem_ep_data_buffer_v2_t

​data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t

​data_cmd_wr_sh_mem_ep_eos_t

​data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t

​Macros

​DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER

​WR_SH_MEM_EP_BIT_MASK_TIMESTAMP_VALID_FLAG

​WR_SH_MEM_EP_SHIFT_TIMESTAMP_VALID_FLAG

​WR_SH_MEM_EP_BIT_MASK_LAST_BUFFER_FLAG

​WR_SH_MEM_EP_SHIFT_LAST_BUFFER_FLAG

​WR_SH_MEM_EP_BIT_MASK_TS_CONTINUE_FLAG

​WR_SH_MEM_EP_SHIFT_TS_CONTINUE_FLAG

​WR_SH_MEM_EP_BIT_MASK_EOF_FLAG

​WR_SH_MEM_EP_SHIFT_EOF_FLAG

​DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE

​DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER_V2

​DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE_V2

​DATA_CMD_WR_SH_MEM_EP_MEDIA_FORMAT

​DATA_CMD_WR_SH_MEM_EP_EOS

​WR_SH_MEM_EP_EOS_POLICY_LAST

​WR_SH_MEM_EP_EOS_POLICY_EACH

​DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED

​WR_SH_MEM_EP_EOS_RENDER_STATUS_RENDERED

​WR_SH_MEM_EP_EOS_RENDER_STATUS_DROPPED

​PORT_ID_WR_SHARED_MEM_EP_OUTPUT

​PORT_ID_WR_SHARED_MEM_EP_INPUT

​MODULE_ID_WR_SHARED_MEM_EP

Structures

`data_cmd_wr_sh_mem_ep_data_buffer_t`

`data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t`

`data_cmd_wr_sh_mem_ep_data_buffer_v2_t`

`data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t`

`data_cmd_wr_sh_mem_ep_eos_t`

`data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t`

Type Definitions

`data_cmd_wr_sh_mem_ep_data_buffer_t`

`data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t`

`data_cmd_wr_sh_mem_ep_data_buffer_v2_t`

`data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t`

`data_cmd_wr_sh_mem_ep_eos_t`

`data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t`

Macros

`DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER`

`WR_SH_MEM_EP_BIT_MASK_TIMESTAMP_VALID_FLAG`

`WR_SH_MEM_EP_SHIFT_TIMESTAMP_VALID_FLAG`

`WR_SH_MEM_EP_BIT_MASK_LAST_BUFFER_FLAG`

`WR_SH_MEM_EP_SHIFT_LAST_BUFFER_FLAG`

`WR_SH_MEM_EP_BIT_MASK_TS_CONTINUE_FLAG`

`WR_SH_MEM_EP_SHIFT_TS_CONTINUE_FLAG`

`WR_SH_MEM_EP_BIT_MASK_EOF_FLAG`

`WR_SH_MEM_EP_SHIFT_EOF_FLAG`

`DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE`

`DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER_V2`

`DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE_V2`

`DATA_CMD_WR_SH_MEM_EP_MEDIA_FORMAT`

`DATA_CMD_WR_SH_MEM_EP_EOS`

`WR_SH_MEM_EP_EOS_POLICY_LAST`

`WR_SH_MEM_EP_EOS_POLICY_EACH`

`DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED`

`WR_SH_MEM_EP_EOS_RENDER_STATUS_RENDERED`

`WR_SH_MEM_EP_EOS_RENDER_STATUS_DROPPED`

`PORT_ID_WR_SHARED_MEM_EP_OUTPUT`

`PORT_ID_WR_SHARED_MEM_EP_INPUT`

`MODULE_ID_WR_SHARED_MEM_EP`