Skip to content

doc: annotate all ABI fields added/changed in 3.17 ABI #3392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgirdwood merged 1 commit into from
Sep 14, 2020
Merged

doc: annotate all ABI fields added/changed in 3.17 ABI #3392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/include/ipc/info.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ struct sof_ipc_fw_version {
uint8_t time[10];
uint8_t tag[6];
uint32_t abi_version;
/* used to check FW and ldc file compatibility, reproducible value */
/** used to check FW and ldc file compatibility, reproducible value (ABI3.17) */
uint32_t src_hash;

/* reserved for future use */
Expand Down Expand Up @@ -109,7 +109,7 @@ struct sof_ipc_window_elem {
struct sof_ipc_window {
struct sof_ipc_ext_data_hdr ext_hdr;
uint32_t num_windows;
struct sof_ipc_window_elem window[SOF_IPC_MAX_ELEMS];
struct sof_ipc_window_elem window[SOF_IPC_MAX_ELEMS]; /**< ABI3.17: Fixed size */
} __attribute__((packed));

/* extended data, compiler version */
Expand Down
2 changes: 1 addition & 1 deletion src/include/ipc/topology.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ struct sof_ipc_comp {
uint32_t pipeline_id;
uint32_t core;

/* extended data length, 0 if no extended data */
/** extended data length, 0 if no extended data (ABI3.17) */
uint32_t ext_data_length;
} __attribute__((packed));

Expand Down
8 changes: 4 additions & 4 deletions src/include/kernel/ext_manifest.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ enum ext_man_elem_type {
EXT_MAN_ELEM_WINDOW = SOF_IPC_EXT_WINDOW,
EXT_MAN_ELEM_CC_VERSION = SOF_IPC_EXT_CC_INFO,
EXT_MAN_ELEM_PROBE_INFO = SOF_IPC_EXT_PROBE_INFO,
EXT_MAN_ELEM_DBG_ABI = SOF_IPC_EXT_USER_ABI_INFO,
EXT_MAN_ELEM_CONFIG_DATA = 5,
EXT_MAN_ELEM_PLATFORM_CONFIG_DATA = 6,
EXT_MAN_ELEM_DBG_ABI = SOF_IPC_EXT_USER_ABI_INFO, /**< ABI3.17 */
EXT_MAN_ELEM_CONFIG_DATA = 5, /**< ABI3.17 */
EXT_MAN_ELEM_PLATFORM_CONFIG_DATA = 6, /**< ABI3.17 */
};

/* EXT_MAN_ELEM_CONFIG_DATA elements identificators */
Expand Down Expand Up @@ -100,7 +100,7 @@ struct ext_man_dbg_abi {
struct sof_ipc_user_abi_version dbg_abi;
} __packed;

/* EXT_MAN_ELEM_CONFIG_DATA elements */
/** EXT_MAN_ELEM_CONFIG_DATA elements (ABI3.17) */
struct ext_man_config_data {
struct ext_man_elem_header hdr;

Expand Down