> ## 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.

# RX Haptics Shared Memory API

**Header:** `spf/api/modules/rx_haptics_shmem_api.h`

## Structures

### `rx_haptics_shmem_config`

**Members**

<ParamField path="config_type" type="rx_haptics_shmem_config_type_t" />

<ParamField path="pid" type="uint32_t" />

<ParamField path="config_addr_offset" type="uint32_t" />

<ParamField path="config_size" type="uint32_t" />

<ParamField path="err_code" type="uint32_t" />

### `rx_haptics_shmem_payload_hdr`

**Members**

<ParamField path="num_config" type="uint32_t" />

<ParamField path="shmem_config_rsp_mode" type="rx_haptics_shmem_rsp_type_t" />

<ParamField path="shmem_msg_mode" type="rx_haptics_shmem_msg_mode_t" />

<ParamField path="shmem_property_flag" type="uint32_t" />

### `rx_haptics_shmem_ipc_protocol`

**Members**

<ParamField path="version" type="uint32_t" />

<ParamField path="payload_header_size" type="uint32_t" />

## Type Definitions

### `rx_haptics_shmem_config_type_t`

```cpp theme={null}
typedef enum rx_haptics_shmem_config_type rx_haptics_shmem_config_type_t
```

### `rx_haptics_shmem_msg_mode_t`

```cpp theme={null}
typedef enum rx_haptics_shmem_msg_mode rx_haptics_shmem_msg_mode_t
```

### `rx_haptics_shmem_rsp_type_t`

```cpp theme={null}
typedef enum rx_haptics_shmem_rsp_type rx_haptics_shmem_rsp_type_t
```

### `rx_haptics_shmem_config_t`

```cpp theme={null}
typedef struct rx_haptics_shmem_config rx_haptics_shmem_config_t
```

### `rx_haptics_shmem_payload_hdr_t`

```cpp theme={null}
typedef struct rx_haptics_shmem_payload_hdr rx_haptics_shmem_payload_hdr_t
```

### `rx_haptics_shmem_ipc_protocol_t`

```cpp theme={null}
typedef struct rx_haptics_shmem_ipc_protocol rx_haptics_shmem_ipc_protocol_t
```

## Enumerations

### `rx_haptics_shmem_config_type`

#### Values

| Name      | Value | Description |
| --------- | ----- | ----------- |
| `SET_CFG` | = 0   |             |
| `GET_CFG` | = 1   |             |

### `rx_haptics_shmem_msg_mode`

#### Values

| Name            | Value | Description |
| --------------- | ----- | ----------- |
| `POLLING_BASED` | = 0   |             |
| `TRIGGER_BASED` | = 1   |             |

### `rx_haptics_shmem_rsp_type`

#### Values

| Name                | Value | Description |
| ------------------- | ----- | ----------- |
| `RSP_POLLING`       | = 0   |             |
| `RSP_EVENT_TRIGGER` | = 1   |             |