Re: [PATCH] soc: ti: k3-ringacc: Fixup documentation errors

[Nishanth Menon]

On 19:27-20230620, Randy Dunlap wrote:
> 
> 
> On 6/20/23 19:24, 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
> > 
> > Cc: Peter Ujfalusi <peter.ujfalusi@xxxxxxxxx>
> > Signed-off-by: Nishanth Menon <nm@xxxxxx>
> 
> Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> 
> (more below)
> 
> > ---
> >  drivers/soc/ti/k3-ringacc.c | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> > 
> > diff --git a/drivers/soc/ti/k3-ringacc.c b/drivers/soc/ti/k3-ringacc.c
> > index 8f131368a758..548b9f605d86 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;
> > @@ -229,7 +230,7 @@ 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
> 
> What does "w/a" mean?

I think it means work around.. (going by the "quirk" terminology).. Let
me respin this with w/a replaced with workaround as well.

-- 
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3  1A34 DDB5 849D 1736 249D