Skip to contentSkip to conversation

staging: r8188eu: clean up error handling in rtw_start_drv_threads()

PATCH In review Michael Straube 3 participants 5 messages Nov 6, 2022 – Nov 7, 2022 Staging

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: r8188eu: clean up error handling in rtw_start_drv_threads()

Convert the error handling in the function rtw_start_drv_threads() to the common logic used in the kernel. Another step to get rid of _FAIL and _SUCCESS which uses inverted logic.

---
 drivers/staging/r8188eu/include/osdep_intf.h |  2 +-
 drivers/staging/r8188eu/os_dep/os_intfs.c    | 17 +++++++----------
 2 files changed, 8 insertions(+), 11 deletions(-)
drivers/staging/r8188eu/include/osdep_intf.h +1 -1
index 0f7d74a3ff6d..6d66cb57225e 100644
@@ -46,7 +46,7 @@ u8 rtw_init_drv_sw(struct adapter *padapter);
 void rtw_free_drv_sw(struct adapter *padapter);
 void rtw_reset_drv_sw(struct adapter *padapter);
 
-u32 rtw_start_drv_threads(struct adapter *padapter);
+int rtw_start_drv_threads(struct adapter *padapter);
 void rtw_stop_drv_threads (struct adapter *padapter);
 void rtw_cancel_all_timer(struct adapter *padapter);
 
drivers/staging/r8188eu/os_dep/os_intfs.c +7 -10
index 970f380bac96..66556e07ed93 100644
@@ -363,18 +363,16 @@ struct net_device *rtw_init_netdev(struct adapter *old_padapter)
 	return pnetdev;
 }
 
-u32 rtw_start_drv_threads(struct adapter *padapter)
+int rtw_start_drv_threads(struct adapter *padapter)
 {
-	u32 _status = _SUCCESS;
-
 	padapter->cmdThread = kthread_run(rtw_cmd_thread, padapter, "RTW_CMD_THREAD");
 	if (IS_ERR(padapter->cmdThread))
-		_status = _FAIL;
-	else
-		/* wait for rtw_cmd_thread() to start running */
-		wait_for_completion(&padapter->cmdpriv.start_cmd_thread);
+		return PTR_ERR(padapter->cmdThread);
 
-	return _status;
+	/* wait for rtw_cmd_thread() to start running */
+	wait_for_completion(&padapter->cmdpriv.start_cmd_thread);
+
+	return 0;
 }
 
 void rtw_stop_drv_threads(struct adapter *padapter)
@@ -627,8 +625,7 @@ static int _netdev_open(struct net_device *pnetdev)
 
 		netdev_dbg(pnetdev, "MAC Address = %pM\n", pnetdev->dev_addr);
 
-		status = rtw_start_drv_threads(padapter);
-		if (status == _FAIL) {
+		if (rtw_start_drv_threads(padapter)) {
 			pr_info("Initialize driver software resource Failed!\n");
 			goto netdev_open_error;
 		}
Signature · 1 line
2.38.0
#1 lore raw
Quoted 3 lines · Michael Straube

Convert the error handling in the function rtw_start_drv_threads() to the common logic used in the kernel. Another step to get rid of _FAIL and _SUCCESS which uses inverted logic.

Hello Michael,
Can you please tell how did you find this opportunity for improvement? Are you using some tool or is it a manual code review/analysis?

Thank you,
./drv

Quoted 63 lines
---
 drivers/staging/r8188eu/include/osdep_intf.h |  2 +-
 drivers/staging/r8188eu/os_dep/os_intfs.c    | 17 +++++++----------
 2 files changed, 8 insertions(+), 11 deletions(-)
drivers/staging/r8188eu/include/osdep_intf.h +1 -1
index 0f7d74a3ff6d..6d66cb57225e 100644
@@ -46,7 +46,7 @@ u8 rtw_init_drv_sw(struct adapter *padapter);
 void rtw_free_drv_sw(struct adapter *padapter);
 void rtw_reset_drv_sw(struct adapter *padapter);
 
-u32 rtw_start_drv_threads(struct adapter *padapter);
+int rtw_start_drv_threads(struct adapter *padapter);
 void rtw_stop_drv_threads (struct adapter *padapter);
 void rtw_cancel_all_timer(struct adapter *padapter);
 
drivers/staging/r8188eu/os_dep/os_intfs.c +7 -11
index 970f380bac96..66556e07ed93 100644
@@ -363,18 +363,16 @@ struct net_device *rtw_init_netdev(struct adapter *old_padapter)
 	return pnetdev;
 }
 
-u32 rtw_start_drv_threads(struct adapter *padapter)
+int rtw_start_drv_threads(struct adapter *padapter)
 {
-	u32 _status = _SUCCESS;
-
 	padapter->cmdThread = kthread_run(rtw_cmd_thread, padapter, "RTW_CMD_THREAD");
 	if (IS_ERR(padapter->cmdThread))
-		_status = _FAIL;
-	else
-		/* wait for rtw_cmd_thread() to start running */
-		wait_for_completion(&padapter->cmdpriv.start_cmd_thread);
+		return PTR_ERR(padapter->cmdThread);
 
-	return _status;
+	/* wait for rtw_cmd_thread() to start running */
+	wait_for_completion(&padapter->cmdpriv.start_cmd_thread);
+
+	return 0;
 }
 
 void rtw_stop_drv_threads(struct adapter *padapter)
