Commit bffd3a80 authored by Nishanth Menon's avatar Nishanth Menon
Browse files

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230621023442.275128-1-nm@ti.com


Signed-off-by: default avatarNishanth Menon <nm@ti.com>
parent 3e67fd8d

drivers/soc/ti/k3-ringacc.c

+4 −3
Original line number Diff line number Diff line
@@ -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;