[PATCH v2 0/8] staging: rtl8723bs: Fix coding style incosistencies in rtw_security.h

[PATCH v2 0/8] staging: rtl8723bs: Fix coding style incosistencies in rtw_security.h

[Sayyad Abid]

This patch series improves code readability by addressing coding style
issues in `rtw_security.h`. These changes aim to enhance the
maintainability and clarity of the codebase by ensuring compliance with
the Linux kernel's coding standards.

The coding style violations were identified using
`scripts/checkpatch.pl` on `rtw_security.h`.

### Changes in v2:
- Split the original patch into a series of 8 smaller patches, each
  addressing a distinct coding style issue as suggested by Greg's bot.
- Fixed indentation issues, placement of braces, and removal of spaces
  before tabs.
- Improved commit messages with detailed explanations for each change.

For reference, here is the `v1` submission:
https://lore.kernel.org/all/20240911133549.2664372-1-sayyad.abid16@gmail.com/


Sayyad Abid (8):
  staging: rtl8723bs: include: Fix open brace position in rtw_security.h
  staging: rtl8723bs: include: Fix indent for switch case in
    rtw_security.h
  staging: rtl8723bs: include: Fix indent for switch block in
    rtw_security.h
  staging: rtl8723bs: include: Fix use of tabs for indent in
    rtw_security.h
  staging: rtl8723bs: include: Fix indent for struct _byte_ in
    rtw_security.h
  staging: rtl8723bs: include: Fix indent for else block struct in
    rtw_security.h
  staging: rtl8723bs: include: Fix trailing */ position in
    rtw_security.h
  staging: rtl8723bs: include: Remove spaces before tabs in
    rtw_security.h

 .../staging/rtl8723bs/include/rtw_security.h  | 124 +++++++++---------
 1 file changed, 62 insertions(+), 62 deletions(-)

--
2.39.2

[PATCH v2 1/8] staging: rtl8723bs: include: Fix open brace position in rtw_security.h

[Sayyad Abid]

This change improves code readability and consistency with the rest of
the kernel codebase.

Reported by `checkpatch.pl`:
WARNING: open brace '{' following function definitions or control
statements should be on the next line.

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
---
 drivers/staging/rtl8723bs/include/rtw_security.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/drivers/staging/rtl8723bs/include/rtw_security.h b/drivers/staging/rtl8723bs/include/rtw_security.h