@@ -627,8 +625,7 @@ static int _netdev_open(struct net_device *pnetdev)
 
 		netdev_dbg(pnetdev, "MAC Address = %pM\n", pnetdev->dev_addr);
 
-		status = rtw_start_drv_threads(padapter);
-		if (status == _FAIL) {
+		if (rtw_start_drv_threads(padapter)) {
 			pr_info("Initialize driver software resource Failed!\n");
 			goto netdev_open_error;
 		}
--

2.38.0

#2 lore raw
Quoted 9 lines · Deepak R Varma
Quoted 3 lines · Michael Straube

Convert the error handling in the function rtw_start_drv_threads() to the common logic used in the kernel. Another step to get rid of _FAIL and _SUCCESS which uses inverted logic.

Hello Michael,
Can you please tell how did you find this opportunity for improvement? Are you using some tool or is it a manual code review/analysis?

Hi Deepak,

I just used git grep to search for _FAIL or _SUCCESS and then looked at the code manually.

Regards,
Michael

#3 lore raw
Quoted 11 lines · Michael Straube
Quoted 9 lines · Deepak R Varma
Quoted 3 lines · Michael Straube

Convert the error handling in the function rtw_start_drv_threads() to the common logic used in the kernel. Another step to get rid of _FAIL and _SUCCESS which uses inverted logic.

Hello Michael,
Can you please tell how did you find this opportunity for improvement? Are you using some tool or is it a manual code review/analysis?

Quoted 8 lines

Hi Deepak,

I just used git grep to search for _FAIL or _SUCCESS and then looked at the code manually.

Regards,
Michael

Okay. That is very helpful. Thank you Michael.

./drv

Tested-by on v1 1/1
#4 lore raw
In reply to Michael Straube
Quoted 53 lines · Michael Straube

Convert the error handling in the function rtw_start_drv_threads() to the common logic used in the kernel. Another step to get rid of _FAIL and _SUCCESS which uses inverted logic.

---
  drivers/staging/r8188eu/include/osdep_intf.h |  2 +-
  drivers/staging/r8188eu/os_dep/os_intfs.c    | 17 +++++++----------
  2 files changed, 8 insertions(+), 11 deletions(-)
drivers/staging/r8188eu/include/osdep_intf.h +1 -1
index 0f7d74a3ff6d..6d66cb57225e 100644
@@ -46,7 +46,7 @@ u8 rtw_init_drv_sw(struct adapter *padapter);
  void rtw_free_drv_sw(struct adapter *padapter);
  void rtw_reset_drv_sw(struct adapter *padapter);
 
-u32 rtw_start_drv_threads(struct adapter *padapter);
+int rtw_start_drv_threads(struct adapter *padapter);
  void rtw_stop_drv_threads (struct adapter *padapter);
  void rtw_cancel_all_timer(struct adapter *padapter);
 
drivers/staging/r8188eu/os_dep/os_intfs.c +6 -8
index 970f380bac96..66556e07ed93 100644
@@ -363,18 +363,16 @@ struct net_device *rtw_init_netdev(struct adapter *old_padapter)
  	return pnetdev;
  }
 
-u32 rtw_start_drv_threads(struct adapter *padapter)
+int rtw_start_drv_threads(struct adapter *padapter)
  {
-	u32 _status = _SUCCESS;
-
  	padapter->cmdThread = kthread_run(rtw_cmd_thread, padapter, "RTW_CMD_THREAD");
  	if (IS_ERR(padapter->cmdThread))
-		_status = _FAIL;
-	else
-		/* wait for rtw_cmd_thread() to start running */
-		wait_for_completion(&padapter->cmdpriv.start_cmd_thread);
+		return PTR_ERR(padapter->cmdThread);
 
-	return _status;
+	/* wait for rtw_cmd_thread() to start running */
+	wait_for_completion(&padapter->cmdpriv.start_cmd_thread);
+
+	return 0;
  }
 
  void rtw_stop_drv_threads(struct adapter *padapter)

drivers/staging/r8188eu/os_dep/os_intfs.c static int _netdev_open(struct net_device *pnetdev) · line 631

Quoted 9 lines
drivers/staging/r8188eu/os_dep/os_intfs.c +1 -2
@@ -627,8 +625,7 @@ static int _netdev_open(struct net_device *pnetdev)
 
  		netdev_dbg(pnetdev, "MAC Address = %pM\n", pnetdev->dev_addr);
 
-		status = rtw_start_drv_threads(padapter);
-		if (status == _FAIL) {
+		if (rtw_start_drv_threads(padapter)) {
  			pr_info("Initialize driver software resource Failed!\n");
  			goto netdev_open_error;
  		}