Skip to content

Commit

Permalink
ASoC: SOF: uapi: header: Update sof_abi_hdr doc for IPC4 use
Browse files Browse the repository at this point in the history
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.

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
Reviewed-by: Bard Liao <yung-chuan.liao@linux.intel.com>
Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Reviewed-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
Reviewed-by: Jaska Uimonen <jaska.uimonen@linux.intel.com>
Reviewed-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
Link: https://lore.kernel.org/r/20230313110344.16644-5-peter.ujfalusi@linux.intel.com
Signed-off-by: Mark Brown <broonie@kernel.org>
  • Loading branch information
Peter Ujfalusi authored and Mark Brown committed Mar 13, 2023
1 parent 2e4ef6f commit ea4a4e8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
2 changes: 2 additions & 0 deletions include/uapi/sound/sof/abi.h
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,7 @@

/* SOF ABI magic number "SOF\0". */
#define SOF_ABI_MAGIC 0x00464F53
/* SOF IPC4 ABI magic number "SOF4". */
#define SOF_IPC4_ABI_MAGIC 0x34464F53

#endif
11 changes: 8 additions & 3 deletions include/uapi/sound/sof/header.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,15 @@

/**
* struct sof_abi_hdr - Header for all non IPC ABI data.
* @magic: Magic number for validation: 0x00464F53 ('S', 'O', 'F', '\0')
* @type: Component specific type
* @magic: Magic number for validation
* for IPC3 data: 0x00464F53 ('S', 'O', 'F', '\0')
* for IPC4 data: 0x34464F53 ('S', 'O', 'F', '4')
* @type: module specific parameter
* for IPC3: Component specific type
* for IPC4: parameter ID (param_id) of the data
* @size: The size in bytes of the data, excluding this struct
* @abi: SOF ABI version
* @abi: SOF ABI version. The version is valid in scope of the 'magic', IPC3 and
* IPC4 ABI version numbers have no relationship.
* @reserved: Reserved for future use
* @data: Component data - opaque to core
*
Expand Down

0 comments on commit ea4a4e8

Please sign in to comment.