Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
Sender: Larry Finger <larry.finger@gmail.com>
Message-ID: <f4f8d381-9ee1-c504-c41c-97a9332066c9@lwfinger.net>
Date:   Fri, 15 Apr 2022 10:44:30 -0500
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.7.0
Subject: Re: [PATCH v3 3/8] staging: r8188eu: clean up comments in struct
 rt_firmware_hdr
Content-Language: en-US
To:     Michael Straube <straube.linux@gmail.com>,
        gregkh@linuxfoundation.org
Cc:     phil@philpotter.co.uk, linux-staging@lists.linux.dev,
        linux-kernel@vger.kernel.org
References: <20220415121023.11564-1-straube.linux@gmail.com>
 <20220415121023.11564-4-straube.linux@gmail.com>
From:   Larry Finger <Larry.Finger@lwfinger.net>
In-Reply-To: <20220415121023.11564-4-straube.linux@gmail.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 4/15/22 07:10, Michael Straube wrote:
> The comments in struct rt_firmware_hdr are not needed.
> Remove them.
> 
> Signed-off-by: Michael Straube <straube.linux@gmail.com>
> ---
> v3:
> - no changes
> 
> v2:
> - no changes
> 
>   drivers/staging/r8188eu/core/rtw_fw.c | 37 ++++++++-------------------
>   1 file changed, 11 insertions(+), 26 deletions(-)
> 
> diff --git a/drivers/staging/r8188eu/core/rtw_fw.c b/drivers/staging/r8188eu/core/rtw_fw.c
> index 7cd08268f3b9..323e0c634c4e 100644
> --- a/drivers/staging/r8188eu/core/rtw_fw.c
> +++ b/drivers/staging/r8188eu/core/rtw_fw.c
> @@ -14,37 +14,22 @@
>   	(le16_to_cpu(_fwhdr->Signature) & 0xFFF0) == 0x2300 ||	\
>   	(le16_to_cpu(_fwhdr->Signature) & 0xFFF0) == 0x88E0)
>   
> -/*  This structure must be careful with byte-ordering */
> -
>   struct rt_firmware_hdr {
> -	/*  8-byte alinment required */
> -	/*  LONG WORD 0 ---- */
> -	__le16		Signature;	/* 92C0: test chip; 92C,
> -					 * 88C0: test chip; 88C1: MP A-cut;
> -					 * 92C1: MP A-cut */
> -	u8		Category;	/*  AP/NIC and USB/PCI */
> -	u8		Function;	/*  Reserved for different FW function
> -					 *  indcation, for further use when
> -					 *  driver needs to download different
> -					 *  FW for different conditions */
> -	__le16		Version;	/*  FW Version */
> -	u8		Subversion;	/*  FW Subversion, default 0x00 */
> +	__le16		Signature;
> +	u8		Category;
> +	u8		Function;
> +	__le16		Version;
> +	u8		Subversion;
>   	u8		Rsvd1;
> -
> -	/*  LONG WORD 1 ---- */
> -	u8		Month;	/*  Release time Month field */
> -	u8		Date;	/*  Release time Date field */
> -	u8		Hour;	/*  Release time Hour field */
> -	u8		Minute;	/*  Release time Minute field */
> -	__le16		RamCodeSize;	/*  The size of RAM code */
> +	u8		Month;
> +	u8		Date;
> +	u8		Hour;
> +	u8		Minute;
> +	__le16		RamCodeSize;
>   	u8		Foundry;
>   	u8		Rsvd2;
> -
> -	/*  LONG WORD 2 ---- */
> -	__le32		SvnIdx;	/*  The SVN entry index */
> +	__le32		SvnIdx;
>   	__le32		Rsvd3;
> -
> -	/*  LONG WORD 3 ---- */
>   	__le32		Rsvd4;
>   	__le32		Rsvd5;
>   };

The comments "LONG WORD" are useless, but the comments describing the fields are 
still useful. I do not like this patch.

Will your next step be stripping ALL comments from the driver? The source would 
be a lot smaller that way! :)

Larry