split lib/dma.h and start namespacing with DMA_ #9719
Conversation
kv2019i
requested review from
lyakh,
iuliana-prodan,
dbaluta,
abonislawski,
bhiregoudar,
sunilkumardommati,
lgirdwood,
plbossart,
mmaka1 and
lbetlej
as code owners
|
@lyakh wrote:
Agreed, this is does look weird and I expect I'll need more tree wide big single patch for other parts of dma.h. OTOH, there is some logic to it as majority (but not all) of DMA usage is in the host/dai code and this code is also branched in calling code (e.g. there is dai-zephyr.c and dai-legacy.c). So there is cleanup work needed at multiple layers I'm afraid. |
kv2019i
changed the title
|
Actually, while replying to Guennadi in previous comment I realize the split in call sites is quite extensive. We have ifefs in DAI code, chain-dma is native driver only, probe has ifdefs for native drivers, and so forth. So let me try again with the option to add a namespace only for zephyr/lib/dma.h. This is a bit strange, but if works a) much less code churn needed, and b) original goal to clarify the code (what calls are SOF and what are Zephyr) would still be met. To be continued... |
Simplify the stub DMA driver in posix builds. As the posix platform is built on the Zephyr posix support, there's no need to support builds with XTOS DMA driver interface. Drop the XTOS DMA driver interface support and default to native Zephyr DMA interface. A minimal dma_info description needs to be kept as this is (still) used in SOF dma_get() to choose the right DMA instance to use. Signed-off-by: Kai Vehmanen <[email protected]>
kv2019i
force-pushed
the
202412-dma-namespacing-part1
branch
from
a29c239 to
a74317f
Compare
kv2019i
changed the title
|
New version pushed:
The main idea is to push ugly compatibility code to layers that will be removed later (with Zephyr transition) and keep the "longterm code" clean. E.g. now it's easy to see in src/audio/host-zephyr.c that SOF_DMA_DEV_HOST is a SOF definition while DMA_ATTR_BUFFER_ADDRESS_ALIGNMENT is coming from Zephyr dma.h. |
kv2019i
force-pushed
the
202412-dma-namespacing-part1
branch
from
a74317f to
b2eb734
Compare
|
New version:
|
zephyr/include/sof/lib/dma.h
Outdated
|
|
||
| int (*probe)(struct dma *dma); | ||
| int (*remove)(struct dma *dma); | ||
| struct dma_chan_data { |
There was a problem hiding this comment.
not a reason for a new revision, but if you do end up doing another update - would it be possible to keep this structure at the same place as now to reduce the diff?
There was a problem hiding this comment.
@lyakh Ack, fixed in new revision.
posix/include/sof/lib/dma.h
Outdated
| #define SOF_DMA_DIR_LMEM_TO_HMEM DMA_DIR_LMEM_TO_HMEM | ||
| #define SOF_DMA_DIR_MEM_TO_DEV DMA_DIR_MEM_TO_DEV | ||
| #define SOF_DMA_DIR_DEV_TO_MEM DMA_DIR_DEV_TO_MEM | ||
| #define SOF_DMA_DIR_DEV_TO_DEV DMA_DIR_DEV_TO_DEV |
There was a problem hiding this comment.
ok, maybe the compiler doesn't care, but wouldn't it be easier for the humans to have these under right-hand definitions just below? More cases below
There was a problem hiding this comment.
@lyakh Hmm, ok, let me make a rare concession for the humans among us and change the order. Addressed in the updated version.
There was a problem hiding this comment.
Oops, sorry, I made the changes to xtos/lib/dma.h. Let me make the same to posix/lib/dma.h as well. Will make a new update in a minute.
Move parts of the dma.h interface only needed by XTOS drivers to a separate dma-legacy.h file. Use of non-native drivers is a transitory tool and used by a subset of targets. To make the code easier to read and maintain, the main dma.h should only require definitions needed when building SOF Zephyr with native Zephyr drivers (CONFIG_ZEPHYR_NATIVE_DRIVERS). This is especially important for DMA as there is lot of similarly named definitions and interfaces related to DMA in Zephyr and SOF. Signed-off-by: Kai Vehmanen <[email protected]>
Add a namespace prefix to DMA_ macro definitions in the zephyr/lib/dma.h. This change makes it easier to identify what code is using native Zephyr definitions (DMA_*) and which are SOF side definition (SOF_DMA_*). To support non-Zephyr targets, add a minimimal compatibility layer to xtos/lib/dma.h and posix/lib/dma.h. This only covers a few definitions needed by e.g. ipc/ipc[34]/dai.c. To support Zephyr targets that still use XTOS drivers (like imx8m), add compatibility definitions to zephyr/lib/dma-legacy.h. It will be later easy to drop dma-legacy.h when all targets have moved over. Signed-off-by: Kai Vehmanen <[email protected]>
kv2019i
force-pushed
the
202412-dma-namespacing-part1
branch
from
b2eb734 to
cdc1442
Compare
|
New version:
|
kv2019i
force-pushed
the
202412-dma-namespacing-part1
branch
from
cdc1442 to
e51e2d2
Compare
|
New version:
|
Opening PR for DMA cleanup. It does seem this is going to be a bit more invasive (= need to touch a lot of code) than originally thought, so I'd like to get some feedback with this smaller PR before I go about mass renaming the whole SOF side DMA interface.
The definitions moved out to dma-legacy.h don't need to be touched (about 300 lines worth of definitions).
The definitions that remain in zephyr/lib/dma.h however need to be prefixed, and same needs to be done in xtos/lib/dma.h as well.
The benefit of all this is that in generic code, it's immediately clear which DMA function calls and definitions are Zephyr API calls, and which are related to the SOF DMA layer that still sits on top.
Link: #9561