Skip to contentSkip to conversation

Staging: rtl8723bs: Change return type and type of local variable

PATCH Superseded Madhumitha Prabakaran 2 participants 7 messages Mar 20, 2019 Staging

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Staging: rtl8723bs: Change return type and type of local variable

Change type of local variable and return type of function rtw_startbss_cmd, as function's return type are defined for standard error codes. Change corresponding function declarations and call sites. Along with modifications, remove extern from the function declaration to maintain Linux kernel coding style.
Issue suggested by Coccinelle.

---
 drivers/staging/rtl8723bs/core/rtw_cmd.c      | 8 ++++----
 drivers/staging/rtl8723bs/include/cmd_osdep.h | 2 +-
 drivers/staging/rtl8723bs/include/rtw_cmd.h   | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
drivers/staging/rtl8723bs/core/rtw_cmd.c +4 -4
index bd3a5a23a418..04c6927dab8b 100644
@@ -256,7 +256,7 @@ ISR/Call-Back functions can't call this sub-function.
 
 */
 
-sint	_rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
 {
 	_irqL irqL;
 
@@ -331,7 +331,7 @@ int rtw_cmd_filter(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 
 
 
-u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 {
 	int res = _FAIL;
 	struct adapter *padapter = pcmdpriv->padapter;
@@ -719,12 +719,12 @@ u8 rtw_createbss_cmd(struct adapter  *padapter)
 	return res;
 }
 
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags)
+int rtw_startbss_cmd(struct adapter  *padapter, int flags)
 {
 	struct cmd_obj *pcmd;
 	struct cmd_priv  *pcmdpriv = &padapter->cmdpriv;
 	struct submit_ctx sctx;
-	u8 res = _SUCCESS;
+	int res = _SUCCESS;
 
 	if (flags & RTW_CMDF_DIRECTLY) {
 		/* no need to enqueue, do the cmd hdl directly and free cmd parameter */
drivers/staging/rtl8723bs/include/cmd_osdep.h +1 -1
index 06ab48263757..d3af9f44ad59 100644
@@ -12,7 +12,7 @@ int rtw_init_cmd_priv(struct	cmd_priv *pcmdpriv);
 int rtw_init_evt_priv(struct evt_priv *pevtpriv);
 extern void _rtw_free_evt_priv (struct	evt_priv *pevtpriv);
 extern void _rtw_free_cmd_priv (struct	cmd_priv *pcmdpriv);
-extern sint _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
 extern struct	cmd_obj	*_rtw_dequeue_cmd(struct __queue *queue);
 
 #endif
drivers/staging/rtl8723bs/include/rtw_cmd.h +2 -2
index fa4ebc3d7539..b83824ca2e31 100644
@@ -122,7 +122,7 @@ struct P2P_PS_CTWPeriod_t {
 	u8 CTWPeriod;	/* TU */
 };
 
-extern u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
 extern struct cmd_obj *rtw_dequeue_cmd(struct cmd_priv *pcmdpriv);
 extern void rtw_free_cmd_obj(struct cmd_obj *pcmd);
 
@@ -827,7 +827,7 @@ struct RunInThread_param
 
 u8 rtw_sitesurvey_cmd(struct adapter  *padapter, struct ndis_802_11_ssid *ssid, int ssid_num, struct rtw_ieee80211_channel *ch, int ch_num);
 extern u8 rtw_createbss_cmd(struct adapter  *padapter);
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags);
+int rtw_startbss_cmd(struct adapter  *padapter, int flags);
 
 struct sta_info;
 extern u8 rtw_setstakey_cmd(struct adapter  *padapter, struct sta_info *sta, u8 unicast_key, bool enqueue);
Signature · 1 line
2.17.1
#1 lore raw
Quoted 5 lines · Madhumitha Prabakaran

Change type of local variable and return type of function rtw_startbss_cmd, as function's return type are defined for standard error codes. Change corresponding function declarations and call sites. Along with modifications, remove extern from the function declaration to maintain Linux kernel coding style.

The changes look good, but the log message isn't really ideal to understand what is going on.

You could start by stating what happens:

rtw_startbss_cmd can return the result of calling rtw_enqueue_cmd, which can return the result of calling _rtw_enqueue_cmd, but they all have different return types (u8, u32, and sint, respectively).

As all of these functions return error codes, change all the return types to int, in preparation for converting these functions to use standard kernel error codes.

In checking these changes, I also saw nearby the function rtw_cmd_filter. Currently that returns int and _SUCCESS and _FAIL. Given the name, it might make more sense for this function to return true in the _SUCCESS case and false in the _FAIL case, and thus to have a bool return type. The function also has a local variable called bAllow of type u8 that would be better off with the name allow and type bool. There is also a strange prototype of the function that is right above the definition of the function itself. This is not needed.

julia

Quoted 91 lines

Issue suggested by Coccinelle.

---
 drivers/staging/rtl8723bs/core/rtw_cmd.c      | 8 ++++----
 drivers/staging/rtl8723bs/include/cmd_osdep.h | 2 +-
 drivers/staging/rtl8723bs/include/rtw_cmd.h   | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
drivers/staging/rtl8723bs/core/rtw_cmd.c +4 -4
index bd3a5a23a418..04c6927dab8b 100644
@@ -256,7 +256,7 @@ ISR/Call-Back functions can't call this sub-function.
 
 */
 
-sint	_rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
 {
 	_irqL irqL;
 
@@ -331,7 +331,7 @@ int rtw_cmd_filter(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 
 
 
-u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 {
 	int res = _FAIL;
 	struct adapter *padapter = pcmdpriv->padapter;
@@ -719,12 +719,12 @@ u8 rtw_createbss_cmd(struct adapter  *padapter)
 	return res;
 }
 
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags)
+int rtw_startbss_cmd(struct adapter  *padapter, int flags)
 {
 	struct cmd_obj *pcmd;
 	struct cmd_priv  *pcmdpriv = &padapter->cmdpriv;
 	struct submit_ctx sctx;
-	u8 res = _SUCCESS;
+	int res = _SUCCESS;
 
 	if (flags & RTW_CMDF_DIRECTLY) {
 		/* no need to enqueue, do the cmd hdl directly and free cmd parameter */
drivers/staging/rtl8723bs/include/cmd_osdep.h +1 -1
index 06ab48263757..d3af9f44ad59 100644
@@ -12,7 +12,7 @@ int rtw_init_cmd_priv(struct	cmd_priv *pcmdpriv);
 int rtw_init_evt_priv(struct evt_priv *pevtpriv);
 extern void _rtw_free_evt_priv (struct	evt_priv *pevtpriv);
 extern void _rtw_free_cmd_priv (struct	cmd_priv *pcmdpriv);
-extern sint _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
 extern struct	cmd_obj	*_rtw_dequeue_cmd(struct __queue *queue);
 
 #endif
drivers/staging/rtl8723bs/include/rtw_cmd.h +2 -3
index fa4ebc3d7539..b83824ca2e31 100644
@@ -122,7 +122,7 @@ struct P2P_PS_CTWPeriod_t {
 	u8 CTWPeriod;	/* TU */
 };
 
-extern u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
 extern struct cmd_obj *rtw_dequeue_cmd(struct cmd_priv *pcmdpriv);
 extern void rtw_free_cmd_obj(struct cmd_obj *pcmd);
 
@@ -827,7 +827,7 @@ struct RunInThread_param
 
 u8 rtw_sitesurvey_cmd(struct adapter  *padapter, struct ndis_802_11_ssid *ssid, int ssid_num, struct rtw_ieee80211_channel *ch, int ch_num);
 extern u8 rtw_createbss_cmd(struct adapter  *padapter);
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags);
+int rtw_startbss_cmd(struct adapter  *padapter, int flags);
 
 struct sta_info;
 extern u8 rtw_setstakey_cmd(struct adapter  *padapter, struct sta_info *sta, u8 unicast_key, bool enqueue);
--

2.17.1

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20190320000125.8930-1-madhumithabiw%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

#2 lore raw
Quoted 15 lines · Julia Lawall
Quoted 5 lines · Madhumitha Prabakaran

Change type of local variable and return type of function rtw_startbss_cmd, as function's return type are defined for standard error codes. Change corresponding function declarations and call sites. Along with modifications, remove extern from the function declaration to maintain Linux kernel coding style.

The changes look good, but the log message isn't really ideal to understand what is going on.

You could start by stating what happens:

Quoted 7 lines

rtw_startbss_cmd can return the result of calling rtw_enqueue_cmd, which can return the result of calling _rtw_enqueue_cmd, but they all have different return types (u8, u32, and sint, respectively).

As all of these functions return error codes, change all the return types to int, in preparation for converting these functions to use standard kernel error codes.

This makes more sense, I will edit it in my commit log.

Quoted 9 lines

In checking these changes, I also saw nearby the function rtw_cmd_filter. Currently that returns int and _SUCCESS and _FAIL. Given the name, it might make more sense for this function to return true in the _SUCCESS case and false in the _FAIL case, and thus to have a bool return type. The function also has a local variable called bAllow of type u8 that would be better off with the name allow and type bool. There is also a strange prototype of the function that is right above the definition of the function itself. This is not needed.

Can I submit this change in another patch? Combining above change and this one as a patch series.

Quoted 95 lines

julia

Quoted 91 lines

Issue suggested by Coccinelle.

---
 drivers/staging/rtl8723bs/core/rtw_cmd.c      | 8 ++++----
 drivers/staging/rtl8723bs/include/cmd_osdep.h | 2 +-
 drivers/staging/rtl8723bs/include/rtw_cmd.h   | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
drivers/staging/rtl8723bs/core/rtw_cmd.c +4 -4
index bd3a5a23a418..04c6927dab8b 100644
@@ -256,7 +256,7 @@ ISR/Call-Back functions can't call this sub-function.
 
 */
 
-sint	_rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
 {
 	_irqL irqL;
 
@@ -331,7 +331,7 @@ int rtw_cmd_filter(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 
 
 
-u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 {
 	int res = _FAIL;
 	struct adapter *padapter = pcmdpriv->padapter;
@@ -719,12 +719,12 @@ u8 rtw_createbss_cmd(struct adapter  *padapter)
 	return res;
 }
 
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags)
+int rtw_startbss_cmd(struct adapter  *padapter, int flags)
 {
 	struct cmd_obj *pcmd;
 	struct cmd_priv  *pcmdpriv = &padapter->cmdpriv;
 	struct submit_ctx sctx;
-	u8 res = _SUCCESS;
+	int res = _SUCCESS;
 
 	if (flags & RTW_CMDF_DIRECTLY) {
 		/* no need to enqueue, do the cmd hdl directly and free cmd parameter */
drivers/staging/rtl8723bs/include/cmd_osdep.h +1 -1
index 06ab48263757..d3af9f44ad59 100644
@@ -12,7 +12,7 @@ int rtw_init_cmd_priv(struct	cmd_priv *pcmdpriv);
 int rtw_init_evt_priv(struct evt_priv *pevtpriv);
 extern void _rtw_free_evt_priv (struct	evt_priv *pevtpriv);
 extern void _rtw_free_cmd_priv (struct	cmd_priv *pcmdpriv);
-extern sint _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
 extern struct	cmd_obj	*_rtw_dequeue_cmd(struct __queue *queue);
 
 #endif
drivers/staging/rtl8723bs/include/rtw_cmd.h +2 -3
index fa4ebc3d7539..b83824ca2e31 100644
@@ -122,7 +122,7 @@ struct P2P_PS_CTWPeriod_t {
 	u8 CTWPeriod;	/* TU */
 };
 
-extern u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
 extern struct cmd_obj *rtw_dequeue_cmd(struct cmd_priv *pcmdpriv);
 extern void rtw_free_cmd_obj(struct cmd_obj *pcmd);
 
@@ -827,7 +827,7 @@ struct RunInThread_param
 
 u8 rtw_sitesurvey_cmd(struct adapter  *padapter, struct ndis_802_11_ssid *ssid, int ssid_num, struct rtw_ieee80211_channel *ch, int ch_num);
 extern u8 rtw_createbss_cmd(struct adapter  *padapter);
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags);
+int rtw_startbss_cmd(struct adapter  *padapter, int flags);
 
 struct sta_info;
 extern u8 rtw_setstakey_cmd(struct adapter  *padapter, struct sta_info *sta, u8 unicast_key, bool enqueue);
--

2.17.1

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20190320000125.8930-1-madhumithabiw%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

#3 lore raw
Quoted 36 lines · Madhumthia Prabakaran
Quoted 15 lines · Julia Lawall
Quoted 5 lines · Madhumitha Prabakaran

Change type of local variable and return type of function rtw_startbss_cmd, as function's return type are defined for standard error codes. Change corresponding function declarations and call sites. Along with modifications, remove extern from the function declaration to maintain Linux kernel coding style.

The changes look good, but the log message isn't really ideal to understand what is going on.

You could start by stating what happens:

Quoted 7 lines

rtw_startbss_cmd can return the result of calling rtw_enqueue_cmd, which can return the result of calling _rtw_enqueue_cmd, but they all have different return types (u8, u32, and sint, respectively).

As all of these functions return error codes, change all the return types to int, in preparation for converting these functions to use standard kernel error codes.

This makes more sense, I will edit it in my commit log.

Quoted 9 lines

In checking these changes, I also saw nearby the function rtw_cmd_filter. Currently that returns int and _SUCCESS and _FAIL. Given the name, it might make more sense for this function to return true in the _SUCCESS case and false in the _FAIL case, and thus to have a bool return type. The function also has a local variable called bAllow of type u8 that would be better off with the name allow and type bool. There is also a strange prototype of the function that is right above the definition of the function itself. This is not needed.

Quoted 2 lines

Can I submit this change in another patch? Combining above change and this one as a patch series.

A series would be fine.

julia

Quoted 98 lines
Quoted 97 lines

julia

Quoted 91 lines

Issue suggested by Coccinelle.

---
 drivers/staging/rtl8723bs/core/rtw_cmd.c      | 8 ++++----
 drivers/staging/rtl8723bs/include/cmd_osdep.h | 2 +-
 drivers/staging/rtl8723bs/include/rtw_cmd.h   | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
drivers/staging/rtl8723bs/core/rtw_cmd.c +4 -4
index bd3a5a23a418..04c6927dab8b 100644
@@ -256,7 +256,7 @@ ISR/Call-Back functions can't call this sub-function.
 
 */
 
-sint	_rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
 {
 	_irqL irqL;
 
@@ -331,7 +331,7 @@ int rtw_cmd_filter(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 
 
 
-u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 {
 	int res = _FAIL;
 	struct adapter *padapter = pcmdpriv->padapter;
@@ -719,12 +719,12 @@ u8 rtw_createbss_cmd(struct adapter  *padapter)
 	return res;
 }
 
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags)
+int rtw_startbss_cmd(struct adapter  *padapter, int flags)
 {
 	struct cmd_obj *pcmd;
 	struct cmd_priv  *pcmdpriv = &padapter->cmdpriv;
 	struct submit_ctx sctx;
-	u8 res = _SUCCESS;
+	int res = _SUCCESS;
 
 	if (flags & RTW_CMDF_DIRECTLY) {
 		/* no need to enqueue, do the cmd hdl directly and free cmd parameter */
drivers/staging/rtl8723bs/include/cmd_osdep.h +1 -1
index 06ab48263757..d3af9f44ad59 100644
@@ -12,7 +12,7 @@ int rtw_init_cmd_priv(struct	cmd_priv *pcmdpriv);
 int rtw_init_evt_priv(struct evt_priv *pevtpriv);
 extern void _rtw_free_evt_priv (struct	evt_priv *pevtpriv);
 extern void _rtw_free_cmd_priv (struct	cmd_priv *pcmdpriv);
-extern sint _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
 extern struct	cmd_obj	*_rtw_dequeue_cmd(struct __queue *queue);
 
 #endif
drivers/staging/rtl8723bs/include/rtw_cmd.h +2 -3
index fa4ebc3d7539..b83824ca2e31 100644
@@ -122,7 +122,7 @@ struct P2P_PS_CTWPeriod_t {
 	u8 CTWPeriod;	/* TU */
 };
 
-extern u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
 extern struct cmd_obj *rtw_dequeue_cmd(struct cmd_priv *pcmdpriv);
 extern void rtw_free_cmd_obj(struct cmd_obj *pcmd);
 
@@ -827,7 +827,7 @@ struct RunInThread_param
 
 u8 rtw_sitesurvey_cmd(struct adapter  *padapter, struct ndis_802_11_ssid *ssid, int ssid_num, struct rtw_ieee80211_channel *ch, int ch_num);
 extern u8 rtw_createbss_cmd(struct adapter  *padapter);
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags);
+int rtw_startbss_cmd(struct adapter  *padapter, int flags);
 
 struct sta_info;
 extern u8 rtw_setstakey_cmd(struct adapter  *padapter, struct sta_info *sta, u8 unicast_key, bool enqueue);
--

2.17.1

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20190320000125.8930-1-madhumithabiw%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

#4 lore raw
In reply to Julia Lawall
Quoted 23 lines · Julia Lawall
Quoted 5 lines · Madhumitha Prabakaran

Change type of local variable and return type of function rtw_startbss_cmd, as function's return type are defined for standard error codes. Change corresponding function declarations and call sites. Along with modifications, remove extern from the function declaration to maintain Linux kernel coding style.

The changes look good, but the log message isn't really ideal to understand what is going on.

You could start by stating what happens:

rtw_startbss_cmd can return the result of calling rtw_enqueue_cmd, which can return the result of calling _rtw_enqueue_cmd, but they all have different return types (u8, u32, and sint, respectively).

As all of these functions return error codes, change all the return types to int, in preparation for converting these functions to use standard kernel error codes.

Quoted 6 lines

In checking these changes, I also saw nearby the function rtw_cmd_filter. Currently that returns int and _SUCCESS and _FAIL. Given the name, it might make more sense for this function to return true in the _SUCCESS case and false in the _FAIL case, and thus to have a bool return type. The function also has a local variable called bAllow of type u8 that would be better off with the name allow and type bool. There is also a strange

Here, changing the local variable leads to change in rtw_enqueue_cmd, which leads to calling _rtw_enqueue_cmd. Everything need to be fixed. However, when change is made in 'allow', the logic goes wrong. i.e.
bool allow = false; this contradicts the comment statement in particular line.
"set to true to allow enqueuing cmd when hw_init_completed is false"
This follows to error in
if ((pcmdpriv->padapter->hw_init_completed == false && allow == false) Same goes in line no- 63,93,101,110.
I need suggestions here.

Quoted 97 lines

prototype of the function that is right above the definition of the function itself. This is not needed.

julia

Quoted 91 lines

Issue suggested by Coccinelle.

---
 drivers/staging/rtl8723bs/core/rtw_cmd.c      | 8 ++++----
 drivers/staging/rtl8723bs/include/cmd_osdep.h | 2 +-
 drivers/staging/rtl8723bs/include/rtw_cmd.h   | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
drivers/staging/rtl8723bs/core/rtw_cmd.c +4 -4
index bd3a5a23a418..04c6927dab8b 100644
@@ -256,7 +256,7 @@ ISR/Call-Back functions can't call this sub-function.
 
 */
 
-sint	_rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
 {
 	_irqL irqL;
 
@@ -331,7 +331,7 @@ int rtw_cmd_filter(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 
 
 
-u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 {
 	int res = _FAIL;
 	struct adapter *padapter = pcmdpriv->padapter;
@@ -719,12 +719,12 @@ u8 rtw_createbss_cmd(struct adapter  *padapter)
 	return res;
 }
 
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags)
+int rtw_startbss_cmd(struct adapter  *padapter, int flags)
 {
 	struct cmd_obj *pcmd;
 	struct cmd_priv  *pcmdpriv = &padapter->cmdpriv;
 	struct submit_ctx sctx;
-	u8 res = _SUCCESS;
+	int res = _SUCCESS;
 
 	if (flags & RTW_CMDF_DIRECTLY) {
 		/* no need to enqueue, do the cmd hdl directly and free cmd parameter */
drivers/staging/rtl8723bs/include/cmd_osdep.h +1 -1
index 06ab48263757..d3af9f44ad59 100644
@@ -12,7 +12,7 @@ int rtw_init_cmd_priv(struct	cmd_priv *pcmdpriv);
 int rtw_init_evt_priv(struct evt_priv *pevtpriv);
 extern void _rtw_free_evt_priv (struct	evt_priv *pevtpriv);
 extern void _rtw_free_cmd_priv (struct	cmd_priv *pcmdpriv);
-extern sint _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
 extern struct	cmd_obj	*_rtw_dequeue_cmd(struct __queue *queue);
 
 #endif
drivers/staging/rtl8723bs/include/rtw_cmd.h +2 -3
index fa4ebc3d7539..b83824ca2e31 100644
@@ -122,7 +122,7 @@ struct P2P_PS_CTWPeriod_t {
 	u8 CTWPeriod;	/* TU */
 };
 
-extern u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
 extern struct cmd_obj *rtw_dequeue_cmd(struct cmd_priv *pcmdpriv);
 extern void rtw_free_cmd_obj(struct cmd_obj *pcmd);
 
@@ -827,7 +827,7 @@ struct RunInThread_param
 
 u8 rtw_sitesurvey_cmd(struct adapter  *padapter, struct ndis_802_11_ssid *ssid, int ssid_num, struct rtw_ieee80211_channel *ch, int ch_num);
 extern u8 rtw_createbss_cmd(struct adapter  *padapter);
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags);
+int rtw_startbss_cmd(struct adapter  *padapter, int flags);
 
 struct sta_info;
 extern u8 rtw_setstakey_cmd(struct adapter  *padapter, struct sta_info *sta, u8 unicast_key, bool enqueue);
--

2.17.1

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20190320000125.8930-1-madhumithabiw%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

#5 lore raw
Quoted 31 lines · Madhumthia Prabakaran
Quoted 23 lines · Julia Lawall
Quoted 5 lines · Madhumitha Prabakaran

Change type of local variable and return type of function rtw_startbss_cmd, as function's return type are defined for standard error codes. Change corresponding function declarations and call sites. Along with modifications, remove extern from the function declaration to maintain Linux kernel coding style.

The changes look good, but the log message isn't really ideal to understand what is going on.

You could start by stating what happens:

rtw_startbss_cmd can return the result of calling rtw_enqueue_cmd, which can return the result of calling _rtw_enqueue_cmd, but they all have different return types (u8, u32, and sint, respectively).

As all of these functions return error codes, change all the return types to int, in preparation for converting these functions to use standard kernel error codes.

Quoted 6 lines

In checking these changes, I also saw nearby the function rtw_cmd_filter. Currently that returns int and _SUCCESS and _FAIL. Given the name, it might make more sense for this function to return true in the _SUCCESS case and false in the _FAIL case, and thus to have a bool return type. The function also has a local variable called bAllow of type u8 that would be better off with the name allow and type bool. There is also a strange

Quoted 11 lines

Here, changing the local variable leads to change in rtw_enqueue_cmd, which leads to calling _rtw_enqueue_cmd. Everything need to be fixed. However, when change is made in 'allow', the logic goes wrong. i.e.
bool allow = false; this contradicts the comment statement in particular line.
"set to true to allow enqueuing cmd when hw_init_completed is false"
This follows to error in
if ((pcmdpriv->padapter->hw_init_completed == false && allow == false) Same goes in line no- 63,93,101,110.
I need suggestions here.

I don't think you need to change anything about allow except the return type (u8 -> bool). rtw_cmd_filter can return true and false, independently of the value of allow. Then you have two call sites to fix up.

julia

Quoted 100 lines
Quoted 99 lines

prototype of the function that is right above the definition of the function itself. This is not needed.

julia

Quoted 91 lines

Issue suggested by Coccinelle.

---
 drivers/staging/rtl8723bs/core/rtw_cmd.c      | 8 ++++----
 drivers/staging/rtl8723bs/include/cmd_osdep.h | 2 +-
 drivers/staging/rtl8723bs/include/rtw_cmd.h   | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
drivers/staging/rtl8723bs/core/rtw_cmd.c +4 -4
index bd3a5a23a418..04c6927dab8b 100644
@@ -256,7 +256,7 @@ ISR/Call-Back functions can't call this sub-function.
 
 */
 
-sint	_rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
 {
 	_irqL irqL;
 
@@ -331,7 +331,7 @@ int rtw_cmd_filter(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 
 
 
-u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 {
 	int res = _FAIL;
 	struct adapter *padapter = pcmdpriv->padapter;
@@ -719,12 +719,12 @@ u8 rtw_createbss_cmd(struct adapter  *padapter)
 	return res;
 }
 
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags)
+int rtw_startbss_cmd(struct adapter  *padapter, int flags)
 {
 	struct cmd_obj *pcmd;
 	struct cmd_priv  *pcmdpriv = &padapter->cmdpriv;
 	struct submit_ctx sctx;
-	u8 res = _SUCCESS;
+	int res = _SUCCESS;
 
 	if (flags & RTW_CMDF_DIRECTLY) {
 		/* no need to enqueue, do the cmd hdl directly and free cmd parameter */
drivers/staging/rtl8723bs/include/cmd_osdep.h +1 -1
index 06ab48263757..d3af9f44ad59 100644
@@ -12,7 +12,7 @@ int rtw_init_cmd_priv(struct	cmd_priv *pcmdpriv);
 int rtw_init_evt_priv(struct evt_priv *pevtpriv);
 extern void _rtw_free_evt_priv (struct	evt_priv *pevtpriv);
 extern void _rtw_free_cmd_priv (struct	cmd_priv *pcmdpriv);
-extern sint _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
 extern struct	cmd_obj	*_rtw_dequeue_cmd(struct __queue *queue);
 
 #endif
drivers/staging/rtl8723bs/include/rtw_cmd.h +2 -3
index fa4ebc3d7539..b83824ca2e31 100644
@@ -122,7 +122,7 @@ struct P2P_PS_CTWPeriod_t {
 	u8 CTWPeriod;	/* TU */
 };
 
-extern u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
 extern struct cmd_obj *rtw_dequeue_cmd(struct cmd_priv *pcmdpriv);
 extern void rtw_free_cmd_obj(struct cmd_obj *pcmd);
 
@@ -827,7 +827,7 @@ struct RunInThread_param
 
 u8 rtw_sitesurvey_cmd(struct adapter  *padapter, struct ndis_802_11_ssid *ssid, int ssid_num, struct rtw_ieee80211_channel *ch, int ch_num);
 extern u8 rtw_createbss_cmd(struct adapter  *padapter);
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags);
+int rtw_startbss_cmd(struct adapter  *padapter, int flags);
 
 struct sta_info;
 extern u8 rtw_setstakey_cmd(struct adapter  *padapter, struct sta_info *sta, u8 unicast_key, bool enqueue);
--

2.17.1

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20190320000125.8930-1-madhumithabiw%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

#6 lore raw
Quoted 47 lines · Julia Lawall
Quoted 31 lines · Madhumthia Prabakaran
Quoted 23 lines · Julia Lawall
Quoted 5 lines · Madhumitha Prabakaran

Change type of local variable and return type of function rtw_startbss_cmd, as function's return type are defined for standard error codes. Change corresponding function declarations and call sites. Along with modifications, remove extern from the function declaration to maintain Linux kernel coding style.

The changes look good, but the log message isn't really ideal to understand what is going on.

You could start by stating what happens:

rtw_startbss_cmd can return the result of calling rtw_enqueue_cmd, which can return the result of calling _rtw_enqueue_cmd, but they all have different return types (u8, u32, and sint, respectively).

As all of these functions return error codes, change all the return types to int, in preparation for converting these functions to use standard kernel error codes.

Quoted 6 lines

In checking these changes, I also saw nearby the function rtw_cmd_filter. Currently that returns int and _SUCCESS and _FAIL. Given the name, it might make more sense for this function to return true in the _SUCCESS case and false in the _FAIL case, and thus to have a bool return type. The function also has a local variable called bAllow of type u8 that would be better off with the name allow and type bool. There is also a strange

Quoted 11 lines

Here, changing the local variable leads to change in rtw_enqueue_cmd, which leads to calling _rtw_enqueue_cmd. Everything need to be fixed. However, when change is made in 'allow', the logic goes wrong. i.e.
bool allow = false; this contradicts the comment statement in particular line.
"set to true to allow enqueuing cmd when hw_init_completed is false"
This follows to error in
if ((pcmdpriv->padapter->hw_init_completed == false && allow == false) Same goes in line no- 63,93,101,110.
I need suggestions here.

Quoted 4 lines

I don't think you need to change anything about allow except the return type (u8 -> bool). rtw_cmd_filter can return true and false, independently of the value of allow. Then you have two call sites to fix up.

However, backtracing from rtw_cmd_filter to rtw_enqueue_cmd leads to change for more than 50 functions to change. There are needs to change the function return type and local variable for return. I just want to make sure - Am I missing something?

Quoted 110 lines

julia

Quoted 100 lines
Quoted 99 lines

prototype of the function that is right above the definition of the function itself. This is not needed.

julia

Quoted 91 lines

Issue suggested by Coccinelle.

---
 drivers/staging/rtl8723bs/core/rtw_cmd.c      | 8 ++++----
 drivers/staging/rtl8723bs/include/cmd_osdep.h | 2 +-
 drivers/staging/rtl8723bs/include/rtw_cmd.h   | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
drivers/staging/rtl8723bs/core/rtw_cmd.c +4 -4
index bd3a5a23a418..04c6927dab8b 100644
@@ -256,7 +256,7 @@ ISR/Call-Back functions can't call this sub-function.
 
 */
 
-sint	_rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
 {
 	_irqL irqL;
 
@@ -331,7 +331,7 @@ int rtw_cmd_filter(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 
 
 
-u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *cmd_obj)
 {
 	int res = _FAIL;
 	struct adapter *padapter = pcmdpriv->padapter;
@@ -719,12 +719,12 @@ u8 rtw_createbss_cmd(struct adapter  *padapter)
 	return res;
 }
 
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags)
+int rtw_startbss_cmd(struct adapter  *padapter, int flags)
 {
 	struct cmd_obj *pcmd;
 	struct cmd_priv  *pcmdpriv = &padapter->cmdpriv;
 	struct submit_ctx sctx;
-	u8 res = _SUCCESS;
+	int res = _SUCCESS;
 
 	if (flags & RTW_CMDF_DIRECTLY) {
 		/* no need to enqueue, do the cmd hdl directly and free cmd parameter */
drivers/staging/rtl8723bs/include/cmd_osdep.h +1 -1
index 06ab48263757..d3af9f44ad59 100644
@@ -12,7 +12,7 @@ int rtw_init_cmd_priv(struct	cmd_priv *pcmdpriv);
 int rtw_init_evt_priv(struct evt_priv *pevtpriv);
 extern void _rtw_free_evt_priv (struct	evt_priv *pevtpriv);
 extern void _rtw_free_cmd_priv (struct	cmd_priv *pcmdpriv);
-extern sint _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
+int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj);
 extern struct	cmd_obj	*_rtw_dequeue_cmd(struct __queue *queue);
 
 #endif
drivers/staging/rtl8723bs/include/rtw_cmd.h +2 -3
index fa4ebc3d7539..b83824ca2e31 100644
@@ -122,7 +122,7 @@ struct P2P_PS_CTWPeriod_t {
 	u8 CTWPeriod;	/* TU */
 };
 
-extern u32 rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
+int rtw_enqueue_cmd(struct cmd_priv *pcmdpriv, struct cmd_obj *obj);
 extern struct cmd_obj *rtw_dequeue_cmd(struct cmd_priv *pcmdpriv);
 extern void rtw_free_cmd_obj(struct cmd_obj *pcmd);
 
@@ -827,7 +827,7 @@ struct RunInThread_param
 
 u8 rtw_sitesurvey_cmd(struct adapter  *padapter, struct ndis_802_11_ssid *ssid, int ssid_num, struct rtw_ieee80211_channel *ch, int ch_num);
 extern u8 rtw_createbss_cmd(struct adapter  *padapter);
-u8 rtw_startbss_cmd(struct adapter  *padapter, int flags);
+int rtw_startbss_cmd(struct adapter  *padapter, int flags);
 
 struct sta_info;
 extern u8 rtw_setstakey_cmd(struct adapter  *padapter, struct sta_info *sta, u8 unicast_key, bool enqueue);
--

2.17.1

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20190320000125.8930-1-madhumithabiw%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

Signature · 5 lines
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/alpine.DEB.2.21.1903202105290.2691%40hadrien.
For more options, visit https://groups.google.com/d/optout.