[PATCH v2] staging: rtl8723bs: Improve clarity of MAR usage

[PATCH v2] staging: rtl8723bs: Improve clarity of MAR usage

[Manjae Cho]

This patch improves the readability of the code related to the Multicast
Address Register (REG_MAR) in the rtl8723bs driver. It adds comments to
clarify the purpose and offset of the register, making the code more
self-documenting without introducing new macros.

Signed-off-by: Manjae Cho <manjae.cho@samsung.com>
---

v2: Add comments for clarity instead of new macros

 drivers/staging/rtl8723bs/hal/sdio_halinit.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/staging/rtl8723bs/hal/sdio_halinit.c b/drivers/staging/rtl8723bs/hal/sdio_halinit.c
index c9cd6578f7f8..535cd439121d 100644
--- a/drivers/staging/rtl8723bs/hal/sdio_halinit.c
+++ b/drivers/staging/rtl8723bs/hal/sdio_halinit.c
@@ -380,8 +380,8 @@ static void _InitWMACSetting(struct adapter *padapter)
 	rtw_write32(padapter, REG_RCR, pHalData->ReceiveConfig);
 
 	/*  Accept all multicast address */
-	rtw_write32(padapter, REG_MAR, 0xFFFFFFFF);
-	rtw_write32(padapter, REG_MAR + 4, 0xFFFFFFFF);
+	rtw_write32(padapter, REG_MAR, 0xFFFFFFFF);	/* Offset 0x0620-0x0623 */
+	rtw_write32(padapter, REG_MAR + 4, 0xFFFFFFFF);	/* Offset 0x0624-0x0627 */
 
 	/*  Accept all data frames */
 	value16 = 0xFFFF;
-- 
2.25.1

Re: [PATCH v2] staging: rtl8723bs: Improve clarity of MAR usage

[Philipp Hortmann]

On 7/31/24 10:15, Manjae Cho wrote:
> This patch improves the readability of the code related to the Multicast
> Address Register (REG_MAR) in the rtl8723bs driver. It adds comments to
> clarify the purpose and offset of the register, making the code more
> self-documenting without introducing new macros.
> 
> Signed-off-by: Manjae Cho <manjae.cho@samsung.com>
> ---
> 
> v2: Add comments for clarity instead of new macros
> 
>   drivers/staging/rtl8723bs/hal/sdio_halinit.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/staging/rtl8723bs/hal/sdio_halinit.c b/drivers/staging/rtl8723bs/hal/sdio_halinit.c
> index c9cd6578f7f8..535cd439121d 100644
> --- a/drivers/staging/rtl8723bs/hal/sdio_halinit.c
> +++ b/drivers/staging/rtl8723bs/hal/sdio_halinit.c
> @@ -380,8 +380,8 @@ static void _InitWMACSetting(struct adapter *padapter)
>   	rtw_write32(padapter, REG_RCR, pHalData->ReceiveConfig);
>   
>   	/*  Accept all multicast address */
> -	rtw_write32(padapter, REG_MAR, 0xFFFFFFFF);
> -	rtw_write32(padapter, REG_MAR + 4, 0xFFFFFFFF);
> +	rtw_write32(padapter, REG_MAR, 0xFFFFFFFF);	/* Offset 0x0620-0x0623 */
> +	rtw_write32(padapter, REG_MAR + 4, 0xFFFFFFFF);	/* Offset 0x0624-0x0627 */
>   
>   	/*  Accept all data frames */
>   	value16 = 0xFFFF;

Hi Manjae,

may be this is version v2 of this patch with this subject. But the 
version is not about the subject. It is about the code change itself.

So I can see that this patch was send in with the following subjects:
[PATCH] Improve MAR register definition and usage for rtl8723
[PATCH v2] staging: rtl8723bs: Improve MAR register definition and usage
[PATCH] staging: rtl8723bs: Improve MAR register definition and usage
[PATCH v2] staging: rtl8723bs: Improve clarity of MAR usage

To me the last patch should be a v4. The next patch you send is the v5.
A change history is expected.

Description from Dan under:
https://staticthinking.wordpress.com/2022/07/27/how-to-send-a-v2-patch/

Thanks for your support.

Bye Philipp

RE: [PATCH v2] staging: rtl8723bs: Improve clarity of MAR usage

[Manjae Cho]

> On 7/31/24 10:15, Manjae Cho wrote:
> > This patch improves the readability of the code related to the
> > Multicast Address Register (REG_MAR) in the rtl8723bs driver. It adds
> > comments to clarify the purpose and offset of the register, making the
> > code more self-documenting without introducing new macros.
> >
> > Signed-off-by: Manjae Cho <manjae.cho@samsung.com>
> > ---
> >
> > v2: Add comments for clarity instead of new macros
> >
> >   drivers/staging/rtl8723bs/hal/sdio_halinit.c | 4 ++--
> >   1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/staging/rtl8723bs/hal/sdio_halinit.c
> > b/drivers/staging/rtl8723bs/hal/sdio_halinit.c
> > index c9cd6578f7f8..535cd439121d 100644
> > --- a/drivers/staging/rtl8723bs/hal/sdio_halinit.c
> > +++ b/drivers/staging/rtl8723bs/hal/sdio_halinit.c
> > @@ -380,8 +380,8 @@ static void _InitWMACSetting(struct adapter
> *padapter)
> >   	rtw_write32(padapter, REG_RCR, pHalData->ReceiveConfig);
> >
> >   	/*  Accept all multicast address */
> > -	rtw_write32(padapter, REG_MAR, 0xFFFFFFFF);
> > -	rtw_write32(padapter, REG_MAR + 4, 0xFFFFFFFF);
> > +	rtw_write32(padapter, REG_MAR, 0xFFFFFFFF);	/* Offset 0x0620-
> 0x0623 */
> > +	rtw_write32(padapter, REG_MAR + 4, 0xFFFFFFFF);	/* Offset
> 0x0624-0x0627 */
> >
> >   	/*  Accept all data frames */
> >   	value16 = 0xFFFF;
> 
> Hi Manjae,
> 
> may be this is version v2 of this patch with this subject. But the version
> is not about the subject. It is about the code change itself.
> 
> So I can see that this patch was send in with the following subjects:
> [PATCH] Improve MAR register definition and usage for rtl8723 [PATCH v2]
> staging: rtl8723bs: Improve MAR register definition and usage [PATCH]
> staging: rtl8723bs: Improve MAR register definition and usage [PATCH v2]
> staging: rtl8723bs: Improve clarity of MAR usage
> 
> To me the last patch should be a v4. The next patch you send is the v5.
> A change history is expected.
> 
> Description from Dan under:
> https://protect2.fireeye.com/v1/url?k=c5b934df-a4c29e56-c5b8bf90-
> 74fe48600034-85e35d54190727cc&q=1&e=ba0ae6e7-57f8-40be-8018-
> 0e0bdfedbf8e&u=https%3A%2F%2Fstaticthinking.wordpress.com%2F2022%2F07%2F27
> %2Fhow-to-send-a-v2-patch%2F
> 
> Thanks for your support.
> 
> Bye Philipp

Dear Philipp,

Thank you for your detailed feedback and guidance on the patch versioning and change history.
I appreciate your guidance.

I will implement these improvements in the next version (v5):

1. Use consistent patch versioning
2. Include a complete change history
3. Maintain a consistent subject line

I'll submit the revised v5 patch soon, incorporating these changes.

Thanks again for your support.

Best regards,
Manjae Cho