SOF ABI Change Process¶
SOF ABI definitions¶
The SOF ABI consists of public structs used in host-FW communication defined in:
SOF ABI versioning is defined in firmware source code documentation FW Source kernel/abi.h
When a firmware change requires extending or modifying the public SOF ABI, the developer must go through the ABI change process as defined in this section. The developer must drive this process, contact the stakeholders, request reviews (and re-reviews when needed) and coordinate with the driver maintainers.
The main steps of the process are depicted in the following state diagram:
The pull requests are classified in GitHub using the following official ABI Change Tracker
When the ABI change is not backwards-compatible, Pull Requests on the kernel side shall include code that deals with older firmware and topology files. See Linux SOF drivers for kernel side documentation.