index c3e47d52687f..953076667b4d 100644
--- a/drivers/staging/rtl8723bs/include/rtw_security.h
+++ b/drivers/staging/rtl8723bs/include/rtw_security.h
@@ -190,8 +190,7 @@ do {\

 #define SET_ICE_IV_LEN(iv_len, icv_len, encrypt)\
 do {\
-	switch (encrypt)\
-	{\
+	switch (encrypt) {\
 		case _WEP40_:\
 		case _WEP104_:\
 			iv_len = 4;\
--
2.39.2

[PATCH v2 2/8] staging: rtl8723bs: include: Fix indent for switch case in rtw_security.h

[Sayyad Abid]

This change ensures proper formatting for better readability and
maintainability.

Reported by `checkpatch.pl`:
WARNING: switch and case statements should be indented with tabs.

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
---
 .../staging/rtl8723bs/include/rtw_security.h  | 42 +++++++++----------
 1 file changed, 21 insertions(+), 21 deletions(-)

diff --git a/drivers/staging/rtl8723bs/include/rtw_security.h b/drivers/staging/rtl8723bs/include/rtw_security.h
index 953076667b4d..74613ad9a371 100644
--- a/drivers/staging/rtl8723bs/include/rtw_security.h
+++ b/drivers/staging/rtl8723bs/include/rtw_security.h
@@ -191,27 +191,27 @@ do {\
 #define SET_ICE_IV_LEN(iv_len, icv_len, encrypt)\
 do {\
 	switch (encrypt) {\
-		case _WEP40_:\
-		case _WEP104_:\
-			iv_len = 4;\
-			icv_len = 4;\
-			break;\
-		case _TKIP_:\
-			iv_len = 8;\
-			icv_len = 4;\
-			break;\
-		case _AES_:\
-			iv_len = 8;\
-			icv_len = 8;\
-			break;\
-		case _SMS4_:\
-			iv_len = 18;\
-			icv_len = 16;\
-			break;\
-		default:\
-			iv_len = 0;\
-			icv_len = 0;\
-			break;\
+	case _WEP40_:\
+	case _WEP104_:\
+		iv_len = 4;\
+		icv_len = 4;\
+		break;\
+	case _TKIP_:\
+		iv_len = 8;\
+		icv_len = 4;\
+		break;\
+	case _AES_:\
+		iv_len = 8;\
+		icv_len = 8;\
+		break;\
+	case _SMS4_:\
+		iv_len = 18;\
+		icv_len = 16;\
+		break;\
+	default:\
+		iv_len = 0;\
+		icv_len = 0;\
+		break;\
 	} \
 } while (0)

--
2.39.2

[PATCH v2 3/8] staging: rtl8723bs: include: Fix indent for switch block in rtw_security.h

[Sayyad Abid]

This improves code readability by ensuring consistent formatting.

Reported by `checkpatch.pl`:
WARNING: switch blocks should be indented with a single tab.

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
---
 .../staging/rtl8723bs/include/rtw_security.h  | 28 +++++++++----------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/drivers/staging/rtl8723bs/include/rtw_security.h b/drivers/staging/rtl8723bs/include/rtw_security.h
index 74613ad9a371..ee4b5c5804fb 100644
--- a/drivers/staging/rtl8723bs/include/rtw_security.h
+++ b/drivers/staging/rtl8723bs/include/rtw_security.h
@@ -171,20 +171,20 @@ struct security_priv {
 #define GET_ENCRY_ALGO(psecuritypriv, psta, encry_algo, bmcst)\
 do {\
 	switch (psecuritypriv->dot11AuthAlgrthm) {\
-		case dot11AuthAlgrthm_Open:\
-		case dot11AuthAlgrthm_Shared:\
-		case dot11AuthAlgrthm_Auto:\
-			encry_algo = (u8)psecuritypriv->dot11PrivacyAlgrthm;\
-			break;\
-		case dot11AuthAlgrthm_8021X:\
-			if (bmcst)\
-				encry_algo = (u8)psecuritypriv->dot118021XGrpPrivacy;\
-			else\
-				encry_algo = (u8)psta->dot118021XPrivacy;\
-			break;\
-	     case dot11AuthAlgrthm_WAPI:\
-		     encry_algo = (u8)psecuritypriv->dot11PrivacyAlgrthm;\
-		     break;\
+	case dot11AuthAlgrthm_Open:\
+	case dot11AuthAlgrthm_Shared:\
+	case dot11AuthAlgrthm_Auto:\
+		encry_algo = (u8)psecuritypriv->dot11PrivacyAlgrthm;\
+		break;\
+	case dot11AuthAlgrthm_8021X:\
+		if (bmcst)\
+			encry_algo = (u8)psecuritypriv->dot118021XGrpPrivacy;\
+		else\
+			encry_algo = (u8)psta->dot118021XPrivacy;\
+		break;\
+	case dot11AuthAlgrthm_WAPI:\
+		encry_algo = (u8)psecuritypriv->dot11PrivacyAlgrthm;\
+		break;\
 	} \
 } while (0)

--
2.39.2

[PATCH v2 4/8] staging: rtl8723bs: include: Fix use of tabs for indent in rtw_security.h

[Sayyad Abid]

This change ensures that the code is properly indented and easy to follow.

Reported by `checkpatch.pl`:
WARNING: please, use tabs instead of spaces for indentation.

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
---
 drivers/staging/rtl8723bs/include/rtw_security.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/staging/rtl8723bs/include/rtw_security.h b/drivers/staging/rtl8723bs/include/rtw_security.h
index ee4b5c5804fb..0c3271fb7e9d 100644
--- a/drivers/staging/rtl8723bs/include/rtw_security.h
+++ b/drivers/staging/rtl8723bs/include/rtw_security.h
@@ -75,8 +75,8 @@ struct {
 };

 union Keytype {
-        u8   skey[16];
-        u32    lkey[4];
+	u8   skey[16];
+	u32    lkey[4];
 };


--
2.39.2

[PATCH v2 5/8] staging: rtl8723bs: include: Fix indent for struct _byte_ in rtw_security.h

[Sayyad Abid]

This change ensures consistent formatting of the struct declaration.
Improves code readability.

Reported by `checkpatch.pl`:
WARNING: please, no spaces at the start of a line

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
---
 drivers/staging/rtl8723bs/include/rtw_security.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/staging/rtl8723bs/include/rtw_security.h b/drivers/staging/rtl8723bs/include/rtw_security.h
index 0c3271fb7e9d..7901cce76443 100644
--- a/drivers/staging/rtl8723bs/include/rtw_security.h
+++ b/drivers/staging/rtl8723bs/include/rtw_security.h
@@ -50,14 +50,14 @@ union pn48	{
 #ifdef __LITTLE_ENDIAN

 struct {
-  u8 TSC0;
-  u8 TSC1;
-  u8 TSC2;
-  u8 TSC3;
-  u8 TSC4;
-  u8 TSC5;
-  u8 TSC6;
-  u8 TSC7;
+	u8 TSC0;
+	u8 TSC1;
+	u8 TSC2;
+	u8 TSC3;
+	u8 TSC4;
+	u8 TSC5;
+	u8 TSC6;
+	u8 TSC7;
 } _byte_;
 #else
 struct {
--
2.39.2

[PATCH v2 6/8] staging: rtl8723bs: include: Fix indent for else block struct in rtw_security.h

[Sayyad Abid]

This change improves code readability and maintains consistency with the
kernel's coding guidelines.

Reported by `checkpatch.pl`:
WARNING: please, no spaces at the start of a line

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
---
 drivers/staging/rtl8723bs/include/rtw_security.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/staging/rtl8723bs/include/rtw_security.h b/drivers/staging/rtl8723bs/include/rtw_security.h
index 7901cce76443..6124f2ea2431 100644
--- a/drivers/staging/rtl8723bs/include/rtw_security.h
+++ b/drivers/staging/rtl8723bs/include/rtw_security.h
@@ -61,14 +61,14 @@ struct {
 } _byte_;
 #else
 struct {
-  u8 TSC7;
-  u8 TSC6;
-  u8 TSC5;
-  u8 TSC4;
-  u8 TSC3;
-  u8 TSC2;
-  u8 TSC1;
-  u8 TSC0;
+	u8 TSC7;
+	u8 TSC6;
+	u8 TSC5;
+	u8 TSC4;
+	u8 TSC3;
+	u8 TSC2;
+	u8 TSC1;
+	u8 TSC0;
 } _byte_;
 #endif

--
2.39.2

[PATCH v2 7/8] staging: rtl8723bs: include: Fix trailing */ position in rtw_security.h

[Sayyad Abid]

This change enhances readability and conforms to the standard commenting
style in the kernel.

Reported by `checkpatch.pl`:
WARNING: trailing `*/` should be on a separate line.

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
---
 drivers/staging/rtl8723bs/include/rtw_security.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/staging/rtl8723bs/include/rtw_security.h b/drivers/staging/rtl8723bs/include/rtw_security.h
index 6124f2ea2431..09ed298782a6 100644
--- a/drivers/staging/rtl8723bs/include/rtw_security.h
+++ b/drivers/staging/rtl8723bs/include/rtw_security.h
@@ -240,7 +240,8 @@ struct mic_data {
 /* ===== start - public domain SHA256 implementation ===== */

 /* This is based on SHA256 implementation in LibTomCrypt that was released into
- * public domain by Tom St Denis. */
+ * public domain by Tom St Denis.
+ */

 int omac1_aes_128(u8 *key, u8 *data, size_t data_len, u8 *mac);
 void rtw_secmicsetkey(struct mic_data *pmicdata, u8 *key);
--
2.39.2

[PATCH v2 8/8] staging: rtl8723bs: include: Remove spaces before tabs in rtw_security.h

[Sayyad Abid]

This change improves code readability and ensures consistent indentation.

Reported by `checkpatch.pl`:
WARNING: spaces should not be used before a tab for indentation.

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
---
 drivers/staging/rtl8723bs/include/rtw_security.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/drivers/staging/rtl8723bs/include/rtw_security.h b/drivers/staging/rtl8723bs/include/rtw_security.h
index 09ed298782a6..32f6d3a5e309 100644
--- a/drivers/staging/rtl8723bs/include/rtw_security.h
+++ b/drivers/staging/rtl8723bs/include/rtw_security.h
@@ -81,12 +81,12 @@ union Keytype {


 struct rt_pmkid_list {
-	u8 				bUsed;
-	u8 				Bssid[6];
-	u8 				PMKID[16];
-	u8 				SsidBuf[33];
+	u8				bUsed;
+	u8				Bssid[6];
+	u8				PMKID[16];
+	u8				SsidBuf[33];
 	u8 *ssid_octet;
-	u16 					ssid_length;
+	u16					ssid_length;
 };


@@ -162,7 +162,7 @@ struct security_priv {

 	/*  For WPA2 Pre-Authentication. */
 	struct rt_pmkid_list		PMKIDList[NUM_PMKID_CACHE];	/*  Renamed from PreAuthKey[NUM_PRE_AUTH_KEY]. Annie, 2006-10-13. */
-	u8 		PMKIDIndex;
+	u8		PMKIDIndex;

 	u8 bWepDefaultKeyIdxSet;

--
2.39.2

Re: [PATCH v2 0/8] staging: rtl8723bs: Fix coding style incosistencies in rtw_security.h

[Philipp Hortmann]

On 9/12/24 06:04, Sayyad Abid wrote:
> This patch series improves code readability by addressing coding style
> issues in `rtw_security.h`. These changes aim to enhance the
> maintainability and clarity of the codebase by ensuring compliance with
> the Linux kernel's coding standards.
> 
> The coding style violations were identified using
> `scripts/checkpatch.pl` on `rtw_security.h`.
> 
> ### Changes in v2:
> - Split the original patch into a series of 8 smaller patches, each
>    addressing a distinct coding style issue as suggested by Greg's bot.
> - Fixed indentation issues, placement of braces, and removal of spaces
>    before tabs.
> - Improved commit messages with detailed explanations for each change.
> 
> For reference, here is the `v1` submission:
> https://lore.kernel.org/all/20240911133549.2664372-1-sayyad.abid16@gmail.com/
> 
> 
> Sayyad Abid (8):
>    staging: rtl8723bs: include: Fix open brace position in rtw_security.h
>    staging: rtl8723bs: include: Fix indent for switch case in
>      rtw_security.h
>    staging: rtl8723bs: include: Fix indent for switch block in
>      rtw_security.h
>    staging: rtl8723bs: include: Fix use of tabs for indent in
>      rtw_security.h
>    staging: rtl8723bs: include: Fix indent for struct _byte_ in
>      rtw_security.h
>    staging: rtl8723bs: include: Fix indent for else block struct in
>      rtw_security.h
>    staging: rtl8723bs: include: Fix trailing */ position in
>      rtw_security.h
>    staging: rtl8723bs: include: Remove spaces before tabs in
>      rtw_security.h
> 
>   .../staging/rtl8723bs/include/rtw_security.h  | 124 +++++++++---------
>   1 file changed, 62 insertions(+), 62 deletions(-)
> 
> --
> 2.39.2
> 

Tested-by: Philipp Hortmann <philipp.g.hortmann@gmail.com>