abi: user: make it obvious how to use ABI header from userspace.

Add more comments describing usage of header from userspace.

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
This commit is contained in:
Liam Girdwood 2019-06-04 13:46:06 +01:00 committed by Liam Girdwood
parent 1782676acf
commit f0eedcbab7
1 changed files with 4 additions and 1 deletions

View File

@ -20,7 +20,10 @@
* \brief Header for all non IPC ABI data.
*
* Identifies data type, size and ABI.
* Used by any bespoke component data structures or binary blobs.
* Data header used for all component data structures and binary blobs sent to
* firmware as runtime data. This data is typically sent by userspace
* applications and tunnelled through any OS kernel (via binary kcontrol on
* Linux) to the firmware.
*/
struct sof_abi_hdr {
uint32_t magic; /**< 'S', 'O', 'F', '\0' */