> ## Documentation Index
> Fetch the complete documentation index at: https://dragonwingdocs.qualcomm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# APM Module API

> This file contains APM module related commands and events structures definitions.

**Header:** `spf/api/apm/apm_module_api.h`

## Structures

### `apm_param_id_modules_list_t`

combination of sub-graph and container ID's.

**Members**

**num\_modules\_list** `uint32_t`

### `apm_modules_list_t`

**Members**

**sub\_graph\_id** `uint32_t`

**container\_id** `uint32_t`

**num\_modules** `uint32_t`

### `apm_module_cfg_t`

**Members**

**module\_id** `uint32_t`

**instance\_id** `uint32_t`

### `apm_param_id_module_prop_t`

**Members**

**num\_module\_prop\_cfg** `uint32_t`

### `apm_module_prop_cfg_t`

**Members**

**instance\_id** `uint32_t`

}

**num\_props** `uint32_t`

}

### `apm_module_prop_id_port_info_t`

**Members**

**max\_ip\_port** `uint32_t`

}

**max\_op\_port** `uint32_t`

}

### `apm_param_id_module_conn_t`

**Members**

**num\_connections** `uint32_t`

}

### `apm_module_conn_cfg_t`

**Members**

**src\_mod\_inst\_id** `uint32_t`

}

**src\_mod\_op\_port\_id** `uint32_t`

}

**dst\_mod\_inst\_id** `uint32_t`

}

**dst\_mod\_ip\_port\_id** `uint32_t`

}

### `apm_param_id_module_ctrl_link_cfg_t`

**Members**

**num\_ctrl\_link\_cfg** `uint32_t`

}

### `apm_module_ctrl_link_cfg_t`

**Members**

**peer\_1\_mod\_iid** `uint32_t`

}

**peer\_1\_mod\_ctrl\_port\_id** `uint32_t`

}

**peer\_2\_mod\_iid** `uint32_t`

}

**peer\_2\_mod\_ctrl\_port\_id** `uint32_t`

}

**num\_props** `uint32_t`

}

### `apm_module_ctrl_link_prop_id_intent_list_t`

**Members**

**num\_intents** `uint32_t`

}

**intent\_id\_list** `uint32_t`

}

## Type Definitions

### `apm_param_id_modules_list_t`

```cpp theme={null}
typedef struct apm_param_id_modules_list_t apm_param_id_modules_list_t
```

### `apm_modules_list_t`

```cpp theme={null}
typedef struct apm_modules_list_t apm_modules_list_t
```

### `apm_module_cfg_t`

```cpp theme={null}
typedef struct apm_module_cfg_t apm_module_cfg_t
```

### `apm_param_id_module_prop_t`

```cpp theme={null}
typedef struct apm_param_id_module_prop_t apm_param_id_module_prop_t
```

### `apm_module_prop_cfg_t`

```cpp theme={null}
typedef struct apm_module_prop_cfg_t apm_module_prop_cfg_t
```

### `apm_module_prop_id_port_info_t`

```cpp theme={null}
typedef struct apm_module_prop_id_port_info_t apm_module_prop_id_port_info_t
```

### `apm_param_id_module_conn_t`

```cpp theme={null}
typedef struct apm_param_id_module_conn_t apm_param_id_module_conn_t
```

### `apm_module_conn_cfg_t`

```cpp theme={null}
typedef struct apm_module_conn_cfg_t apm_module_conn_cfg_t
```

### `apm_param_id_module_ctrl_link_cfg_t`

```cpp theme={null}
typedef struct apm_param_id_module_ctrl_link_cfg_t apm_param_id_module_ctrl_link_cfg_t
```

### `apm_module_ctrl_link_cfg_t`

```cpp theme={null}
typedef struct apm_module_ctrl_link_cfg_t apm_module_ctrl_link_cfg_t
```

### `apm_module_ctrl_link_prop_id_intent_list_t`

```cpp theme={null}
typedef struct apm_module_ctrl_link_prop_id_intent_list_t apm_module_ctrl_link_prop_id_intent_list_t
```

## Macros

### `APM_PARAM_ID_MODULES_LIST`

```c theme={null}
#define APM_PARAM_ID_MODULES_LIST 0x08001002
```

### `APM_PARAM_ID_MODULE_PROP`

```c theme={null}
#define APM_PARAM_ID_MODULE_PROP 0x08001003
```

### `APM_MODULE_PROP_ID_PORT_INFO`

```c theme={null}
#define APM_MODULE_PROP_ID_PORT_INFO 0x08001015
```

### `APM_PARAM_ID_MODULE_CONN`

```c theme={null}
#define APM_PARAM_ID_MODULE_CONN 0x08001004
```

### `APM_PARAM_ID_MODULE_CTRL_LINK_CFG`

```c theme={null}
#define APM_PARAM_ID_MODULE_CTRL_LINK_CFG 0x08001061
```

### `APM_MODULE_PROP_ID_CTRL_LINK_INTENT_LIST`

```c theme={null}
#define APM_MODULE_PROP_ID_CTRL_LINK_INTENT_LIST 0x08001062
```
