Skip to content

Commit

Permalink
ipc: update documentation to include extended data
Browse files Browse the repository at this point in the history 
Update the IPC protocol documentation to include the extended data.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
Signed-off-by: Keyon Jie <yang.jie@linux.intel.com>
  • Loading branch information
@marc-hb @keyonjie
marc-hb authored and keyonjie committed Jul 30, 2020
1 parent 11a4a22 commit fa32944
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/include/ipc/header.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,21 +74,24 @@
* 0 1 2 3
* 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Size |
* | Size (Total size including Extended Data) |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Command (G=TPLG_MSG, C=COMP_NEW) |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Component Id |
* | Component ID |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Type |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Pipeline ID |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Core |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Reserved |
* | Extended Data size |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Type specific payload, size varies based on Component ID. |
* | Ends at: Total size - Extended Data size |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | (Type specific payload, size varies based on Component ID) |
* | extended data, including e.g. UUID |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
* \see sof_ipc_comp
Expand Down

0 comments on commit fa32944

Please sign in to comment.