> ## Documentation Index > Fetch the complete documentation index at: https://dragonwingdocs-staging.qualcomm.com/llms.txt > Use this file to discover all available pages before exploring further. # Shared Memory Pull Push Mode API > This file contains CAPI pull mode and push mode module APIs. **Header:** `spf/api/modules/sh_mem_pull_push_mode_api.h` ## Structures ### `event_cfg_sh_mem_pull_push_mode_watermark_level_t` Payload of the EVENT\_ID\_SH\_MEM\_PULL\_PUSH\_MODE\_WATERMARK event. **Members** Watermark level in the circular buffer, in bytes. ### `event_cfg_sh_mem_pull_push_mode_watermark_t` Immediately following this structure are watermark level structures of type sh\_mem\_pull\_push\_mode\_watermark\_level\_t. **Members** Number of watermark levels in the array. ### `event_sh_mem_pull_push_mode_watermark_level_t` Payload of the EVENT\_ID\_SH\_MEM\_PULL\_PUSH\_MODE\_WATERMARK event. **Members** Watermark level in the circular buffer in bytes. ### `event_sh_mem_push_mode_eos_marker_t` Payload of the event EVENT\_ID\_SH\_MEM\_PUSH\_MODE\_EOS\_MARKER, contains the timestamp of the EOS marker. **Members** Index of the sample in the circular buffer at which EOS marker is set. Lower 32 bits of Timestamp at which push mode module received EOS. Higher 32 bits of Timestamp at which push mode module received EOS. ### `sh_mem_pull_push_mode_position_buffer_t` Common structure definition for the shared circular buffer between the SPF and clients. **Members** Counter used to handle interprocessor synchronization issues associated with reading write\_index, wall\_clock\_us\_lsw, and wall\_clock\_us\_msw. Index (in bytes) to the buffer where the SPF is writing (Push mode) or reading (Pull mode). Upper 32 bits of the 64-bit timestamp, in microseconds. Upper 32 bits of the 64-bit timestamp, in microseconds. ### `sh_mem_pull_push_mode_cfg_t` Payload of the PARAM\_ID\_SH\_MEM\_PULL\_PUSH\_MODE\_CFG parameter. **Members** Lower 32 bits of the address of the shared circular buffer. Upper 32 bits of the address of the shared circular buffer. Number of bytes in the shared circular buffer. Unique identifier for the shared memory address of shared circular buffer. Lower 32 bits of the address of the shared position buffer. Upper 32 bits of the address of the shared position buffer. Unique identifier for the shared memory address of position buffer. ### `sh_mem_push_mode_header_cfg_t` **Members** Bit field to enable/disable additional information to be sent along with the audio data in the buffer. ### `sh_mem_push_mode_batch_header_t` Batch header structure that appears at the start of each batch in shared memory. **Members** Sync word for validation. ### `sh_mem_push_mode_param_header_t` Parameter header type information structure (PARAM\_ID + SIZE). **Members** Parameter ID identifying the type of data that follows. Actual size of the payload in bytes. Size of the padded bytes in param payload, to make next header SYNC\_WORD 4-byte aligned. ### `sh_mem_push_mode_timestamp_payload_t` Timestamp parameter payload structure. **Members** Lower 32 bits of the 64-bit timestamp, in microseconds. Upper 32 bits of the 64-bit timestamp, in microseconds. ## Type Definitions ### `event_cfg_sh_mem_pull_push_mode_watermark_level_t` ```cpp theme={null} typedef struct event_cfg_sh_mem_pull_push_mode_watermark_level_t event_cfg_sh_mem_pull_push_mode_watermark_level_t ``` ### `event_cfg_sh_mem_pull_push_mode_watermark_t` ```cpp theme={null} typedef struct event_cfg_sh_mem_pull_push_mode_watermark_t event_cfg_sh_mem_pull_push_mode_watermark_t ``` ### `event_sh_mem_pull_push_mode_watermark_level_t` ```cpp theme={null} typedef struct event_sh_mem_pull_push_mode_watermark_level_t event_sh_mem_pull_push_mode_watermark_level_t ``` ### `event_sh_mem_push_mode_eos_marker_t` ```cpp theme={null} typedef struct event_sh_mem_push_mode_eos_marker_t event_sh_mem_push_mode_eos_marker_t ``` ### `sh_mem_pull_push_mode_position_buffer_t` ```cpp theme={null} typedef struct sh_mem_pull_push_mode_position_buffer_t sh_mem_pull_push_mode_position_buffer_t ``` ### `sh_mem_pull_push_mode_cfg_t` ```cpp theme={null} typedef struct sh_mem_pull_push_mode_cfg_t sh_mem_pull_push_mode_cfg_t ``` ### `sh_mem_push_mode_header_cfg_t` ```cpp theme={null} typedef struct sh_mem_push_mode_header_cfg_t sh_mem_push_mode_header_cfg_t ``` ### `sh_mem_push_mode_batch_header_t` ```cpp theme={null} typedef struct sh_mem_push_mode_batch_header_t sh_mem_push_mode_batch_header_t ``` ### `sh_mem_push_mode_param_header_t` ```cpp theme={null} typedef struct sh_mem_push_mode_param_header_t sh_mem_push_mode_param_header_t ``` ### `sh_mem_push_mode_timestamp_payload_t` ```cpp theme={null} typedef struct sh_mem_push_mode_timestamp_payload_t sh_mem_push_mode_timestamp_payload_t ``` ## Macros ### `SH_MEM_PULL_MODE_MAX_INPUT_PORTS` Enumerates the maximum number of input ports for Pull mode. ```c theme={null} #define SH_MEM_PULL_MODE_MAX_INPUT_PORTS 0x0 ``` ### `SH_MEM_PULL_MODE_MAX_OUTPUT_PORTS` Enumerates the maximum number of output ports for Pull mode. ```c theme={null} #define SH_MEM_PULL_MODE_MAX_OUTPUT_PORTS 0x1 ``` ### `SH_MEM_PULL_MODE_STACK_SIZE_REQUIREMENT` Enumerates the stack size of the module for Pull mode. ```c theme={null} #define SH_MEM_PULL_MODE_STACK_SIZE_REQUIREMENT 4096 ``` ### `SH_MEM_PUSH_MODE_MAX_INPUT_PORTS` Enumerates the maximum number of input ports for Push mode. ```c theme={null} #define SH_MEM_PUSH_MODE_MAX_INPUT_PORTS 0x1 ``` ### `SH_MEM_PUSH_MODE_MAX_OUTPUT_PORTS` Enumerates the maximum number of output ports for Push mode. ```c theme={null} #define SH_MEM_PUSH_MODE_MAX_OUTPUT_PORTS 0x0 ``` ### `SH_MEM_PUSH_MODE_STACK_SIZE_REQUIREMENT` Enumerates the stack size of the module for Push mode. ```c theme={null} #define SH_MEM_PUSH_MODE_STACK_SIZE_REQUIREMENT 4096 ``` ### `EVENT_ID_SH_MEM_PULL_PUSH_MODE_WATERMARK` Identifier of the watermark event from the MODULE\_ID\_SH\_MEM\_PULL\_MODE and MODULE\_ID\_SH\_MEM\_PUSH\_MODE modules to the client. ```c theme={null} #define EVENT_ID_SH_MEM_PULL_PUSH_MODE_WATERMARK 0x0800101C ``` ### `EVENT_ID_SH_MEM_PUSH_MODE_EOS_MARKER` Identifier of the EOS marker event from the MODULE\_ID\_SH\_MEM\_PUSH\_MODE modules to the client. ```c theme={null} #define EVENT_ID_SH_MEM_PUSH_MODE_EOS_MARKER 0x080013DD ``` ### `PARAM_ID_SH_MEM_PULL_PUSH_MODE_CFG` Identifier of the parameter that configures shared memory information for Pull mode and Push mode. ```c theme={null} #define PARAM_ID_SH_MEM_PULL_PUSH_MODE_CFG 0x0800100A ``` ### `PARAM_ID_SH_MEM_PUSH_MODE_HEADER_CFG` Identifier of the parameter that configures header information for Push mode. ```c theme={null} #define PARAM_ID_SH_MEM_PUSH_MODE_HEADER_CFG 0x08001BDF ``` ### `SH_MEM_PUSH_MODE_HEADER_SYNC_WORD` Sync word for header validation. ```c theme={null} #define SH_MEM_PUSH_MODE_HEADER_SYNC_WORD 0x5350464D ``` ### `PARAM_ID_HEADER_TYPE_UTC_TIMESTAMP` Header Parameter ID for UTC timestamp. ```c theme={null} #define PARAM_ID_HEADER_TYPE_UTC_TIMESTAMP 0x08001BE0 ``` ### `PARAM_ID_HEADER_TYPE_PCM_DATA` Header Parameter ID for PCM data. ```c theme={null} #define PARAM_ID_HEADER_TYPE_PCM_DATA 0x08001BE1 ``` ### `MODULE_ID_SH_MEM_PULL_MODE` Identifier for the Shared Memory Pull mode module, which writes data to the SPF from the host through a shared circular buffer. ```c theme={null} #define MODULE_ID_SH_MEM_PULL_MODE 0x07001006 ``` ### `MODULE_ID_SH_MEM_PUSH_MODE` Identifier for the shared memory Push mode module, which reads data from the SPF to the host through a shared circular buffer. ```c theme={null} #define MODULE_ID_SH_MEM_PUSH_MODE 0x07001007 ```