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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 20 Jun 2023 19:40:22 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Nishanth Menon <nm@...com>,
        Santosh Shilimkar <ssantosh@...nel.org>,
        Tero Kristo <kristo@...nel.org>
Cc:     vigneshr@...com, praneeth@...com, u-kumar1@...com,
        linux-kernel@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
        Peter Ujfalusi <peter.ujfalusi@...il.com>
Subject: Re: [PATCH V2] soc: ti: k3-ringacc: Fixup documentation errors



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@...il.com>
> Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
> Signed-off-by: Nishanth Menon <nm@...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;

-- 
~Randy