History

ASoC: SOF: uapi: header: Update sof_abi_hdr doc for IPC4 use

With IPC4 the sof_abit_hdr is only used between user space (and in topology) and kernel. The same abi header is used with small differencies like different magic number and the type field have slightly different name, but similar function in IPC4 (param_id). Update the kernel documentation to highlight the differences.

Peter Ujfalusi committed 3 years ago

Commit ea4a4e81 parent 2e4ef6f2 files · +10 −3Browse files

Showing the changes to include/uapi (2 of 2 files). Show all

Unified · Split

2 files
  1. include/uapi/sound/sof/abi.h +2 −0
  2. include/uapi/sound/sof/header.h +8 −3
include/uapi/sound/sof/abi.h+2−0
@@ -60,5 +60,7 @@ · 59 unmodified lines
6060
6161 /* SOF ABI magic number "SOF\0". */
6262 #define SOF_ABI_MAGIC 0x00464F53
63+/* SOF IPC4 ABI magic number "SOF4". */
64+#define SOF_IPC4_ABI_MAGIC 0x34464F53
6365
6466 #endif
include/uapi/sound/sof/header.h+8−3
@@ -13,10 +13,15 @@ · 12 unmodified lines
1313
1414 /**
1515 * struct sof_abi_hdr - Header for all non IPC ABI data.
16− * @magic: Magic number for validation: 0x00464F53 ('S', 'O', 'F', '\0')
17− * @type: Component specific type
16+ * @magic: Magic number for validation
17+ * for IPC3 data: 0x00464F53 ('S', 'O', 'F', '\0')
18+ * for IPC4 data: 0x34464F53 ('S', 'O', 'F', '4')
19+ * @type: module specific parameter
20+ * for IPC3: Component specific type
21+ * for IPC4: parameter ID (param_id) of the data
1822 * @size: The size in bytes of the data, excluding this struct
19− * @abi: SOF ABI version
23+ * @abi: SOF ABI version. The version is valid in scope of the 'magic', IPC3 and
24+ * IPC4 ABI version numbers have no relationship.
2025 * @reserved: Reserved for future use
2126 * @data: Component data - opaque to core
2227 *

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t