Skip to content

Commit bffd3a8

Browse files
committed
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 <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Nishanth Menon <[email protected]>
1 parent 3e67fd8 commit bffd3a8

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

drivers/soc/ti/k3-ringacc.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ struct k3_ring_ops {
125125
* @occ: Occupancy
126126
* @windex: Write index
127127
* @rindex: Read index
128+
* @tdown_complete: Tear down complete state
128129
*/
129130
struct k3_ring_state {
130131
u32 free;
@@ -192,7 +193,7 @@ struct k3_ringacc_ops {
192193
* @num_rings: number of ring in RA
193194
* @rings_inuse: bitfield for ring usage tracking
194195
* @rm_gp_range: general purpose rings range from tisci
195-
* @dma_ring_reset_quirk: DMA reset w/a enable
196+
* @dma_ring_reset_quirk: DMA reset workaround enable
196197
* @num_proxies: number of RA proxies
197198
* @proxy_inuse: bitfield for proxy usage tracking
198199
* @rings: array of rings descriptors (struct @k3_ring)
@@ -229,9 +230,9 @@ struct k3_ringacc {
229230
};
230231

231232
/**
232-
* struct k3_ringacc - Rings accelerator SoC data
233+
* struct k3_ringacc_soc_data - Rings accelerator SoC data
233234
*
234-
* @dma_ring_reset_quirk: DMA reset w/a enable
235+
* @dma_ring_reset_quirk: DMA reset workaround enable
235236
*/
236237
struct k3_ringacc_soc_data {
237238
unsigned dma_ring_reset_quirk:1;

0 commit comments

Comments
 (0)