diff options
| author | Nishanth Menon <nm@ti.com> | 2023-06-20 21:34:42 -0500 |
|---|---|---|
| committer | Nishanth Menon <nm@ti.com> | 2023-07-11 13:04:32 -0500 |
| commit | bffd3a805d8eb7a61e31eebb99bf089cf2229079 (patch) | |
| tree | cf3665d9d7d427fb04717872408fac445aa7ff2f /drivers | |
| parent | 3e67fd8dd2711a63adfe0fa087de38d86a6eb8d5 (diff) | |
| download | linux-stable-bffd3a805d8eb7a61e31eebb99bf089cf2229079.tar.gz linux-stable-bffd3a805d8eb7a61e31eebb99bf089cf2229079.tar.bz2 linux-stable-bffd3a805d8eb7a61e31eebb99bf089cf2229079.zip | |
soc: ti: k3-ringacc: Fixup documentation errors
Fixup couple of misses in documentation. This squashes the following
warnings:
drivers/soc/ti/k3-ringacc.c:135: warning: Function parameter or member 'tdown_complete' not described in 'k3_ring_state'
drivers/soc/ti/k3-ringacc.c:238: warning: expecting prototype for struct k3_ringacc. Prototype was for struct k3_ringacc_soc_data instead
While at this, replace "w/a" to indicate workaround to help clarify.
Cc: Peter Ujfalusi <peter.ujfalusi@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230621023442.275128-1-nm@ti.com
Signed-off-by: Nishanth Menon <nm@ti.com>
Diffstat (limited to 'drivers')
| -rw-r--r-- | drivers/soc/ti/k3-ringacc.c | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/drivers/soc/ti/k3-ringacc.c b/drivers/soc/ti/k3-ringacc.c index 8f131368a758..999403e1b9e0 100644 --- a/drivers/soc/ti/k3-ringacc.c +++ b/drivers/soc/ti/k3-ringacc.c @@ -125,6 +125,7 @@ struct k3_ring_ops { * @occ: Occupancy * @windex: Write index * @rindex: Read index + * @tdown_complete: Tear down complete state */ struct k3_ring_state { u32 free; @@ -192,7 +193,7 @@ struct k3_ringacc_ops { * @num_rings: number of ring in RA * @rings_inuse: bitfield for ring usage tracking * @rm_gp_range: general purpose rings range from tisci - * @dma_ring_reset_quirk: DMA reset w/a enable + * @dma_ring_reset_quirk: DMA reset workaround enable * @num_proxies: number of RA proxies * @proxy_inuse: bitfield for proxy usage tracking * @rings: array of rings descriptors (struct @k3_ring) @@ -229,9 +230,9 @@ struct k3_ringacc { }; /** - * struct k3_ringacc - Rings accelerator SoC data + * struct k3_ringacc_soc_data - Rings accelerator SoC data * - * @dma_ring_reset_quirk: DMA reset w/a enable + * @dma_ring_reset_quirk: DMA reset workaround enable */ struct k3_ringacc_soc_data { unsigned dma_ring_reset_quirk:1; |