| Message ID | 20230621023442.275128-1-nm@ti.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [V2] soc: ti: k3-ringacc: Fixup documentation errors | expand |
On 6/20/23 19:34, Nishanth Menon wrote: > 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> > Signed-off-by: Nishanth Menon <nm@ti.com> > --- > Changes since V1: > * Fixedup a couple of places where "w/a" is used - replaced with > "workaround" to indicate quirk workaround Thanks for that. Good change. > * Picked up Randy's Reviewed-by. > > V1: https://lore.kernel.org/all/20230621022407.270842-1-nm@ti.com/ > > drivers/soc/ti/k3-ringacc.c | 7 ++++--- > 1 file 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;
Hi Nishanth Menon, On Tue, 20 Jun 2023 21:34:42 -0500, Nishanth Menon wrote: > 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. > > [...] I have applied the following to branch ti-drivers-soc-next on [1]. Thank you! [1/1] soc: ti: k3-ringacc: Fixup documentation errors commit: bffd3a805d8eb7a61e31eebb99bf089cf2229079 All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent up the chain during the next merge window (or sooner if it is a relevant bug fix), however if problems are discovered then the patch may be dropped or reverted. You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed. If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced. Please add any relevant lists and maintainers to the CCs when replying to this mail. [1] git://git.kernel.org/pub/scm/linux/kernel/git/ti/linux.git
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;