* [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
@ 2021-02-09 21:12 karthik alapati
2021-02-10 8:06 ` Dan Carpenter
0 siblings, 1 reply; 11+ messages in thread
From: karthik alapati @ 2021-02-09 21:12 UTC (permalink / raw)
To: Greg Kroah-Hartman, Stephen Rothwell; +Cc: devel, linux-kernel
fix checkpatch.pl warning for "block comments should align the
* on each line" and make function comments follow kernel-doc
Signed-off-by: karthik alapati <mail@karthek.com>
---
.../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 209 ++++++++----------
1 file changed, 91 insertions(+), 118 deletions(-)
diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
index cf23414d7..b7fca881c 100644
--- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
+++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
@@ -20,16 +20,11 @@
#define MAX_DOZE_WAITING_TIMES_9x 64
/**
-* Function: phy_CalculateBitShift
-*
-* OverView: Get shifted position of the BitMask
-*
-* Input:
-* u32 BitMask,
-*
-* Output: none
-* Return: u32 Return the shift bit bit position of the mask
-*/
+ * phy_CalculateBitShift - Get shifted position of the BitMask.
+ * @BitMask: Bitmask.
+ *
+ * Return: Return the shift bit position of the mask
+ */
static u32 phy_CalculateBitShift(u32 BitMask)
{
u32 i;
@@ -43,19 +38,17 @@ static u32 phy_CalculateBitShift(u32 BitMask)
/**
-* Function: PHY_QueryBBReg
-*
-* OverView: Read "specific bits" from BB register
-*
-* Input:
-* struct adapter * Adapter,
-* u32 RegAddr, The target address to be readback
-* u32 BitMask The target bit position in the target address
-* to be readback
-* Output: None
-* Return: u32 Data The readback register value
-* Note: This function is equal to "GetRegSetting" in PHY programming guide
-*/
+ * PHY_QueryBBReg - Read "specific bits" from BB register.
+ * @Adapter:
+ * @RegAddr: The target address to be readback
+ * @BitMask: The target bit position in the target address
+ * to be readback
+ *
+ * Return: The readback register value
+ *
+ * .. Note:: This function is equal to "GetRegSetting" in PHY programming
+ * guide
+ */
u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
{
u32 OriginalValue, BitShift;
@@ -64,7 +57,10 @@ u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
return 0;
#endif
- /* RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_QueryBBReg(): RegAddr(%#lx), BitMask(%#lx)\n", RegAddr, BitMask)); */
+ /**
+ * RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_QueryBBReg():
+ * RegAddr(%#lx), BitMask(%#lx)\n", RegAddr, BitMask));
+ */
OriginalValue = rtw_read32(Adapter, RegAddr);
BitShift = phy_CalculateBitShift(BitMask);
@@ -75,22 +71,17 @@ u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
/**
-* Function: PHY_SetBBReg
-*
-* OverView: Write "Specific bits" to BB register (page 8~)
-*
-* Input:
-* struct adapter * Adapter,
-* u32 RegAddr, The target address to be modified
-* u32 BitMask The target bit position in the target address
-* to be modified
-* u32 Data The new register value in the target bit position
-* of the target address
-*
-* Output: None
-* Return: None
-* Note: This function is equal to "PutRegSetting" in PHY programming guide
-*/
+ * PHY_SetBBReg - Write "Specific bits" to BB register (page 8~).
+ * @Adapter:
+ * @RegAddr: The target address to be modified
+ * @BitMask: The target bit position in the target address
+ * to be modified
+ * @Data: The new register value in the target bit position
+ * of the target address
+ *
+ * .. Note:: This function is equal to "PutRegSetting" in PHY programming
+ * guide
+ */
void PHY_SetBBReg_8723B(
struct adapter *Adapter,
@@ -106,7 +97,10 @@ void PHY_SetBBReg_8723B(
return;
#endif
- /* RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_SetBBReg(): RegAddr(%#lx), BitMask(%#lx), Data(%#lx)\n", RegAddr, BitMask, Data)); */
+ /**
+ * RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_SetBBReg():
+ * RegAddr(%#lx), BitMask(%#lx), Data(%#lx)\n", RegAddr, BitMask, Data));
+ */
if (BitMask != bMaskDWord) { /* if not "double word" write */
OriginalValue = rtw_read32(Adapter, RegAddr);
@@ -184,27 +178,21 @@ static u32 phy_RFSerialRead_8723B(
}
/**
-* Function: phy_RFSerialWrite_8723B
-*
-* OverView: Write data to RF register (page 8~)
-*
-* Input:
-* struct adapter * Adapter,
-* RF_PATH eRFPath, Radio path of A/B/C/D
-* u32 Offset, The target address to be read
-* u32 Data The new register Data in the target bit position
-* of the target to be read
-*
-* Output: None
-* Return: None
-* Note: Threre are three types of serial operations:
-* 1. Software serial write
-* 2. Hardware LSSI-Low Speed Serial Interface
-* 3. Hardware HSSI-High speed
-* serial write. Driver need to implement (1) and (2).
-* This function is equal to the combination of RF_ReadReg() and RFLSSIRead()
+ * phy_RFSerialWrite_8723B - Write data to RF register (page 8~).
+ * @Adapter:
+ * @eRFPath: Radio path of A/B/C/D
+ * @Offset: The target address to be read
+ * @Data: The new register Data in the target bit position
+ * of the target to be read
+ *
+ * .. Note:: Threre are three types of serial operations:
+ * 1. Software serial write
+ * 2. Hardware LSSI-Low Speed Serial Interface
+ * 3. Hardware HSSI-High speed
+ * serial write. Driver need to implement (1) and (2).
+ * This function is equal to the combination of RF_ReadReg() and RFLSSIRead()
*
- * Note: For RF8256 only
+ * .. Note:: For RF8256 only
* The total count of RTL8256(Zebra4) register is around 36 bit it only employs
* 4-bit RF address. RTL8256 uses "register mode control bit" (Reg00[12], Reg00[10])
* to access register address bigger than 0xf. See "Appendix-4 in PHY Configuration
@@ -225,7 +213,7 @@ static u32 phy_RFSerialRead_8723B(
*
*
*
-*/
+ */
static void phy_RFSerialWrite_8723B(
struct adapter *Adapter,
enum RF_PATH eRFPath,
@@ -249,33 +237,33 @@ static void phy_RFSerialWrite_8723B(
/* Put write addr in [5:0] and write data in [31:16] */
/* */
/* DataAndAddr = (Data<<16) | (NewOffset&0x3f); */
- DataAndAddr = ((NewOffset<<20) | (Data&0x000fffff)) & 0x0fffffff; /* T65 RF */
+ DataAndAddr = ((NewOffset<<20) | (Data&0x000fffff)) & 0x0fffffff;
+ /*T65 RF */
/* */
/* Write Operation */
/* */
PHY_SetBBReg(Adapter, pPhyReg->rf3wireOffset, bMaskDWord, DataAndAddr);
- /* RTPRINT(FPHY, PHY_RFW, ("RFW-%d Addr[0x%lx]= 0x%lx\n", eRFPath, pPhyReg->rf3wireOffset, DataAndAddr)); */
+ /**
+ *RTPRINT(FPHY, PHY_RFW, ("RFW-%d Addr[0x%lx]= 0x%lx\n", eRFPath,
+ *pPhyReg->rf3wireOffset, DataAndAddr));
+ */
}
/**
-* Function: PHY_QueryRFReg
-*
-* OverView: Query "Specific bits" to RF register (page 8~)
-*
-* Input:
-* struct adapter * Adapter,
-* RF_PATH eRFPath, Radio path of A/B/C/D
-* u32 RegAddr, The target address to be read
-* u32 BitMask The target bit position in the target address
-* to be read
-*
-* Output: None
-* Return: u32 Readback value
-* Note: This function is equal to "GetRFRegSetting" in PHY programming guide
-*/
+ * PHY_QueryRFReg - Query "Specific bits" to RF register (page 8~).
+ * @Adapter:
+ * @eRFPath: Radio path of A/B/C/D
+ * @RegAdd: The target address to be read
+ * @BitMask: The target bit position in the target address
+ * to be read
+ *
+ * Return: Readback value
+ *
+ * .. Note:: This function is equal to "GetRFRegSetting" in PHY programming guide
+ */
u32 PHY_QueryRFReg_8723B(
struct adapter *Adapter,
u8 eRFPath,
@@ -296,23 +284,17 @@ u32 PHY_QueryRFReg_8723B(
}
/**
-* Function: PHY_SetRFReg
-*
-* OverView: Write "Specific bits" to RF register (page 8~)
-*
-* Input:
-* struct adapter * Adapter,
-* RF_PATH eRFPath, Radio path of A/B/C/D
-* u32 RegAddr, The target address to be modified
-* u32 BitMask The target bit position in the target address
-* to be modified
-* u32 Data The new register Data in the target bit position
-* of the target address
-*
-* Output: None
-* Return: None
-* Note: This function is equal to "PutRFRegSetting" in PHY programming guide
-*/
+ * PHY_SetRFReg - Write "Specific bits" to RF register (page 8~).
+ * @Adapter:
+ * @eRFPath: Radio path of A/B/C/D
+ * @RegAddr: The target address to be modified
+ * @BitMask: The target bit position in the target address
+ * to be modified
+ * @Data: The new register Data in the target bit position
+ * of the target address
+ *
+ * .. Note:: This function is equal to "PutRFRegSetting" in PHY programming guide
+ */
void PHY_SetRFReg_8723B(
struct adapter *Adapter,
u8 eRFPath,
@@ -344,15 +326,7 @@ void PHY_SetRFReg_8723B(
/*-----------------------------------------------------------------------------
- * Function: PHY_MACConfig8192C
- *
- * Overview: Condig MAC by header file or parameter file.
- *
- * Input: NONE
- *
- * Output: NONE
- *
- * Return: NONE
+ * PHY_MACConfig8192C - Condig MAC by header file or parameter file.
*
* Revised History:
* When Who Remark
@@ -369,17 +343,12 @@ s32 PHY_MACConfig8723B(struct adapter *Adapter)
}
/**
-* Function: phy_InitBBRFRegisterDefinition
-*
-* OverView: Initialize Register definition offset for Radio Path A/B/C/D
-*
-* Input:
-* struct adapter * Adapter,
-*
-* Output: None
-* Return: None
-* Note: The initialization value is constant and it should never be changes
-*/
+ * phy_InitBBRFRegisterDefinition - Initialize Register definition offset for
+ * Radio Path A/B/C/D
+ * @Adapter:
+ *
+ * .. Note:: The initialization value is constant and it should never be changes
+ */
static void phy_InitBBRFRegisterDefinition(struct adapter *Adapter)
{
struct hal_com_data *pHalData = GET_HAL_DATA(Adapter);
@@ -675,6 +644,7 @@ static void phy_SetRegBW_8723B(
)
{
u16 RegRfMod_BW, u2tmp = 0;
+
RegRfMod_BW = rtw_read16(Adapter, REG_TRXPTCL_CTL_8723B);
switch (CurrentBW) {
@@ -789,7 +759,7 @@ static void phy_PostSetBwMode8723B(struct adapter *Adapter)
PHY_SetBBReg(Adapter, rFPGA1_RFMOD, bRFMOD, 0x0);
-/* PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
+ /*PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
PHY_SetBBReg(Adapter, rOFDM0_TxPseudoNoiseWgt, (BIT31|BIT30), 0x0);
break;
@@ -800,7 +770,10 @@ static void phy_PostSetBwMode8723B(struct adapter *Adapter)
PHY_SetBBReg(Adapter, rFPGA1_RFMOD, bRFMOD, 0x1);
- /* Set Control channel to upper or lower. These settings are required only for 40MHz */
+ /**
+ * Set Control channel to upper or lower. These settings are required
+ * only for 40MHz
+ */
PHY_SetBBReg(Adapter, rCCK0_System, bCCKSideBand, (pHalData->nCur40MhzPrimeSC>>1));
PHY_SetBBReg(Adapter, rOFDM1_LSTF, 0xC00, pHalData->nCur40MhzPrimeSC);
--
2.30.0
^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
2021-02-09 21:12 [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc karthik alapati
@ 2021-02-10 8:06 ` Dan Carpenter
2021-02-10 8:58 ` karthek
0 siblings, 1 reply; 11+ messages in thread
From: Dan Carpenter @ 2021-02-10 8:06 UTC (permalink / raw)
To: karthik alapati; +Cc: Greg Kroah-Hartman, Stephen Rothwell, devel, linux-kernel
On Wed, Feb 10, 2021 at 02:42:30AM +0530, karthik alapati wrote:
> fix checkpatch.pl warning for "block comments should align the
> * on each line" and make function comments follow kernel-doc
>
> Signed-off-by: karthik alapati <mail@karthek.com>
> ---
> .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 209 ++++++++----------
> 1 file changed, 91 insertions(+), 118 deletions(-)
>
> diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> index cf23414d7..b7fca881c 100644
> --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> @@ -20,16 +20,11 @@
> #define MAX_DOZE_WAITING_TIMES_9x 64
>
> /**
> -* Function: phy_CalculateBitShift
> -*
> -* OverView: Get shifted position of the BitMask
> -*
> -* Input:
> -* u32 BitMask,
> -*
> -* Output: none
> -* Return: u32 Return the shift bit bit position of the mask
> -*/
> + * phy_CalculateBitShift - Get shifted position of the BitMask.
> + * @BitMask: Bitmask.
> + *
> + * Return: Return the shift bit position of the mask
> + */
> static u32 phy_CalculateBitShift(u32 BitMask)
> {
> u32 i;
> @@ -43,19 +38,17 @@ static u32 phy_CalculateBitShift(u32 BitMask)
>
>
> /**
> -* Function: PHY_QueryBBReg
> -*
> -* OverView: Read "specific bits" from BB register
> -*
> -* Input:
> -* struct adapter * Adapter,
> -* u32 RegAddr, The target address to be readback
> -* u32 BitMask The target bit position in the target address
> -* to be readback
> -* Output: None
> -* Return: u32 Data The readback register value
> -* Note: This function is equal to "GetRegSetting" in PHY programming guide
> -*/
> + * PHY_QueryBBReg - Read "specific bits" from BB register.
> + * @Adapter:
> + * @RegAddr: The target address to be readback
> + * @BitMask: The target bit position in the target address
> + * to be readback
> + *
> + * Return: The readback register value
> + *
> + * .. Note:: This function is equal to "GetRegSetting" in PHY programming
> + * guide
> + */
> u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
> {
> u32 OriginalValue, BitShift;
> @@ -64,7 +57,10 @@ u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
> return 0;
> #endif
>
> - /* RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_QueryBBReg(): RegAddr(%#lx), BitMask(%#lx)\n", RegAddr, BitMask)); */
> + /**
> + * RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_QueryBBReg():
> + * RegAddr(%#lx), BitMask(%#lx)\n", RegAddr, BitMask));
> + */
Just delete this (in a separate patch).
>
> OriginalValue = rtw_read32(Adapter, RegAddr);
> BitShift = phy_CalculateBitShift(BitMask);
> @@ -75,22 +71,17 @@ u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
>
>
> /**
> -* Function: PHY_SetBBReg
> -*
> -* OverView: Write "Specific bits" to BB register (page 8~)
> -*
> -* Input:
> -* struct adapter * Adapter,
> -* u32 RegAddr, The target address to be modified
> -* u32 BitMask The target bit position in the target address
> -* to be modified
> -* u32 Data The new register value in the target bit position
> -* of the target address
> -*
> -* Output: None
> -* Return: None
> -* Note: This function is equal to "PutRegSetting" in PHY programming guide
> -*/
> + * PHY_SetBBReg - Write "Specific bits" to BB register (page 8~).
> + * @Adapter:
> + * @RegAddr: The target address to be modified
> + * @BitMask: The target bit position in the target address
> + * to be modified
> + * @Data: The new register value in the target bit position
> + * of the target address
> + *
> + * .. Note:: This function is equal to "PutRegSetting" in PHY programming
> + * guide
> + */
>
> void PHY_SetBBReg_8723B(
> struct adapter *Adapter,
> @@ -106,7 +97,10 @@ void PHY_SetBBReg_8723B(
> return;
> #endif
>
> - /* RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_SetBBReg(): RegAddr(%#lx), BitMask(%#lx), Data(%#lx)\n", RegAddr, BitMask, Data)); */
> + /**
> + * RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_SetBBReg():
> + * RegAddr(%#lx), BitMask(%#lx), Data(%#lx)\n", RegAddr, BitMask, Data));
> + */
Delete.
>
> if (BitMask != bMaskDWord) { /* if not "double word" write */
> OriginalValue = rtw_read32(Adapter, RegAddr);
> @@ -184,27 +178,21 @@ static u32 phy_RFSerialRead_8723B(
> }
>
> /**
> -* Function: phy_RFSerialWrite_8723B
> -*
> -* OverView: Write data to RF register (page 8~)
> -*
> -* Input:
> -* struct adapter * Adapter,
> -* RF_PATH eRFPath, Radio path of A/B/C/D
> -* u32 Offset, The target address to be read
> -* u32 Data The new register Data in the target bit position
> -* of the target to be read
> -*
> -* Output: None
> -* Return: None
> -* Note: Threre are three types of serial operations:
> -* 1. Software serial write
> -* 2. Hardware LSSI-Low Speed Serial Interface
> -* 3. Hardware HSSI-High speed
> -* serial write. Driver need to implement (1) and (2).
> -* This function is equal to the combination of RF_ReadReg() and RFLSSIRead()
> + * phy_RFSerialWrite_8723B - Write data to RF register (page 8~).
> + * @Adapter:
> + * @eRFPath: Radio path of A/B/C/D
> + * @Offset: The target address to be read
> + * @Data: The new register Data in the target bit position
> + * of the target to be read
> + *
> + * .. Note:: Threre are three types of serial operations:
> + * 1. Software serial write
> + * 2. Hardware LSSI-Low Speed Serial Interface
> + * 3. Hardware HSSI-High speed
> + * serial write. Driver need to implement (1) and (2).
> + * This function is equal to the combination of RF_ReadReg() and RFLSSIRead()
> *
> - * Note: For RF8256 only
> + * .. Note:: For RF8256 only
> * The total count of RTL8256(Zebra4) register is around 36 bit it only employs
> * 4-bit RF address. RTL8256 uses "register mode control bit" (Reg00[12], Reg00[10])
> * to access register address bigger than 0xf. See "Appendix-4 in PHY Configuration
> @@ -225,7 +213,7 @@ static u32 phy_RFSerialRead_8723B(
> *
> *
> *
> -*/
> + */
> static void phy_RFSerialWrite_8723B(
> struct adapter *Adapter,
> enum RF_PATH eRFPath,
> @@ -249,33 +237,33 @@ static void phy_RFSerialWrite_8723B(
> /* Put write addr in [5:0] and write data in [31:16] */
> /* */
> /* DataAndAddr = (Data<<16) | (NewOffset&0x3f); */
> - DataAndAddr = ((NewOffset<<20) | (Data&0x000fffff)) & 0x0fffffff; /* T65 RF */
> + DataAndAddr = ((NewOffset<<20) | (Data&0x000fffff)) & 0x0fffffff;
> + /*T65 RF */
This doesn't make sense at all now.
>
> /* */
> /* Write Operation */
> /* */
> PHY_SetBBReg(Adapter, pPhyReg->rf3wireOffset, bMaskDWord, DataAndAddr);
> - /* RTPRINT(FPHY, PHY_RFW, ("RFW-%d Addr[0x%lx]= 0x%lx\n", eRFPath, pPhyReg->rf3wireOffset, DataAndAddr)); */
> + /**
> + *RTPRINT(FPHY, PHY_RFW, ("RFW-%d Addr[0x%lx]= 0x%lx\n", eRFPath,
> + *pPhyReg->rf3wireOffset, DataAndAddr));
> + */
Delete.
>
> }
>
>
> /**
> -* Function: PHY_QueryRFReg
> -*
> -* OverView: Query "Specific bits" to RF register (page 8~)
> -*
> -* Input:
> -* struct adapter * Adapter,
> -* RF_PATH eRFPath, Radio path of A/B/C/D
> -* u32 RegAddr, The target address to be read
> -* u32 BitMask The target bit position in the target address
> -* to be read
> -*
> -* Output: None
> -* Return: u32 Readback value
> -* Note: This function is equal to "GetRFRegSetting" in PHY programming guide
> -*/
> + * PHY_QueryRFReg - Query "Specific bits" to RF register (page 8~).
> + * @Adapter:
> + * @eRFPath: Radio path of A/B/C/D
> + * @RegAdd: The target address to be read
> + * @BitMask: The target bit position in the target address
> + * to be read
> + *
> + * Return: Readback value
> + *
> + * .. Note:: This function is equal to "GetRFRegSetting" in PHY programming guide
> + */
> u32 PHY_QueryRFReg_8723B(
> struct adapter *Adapter,
> u8 eRFPath,
> @@ -296,23 +284,17 @@ u32 PHY_QueryRFReg_8723B(
> }
>
> /**
> -* Function: PHY_SetRFReg
> -*
> -* OverView: Write "Specific bits" to RF register (page 8~)
> -*
> -* Input:
> -* struct adapter * Adapter,
> -* RF_PATH eRFPath, Radio path of A/B/C/D
> -* u32 RegAddr, The target address to be modified
> -* u32 BitMask The target bit position in the target address
> -* to be modified
> -* u32 Data The new register Data in the target bit position
> -* of the target address
> -*
> -* Output: None
> -* Return: None
> -* Note: This function is equal to "PutRFRegSetting" in PHY programming guide
> -*/
> + * PHY_SetRFReg - Write "Specific bits" to RF register (page 8~).
> + * @Adapter:
> + * @eRFPath: Radio path of A/B/C/D
> + * @RegAddr: The target address to be modified
> + * @BitMask: The target bit position in the target address
> + * to be modified
> + * @Data: The new register Data in the target bit position
> + * of the target address
> + *
> + * .. Note:: This function is equal to "PutRFRegSetting" in PHY programming guide
Don't put a huge white space after the ::.
regards,
dan carpenter
> + */
> void PHY_SetRFReg_8723B(
> struct adapter *Adapter,
> u8 eRFPath,
> @@ -344,15 +326,7 @@ void PHY_SetRFReg_8723B(
>
>
> /*-----------------------------------------------------------------------------
> - * Function: PHY_MACConfig8192C
> - *
> - * Overview: Condig MAC by header file or parameter file.
> - *
> - * Input: NONE
> - *
> - * Output: NONE
> - *
> - * Return: NONE
> + * PHY_MACConfig8192C - Condig MAC by header file or parameter file.
> *
> * Revised History:
> * When Who Remark
> @@ -369,17 +343,12 @@ s32 PHY_MACConfig8723B(struct adapter *Adapter)
> }
>
> /**
> -* Function: phy_InitBBRFRegisterDefinition
> -*
> -* OverView: Initialize Register definition offset for Radio Path A/B/C/D
> -*
> -* Input:
> -* struct adapter * Adapter,
> -*
> -* Output: None
> -* Return: None
> -* Note: The initialization value is constant and it should never be changes
> -*/
> + * phy_InitBBRFRegisterDefinition - Initialize Register definition offset for
> + * Radio Path A/B/C/D
> + * @Adapter:
> + *
> + * .. Note:: The initialization value is constant and it should never be changes
> + */
> static void phy_InitBBRFRegisterDefinition(struct adapter *Adapter)
> {
> struct hal_com_data *pHalData = GET_HAL_DATA(Adapter);
> @@ -675,6 +644,7 @@ static void phy_SetRegBW_8723B(
> )
> {
> u16 RegRfMod_BW, u2tmp = 0;
> +
This is not related to comments. Do it in a separate patch.
> RegRfMod_BW = rtw_read16(Adapter, REG_TRXPTCL_CTL_8723B);
>
> switch (CurrentBW) {
> @@ -789,7 +759,7 @@ static void phy_PostSetBwMode8723B(struct adapter *Adapter)
>
> PHY_SetBBReg(Adapter, rFPGA1_RFMOD, bRFMOD, 0x0);
>
> -/* PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
> + /*PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
This format is wrong. Anyway, just delete the commented out code.
regards,
dan carpenter
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
2021-02-10 8:06 ` Dan Carpenter
@ 2021-02-10 8:58 ` karthek
2021-02-10 9:01 ` Dan Carpenter
0 siblings, 1 reply; 11+ messages in thread
From: karthek @ 2021-02-10 8:58 UTC (permalink / raw)
To: Dan Carpenter; +Cc: Greg Kroah-Hartman, Stephen Rothwell, devel, linux-kernel
On Wed, Feb 10, 2021 at 1:37 PM Dan Carpenter <dan.carpenter@oracle.com> wrote:
>
> On Wed, Feb 10, 2021 at 02:42:30AM +0530, karthik alapati wrote:
> > fix checkpatch.pl warning for "block comments should align the
> > * on each line" and make function comments follow kernel-doc
> >
> > Signed-off-by: karthik alapati <mail@karthek.com>
> > ---
> > .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 209 ++++++++----------
> > 1 file changed, 91 insertions(+), 118 deletions(-)
> >
> > diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > index cf23414d7..b7fca881c 100644
> > --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > @@ -20,16 +20,11 @@
> > #define MAX_DOZE_WAITING_TIMES_9x 64
> >
> > /**
> > -* Function: phy_CalculateBitShift
> > -*
> > -* OverView: Get shifted position of the BitMask
> > -*
> > -* Input:
> > -* u32 BitMask,
> > -*
> > -* Output: none
> > -* Return: u32 Return the shift bit bit position of the mask
> > -*/
> > + * phy_CalculateBitShift - Get shifted position of the BitMask.
> > + * @BitMask: Bitmask.
> > + *
> > + * Return: Return the shift bit position of the mask
> > + */
> > static u32 phy_CalculateBitShift(u32 BitMask)
> > {
> > u32 i;
> > @@ -43,19 +38,17 @@ static u32 phy_CalculateBitShift(u32 BitMask)
> >
> >
> > /**
> > -* Function: PHY_QueryBBReg
> > -*
> > -* OverView: Read "specific bits" from BB register
> > -*
> > -* Input:
> > -* struct adapter * Adapter,
> > -* u32 RegAddr, The target address to be readback
> > -* u32 BitMask The target bit position in the target address
> > -* to be readback
> > -* Output: None
> > -* Return: u32 Data The readback register value
> > -* Note: This function is equal to "GetRegSetting" in PHY programming guide
> > -*/
> > + * PHY_QueryBBReg - Read "specific bits" from BB register.
> > + * @Adapter:
> > + * @RegAddr: The target address to be readback
> > + * @BitMask: The target bit position in the target address
> > + * to be readback
> > + *
> > + * Return: The readback register value
> > + *
> > + * .. Note:: This function is equal to "GetRegSetting" in PHY programming
> > + * guide
> > + */
> > u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
> > {
> > u32 OriginalValue, BitShift;
> > @@ -64,7 +57,10 @@ u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
> > return 0;
> > #endif
> >
> > - /* RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_QueryBBReg(): RegAddr(%#lx), BitMask(%#lx)\n", RegAddr, BitMask)); */
> > + /**
> > + * RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_QueryBBReg():
> > + * RegAddr(%#lx), BitMask(%#lx)\n", RegAddr, BitMask));
> > + */
>
> Just delete this (in a separate patch).
>
> >
> > OriginalValue = rtw_read32(Adapter, RegAddr);
> > BitShift = phy_CalculateBitShift(BitMask);
> > @@ -75,22 +71,17 @@ u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
> >
> >
> > /**
> > -* Function: PHY_SetBBReg
> > -*
> > -* OverView: Write "Specific bits" to BB register (page 8~)
> > -*
> > -* Input:
> > -* struct adapter * Adapter,
> > -* u32 RegAddr, The target address to be modified
> > -* u32 BitMask The target bit position in the target address
> > -* to be modified
> > -* u32 Data The new register value in the target bit position
> > -* of the target address
> > -*
> > -* Output: None
> > -* Return: None
> > -* Note: This function is equal to "PutRegSetting" in PHY programming guide
> > -*/
> > + * PHY_SetBBReg - Write "Specific bits" to BB register (page 8~).
> > + * @Adapter:
> > + * @RegAddr: The target address to be modified
> > + * @BitMask: The target bit position in the target address
> > + * to be modified
> > + * @Data: The new register value in the target bit position
> > + * of the target address
> > + *
> > + * .. Note:: This function is equal to "PutRegSetting" in PHY programming
> > + * guide
> > + */
> >
> > void PHY_SetBBReg_8723B(
> > struct adapter *Adapter,
> > @@ -106,7 +97,10 @@ void PHY_SetBBReg_8723B(
> > return;
> > #endif
> >
> > - /* RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_SetBBReg(): RegAddr(%#lx), BitMask(%#lx), Data(%#lx)\n", RegAddr, BitMask, Data)); */
> > + /**
> > + * RT_TRACE(COMP_RF, DBG_TRACE, ("--->PHY_SetBBReg():
> > + * RegAddr(%#lx), BitMask(%#lx), Data(%#lx)\n", RegAddr, BitMask, Data));
> > + */
>
> Delete.
>
> >
> > if (BitMask != bMaskDWord) { /* if not "double word" write */
> > OriginalValue = rtw_read32(Adapter, RegAddr);
> > @@ -184,27 +178,21 @@ static u32 phy_RFSerialRead_8723B(
> > }
> >
> > /**
> > -* Function: phy_RFSerialWrite_8723B
> > -*
> > -* OverView: Write data to RF register (page 8~)
> > -*
> > -* Input:
> > -* struct adapter * Adapter,
> > -* RF_PATH eRFPath, Radio path of A/B/C/D
> > -* u32 Offset, The target address to be read
> > -* u32 Data The new register Data in the target bit position
> > -* of the target to be read
> > -*
> > -* Output: None
> > -* Return: None
> > -* Note: Threre are three types of serial operations:
> > -* 1. Software serial write
> > -* 2. Hardware LSSI-Low Speed Serial Interface
> > -* 3. Hardware HSSI-High speed
> > -* serial write. Driver need to implement (1) and (2).
> > -* This function is equal to the combination of RF_ReadReg() and RFLSSIRead()
> > + * phy_RFSerialWrite_8723B - Write data to RF register (page 8~).
> > + * @Adapter:
> > + * @eRFPath: Radio path of A/B/C/D
> > + * @Offset: The target address to be read
> > + * @Data: The new register Data in the target bit position
> > + * of the target to be read
> > + *
> > + * .. Note:: Threre are three types of serial operations:
> > + * 1. Software serial write
> > + * 2. Hardware LSSI-Low Speed Serial Interface
> > + * 3. Hardware HSSI-High speed
> > + * serial write. Driver need to implement (1) and (2).
> > + * This function is equal to the combination of RF_ReadReg() and RFLSSIRead()
> > *
> > - * Note: For RF8256 only
> > + * .. Note:: For RF8256 only
> > * The total count of RTL8256(Zebra4) register is around 36 bit it only employs
> > * 4-bit RF address. RTL8256 uses "register mode control bit" (Reg00[12], Reg00[10])
> > * to access register address bigger than 0xf. See "Appendix-4 in PHY Configuration
> > @@ -225,7 +213,7 @@ static u32 phy_RFSerialRead_8723B(
> > *
> > *
> > *
> > -*/
> > + */
> > static void phy_RFSerialWrite_8723B(
> > struct adapter *Adapter,
> > enum RF_PATH eRFPath,
> > @@ -249,33 +237,33 @@ static void phy_RFSerialWrite_8723B(
> > /* Put write addr in [5:0] and write data in [31:16] */
> > /* */
> > /* DataAndAddr = (Data<<16) | (NewOffset&0x3f); */
> > - DataAndAddr = ((NewOffset<<20) | (Data&0x000fffff)) & 0x0fffffff; /* T65 RF */
> > + DataAndAddr = ((NewOffset<<20) | (Data&0x000fffff)) & 0x0fffffff;
> > + /*T65 RF */
>
> This doesn't make sense at all now.
>
> >
> > /* */
> > /* Write Operation */
> > /* */
> > PHY_SetBBReg(Adapter, pPhyReg->rf3wireOffset, bMaskDWord, DataAndAddr);
> > - /* RTPRINT(FPHY, PHY_RFW, ("RFW-%d Addr[0x%lx]= 0x%lx\n", eRFPath, pPhyReg->rf3wireOffset, DataAndAddr)); */
> > + /**
> > + *RTPRINT(FPHY, PHY_RFW, ("RFW-%d Addr[0x%lx]= 0x%lx\n", eRFPath,
> > + *pPhyReg->rf3wireOffset, DataAndAddr));
> > + */
>
> Delete.
>
> >
> > }
> >
> >
> > /**
> > -* Function: PHY_QueryRFReg
> > -*
> > -* OverView: Query "Specific bits" to RF register (page 8~)
> > -*
> > -* Input:
> > -* struct adapter * Adapter,
> > -* RF_PATH eRFPath, Radio path of A/B/C/D
> > -* u32 RegAddr, The target address to be read
> > -* u32 BitMask The target bit position in the target address
> > -* to be read
> > -*
> > -* Output: None
> > -* Return: u32 Readback value
> > -* Note: This function is equal to "GetRFRegSetting" in PHY programming guide
> > -*/
> > + * PHY_QueryRFReg - Query "Specific bits" to RF register (page 8~).
> > + * @Adapter:
> > + * @eRFPath: Radio path of A/B/C/D
> > + * @RegAdd: The target address to be read
> > + * @BitMask: The target bit position in the target address
> > + * to be read
> > + *
> > + * Return: Readback value
> > + *
> > + * .. Note:: This function is equal to "GetRFRegSetting" in PHY programming guide
> > + */
> > u32 PHY_QueryRFReg_8723B(
> > struct adapter *Adapter,
> > u8 eRFPath,
> > @@ -296,23 +284,17 @@ u32 PHY_QueryRFReg_8723B(
> > }
> >
> > /**
> > -* Function: PHY_SetRFReg
> > -*
> > -* OverView: Write "Specific bits" to RF register (page 8~)
> > -*
> > -* Input:
> > -* struct adapter * Adapter,
> > -* RF_PATH eRFPath, Radio path of A/B/C/D
> > -* u32 RegAddr, The target address to be modified
> > -* u32 BitMask The target bit position in the target address
> > -* to be modified
> > -* u32 Data The new register Data in the target bit position
> > -* of the target address
> > -*
> > -* Output: None
> > -* Return: None
> > -* Note: This function is equal to "PutRFRegSetting" in PHY programming guide
> > -*/
> > + * PHY_SetRFReg - Write "Specific bits" to RF register (page 8~).
> > + * @Adapter:
> > + * @eRFPath: Radio path of A/B/C/D
> > + * @RegAddr: The target address to be modified
> > + * @BitMask: The target bit position in the target address
> > + * to be modified
> > + * @Data: The new register Data in the target bit position
> > + * of the target address
> > + *
> > + * .. Note:: This function is equal to "PutRFRegSetting" in PHY programming guide
>
>
> Don't put a huge white space after the ::.
>
> regards,
> dan carpenter
>
> > + */
> > void PHY_SetRFReg_8723B(
> > struct adapter *Adapter,
> > u8 eRFPath,
> > @@ -344,15 +326,7 @@ void PHY_SetRFReg_8723B(
> >
> >
> > /*-----------------------------------------------------------------------------
> > - * Function: PHY_MACConfig8192C
> > - *
> > - * Overview: Condig MAC by header file or parameter file.
> > - *
> > - * Input: NONE
> > - *
> > - * Output: NONE
> > - *
> > - * Return: NONE
> > + * PHY_MACConfig8192C - Condig MAC by header file or parameter file.
> > *
> > * Revised History:
> > * When Who Remark
> > @@ -369,17 +343,12 @@ s32 PHY_MACConfig8723B(struct adapter *Adapter)
> > }
> >
> > /**
> > -* Function: phy_InitBBRFRegisterDefinition
> > -*
> > -* OverView: Initialize Register definition offset for Radio Path A/B/C/D
> > -*
> > -* Input:
> > -* struct adapter * Adapter,
> > -*
> > -* Output: None
> > -* Return: None
> > -* Note: The initialization value is constant and it should never be changes
> > -*/
> > + * phy_InitBBRFRegisterDefinition - Initialize Register definition offset for
> > + * Radio Path A/B/C/D
> > + * @Adapter:
> > + *
> > + * .. Note:: The initialization value is constant and it should never be changes
> > + */
> > static void phy_InitBBRFRegisterDefinition(struct adapter *Adapter)
> > {
> > struct hal_com_data *pHalData = GET_HAL_DATA(Adapter);
> > @@ -675,6 +644,7 @@ static void phy_SetRegBW_8723B(
> > )
> > {
> > u16 RegRfMod_BW, u2tmp = 0;
> > +
>
>
> This is not related to comments. Do it in a separate patch.
>
> > RegRfMod_BW = rtw_read16(Adapter, REG_TRXPTCL_CTL_8723B);
> >
> > switch (CurrentBW) {
> > @@ -789,7 +759,7 @@ static void phy_PostSetBwMode8723B(struct adapter *Adapter)
> >
> > PHY_SetBBReg(Adapter, rFPGA1_RFMOD, bRFMOD, 0x0);
> >
> > -/* PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
> > + /*PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
>
> This format is wrong. Anyway, just delete the commented out code.
>
> regards,
> dan carpenter
>
how can i delete that, i have no idea what this driver does
i'm just fixing coding style issues for eudyptula challenge.
i dont think its a good idea to delete the code without knowing its
purpose even though its commented out
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
2021-02-10 8:58 ` karthek
@ 2021-02-10 9:01 ` Dan Carpenter
[not found] ` <CAJ5zXr1OW+RfNNuXOZDjUvm=EKz5C9=GPc243z3Wk_qc3N=6sQ@mail.gmail.com>
0 siblings, 1 reply; 11+ messages in thread
From: Dan Carpenter @ 2021-02-10 9:01 UTC (permalink / raw)
To: karthek; +Cc: Greg Kroah-Hartman, Stephen Rothwell, devel, linux-kernel
On Wed, Feb 10, 2021 at 02:28:31PM +0530, karthek wrote:
> On Wed, Feb 10, 2021 at 1:37 PM Dan Carpenter <dan.carpenter@oracle.com> wrote:
> > > @@ -789,7 +759,7 @@ static void phy_PostSetBwMode8723B(struct adapter *Adapter)
> > >
> > > PHY_SetBBReg(Adapter, rFPGA1_RFMOD, bRFMOD, 0x0);
> > >
> > > -/* PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
> > > + /*PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
> >
> > This format is wrong. Anyway, just delete the commented out code.
> >
> > regards,
> > dan carpenter
> >
>
> how can i delete that, i have no idea what this driver does
> i'm just fixing coding style issues for eudyptula challenge.
> i dont think its a good idea to delete the code without knowing its
> purpose even though its commented out
Commented code obviously doesn't do anything at all?
regards,
dan carpenter
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
[not found] ` <CAJ5zXr1OW+RfNNuXOZDjUvm=EKz5C9=GPc243z3Wk_qc3N=6sQ@mail.gmail.com>
@ 2021-02-10 9:27 ` karthek
2021-02-10 12:06 ` Dan Carpenter
1 sibling, 0 replies; 11+ messages in thread
From: karthek @ 2021-02-10 9:27 UTC (permalink / raw)
To: Dan Carpenter; +Cc: Greg Kroah-Hartman, Stephen Rothwell, devel, linux-kernel
On Wed, Feb 10, 2021 at 02:38:28PM +0530, karthek wrote:
> On Wed, Feb 10, 2021, 2:31 PM Dan Carpenter <dan.carpenter@oracle.com>
> wrote:
>
> > On Wed, Feb 10, 2021 at 02:28:31PM +0530, karthek wrote:
> > > On Wed, Feb 10, 2021 at 1:37 PM Dan Carpenter <dan.carpenter@oracle.com>
> > wrote:
> > > > > @@ -789,7 +759,7 @@ static void phy_PostSetBwMode8723B(struct
> > adapter *Adapter)
> > > > >
> > > > > PHY_SetBBReg(Adapter, rFPGA1_RFMOD, bRFMOD, 0x0);
> > > > >
> > > > > -/* PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2,
> > BIT10, 1); */
> > > > > + /*PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
> > > >
> > > > This format is wrong. Anyway, just delete the commented out code.
> > > >
> > > > regards,
> > > > dan carpenter
> > > >
> > >
> > > how can i delete that, i have no idea what this driver does
> > > i'm just fixing coding style issues for eudyptula challenge.
> > > i dont think its a good idea to delete the code without knowing its
> > > purpose even though its commented out
> >
> > Commented code obviously doesn't do anything at all?
> >
> > regards,
> > dan carpenter
> >
>
sorry for that html mail, im onthego,i sent it from phone
anyway here is the original message:
Ofcourse it does nothing
But why does it exist in the first place,
Why maintainer decided to comment it out without just deleting it?
Maybe there is some reason which i don't know
So i decided not to touch it
Anyway I'm new to this so just say what should i do now?
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
[not found] ` <CAJ5zXr1OW+RfNNuXOZDjUvm=EKz5C9=GPc243z3Wk_qc3N=6sQ@mail.gmail.com>
2021-02-10 9:27 ` karthek
@ 2021-02-10 12:06 ` Dan Carpenter
1 sibling, 0 replies; 11+ messages in thread
From: Dan Carpenter @ 2021-02-10 12:06 UTC (permalink / raw)
To: karthek; +Cc: Greg Kroah-Hartman, Stephen Rothwell, devel, linux-kernel
On Wed, Feb 10, 2021 at 02:38:28PM +0530, karthek wrote:
> On Wed, Feb 10, 2021, 2:31 PM Dan Carpenter <dan.carpenter@oracle.com>
> wrote:
>
> > On Wed, Feb 10, 2021 at 02:28:31PM +0530, karthek wrote:
> > > On Wed, Feb 10, 2021 at 1:37 PM Dan Carpenter <dan.carpenter@oracle.com>
> > wrote:
> > > > > @@ -789,7 +759,7 @@ static void phy_PostSetBwMode8723B(struct
> > adapter *Adapter)
> > > > >
> > > > > PHY_SetBBReg(Adapter, rFPGA1_RFMOD, bRFMOD, 0x0);
> > > > >
> > > > > -/* PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2,
> > BIT10, 1); */
> > > > > + /*PHY_SetBBReg(Adapter, rFPGA0_AnalogParameter2, BIT10, 1); */
> > > >
> > > > This format is wrong. Anyway, just delete the commented out code.
> > > >
> > > > regards,
> > > > dan carpenter
> > > >
> > >
> > > how can i delete that, i have no idea what this driver does
> > > i'm just fixing coding style issues for eudyptula challenge.
> > > i dont think its a good idea to delete the code without knowing its
> > > purpose even though its commented out
> >
> > Commented code obviously doesn't do anything at all?
> >
> > regards,
> > dan carpenter
> >
>
> > Ofcourse it does nothing
>
> But why does it exist in the first place,
>
> Why maintainer decided to comment it out without just deleting it?
> Maybe there is some reason which i don't know
> So i decided not to touch it
This is staging code because the original developers didn't do a great
job.
>
> Anyway I'm new to this so just say what should i do now?
Just delete it.
regards,
dan carpenter
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
2021-02-10 19:10 karthik alapati
2021-02-10 19:18 ` karthek
@ 2021-02-11 11:12 ` Greg Kroah-Hartman
1 sibling, 0 replies; 11+ messages in thread
From: Greg Kroah-Hartman @ 2021-02-11 11:12 UTC (permalink / raw)
To: karthik alapati; +Cc: Stephen Rothwell, devel, linux-kernel
On Thu, Feb 11, 2021 at 12:40:15AM +0530, karthik alapati wrote:
> fix checkpatch.pl warning for "block comments should align the
> * on each line" and make function comments follow kernel-doc
>
> Signed-off-by: karthik alapati <mail@karthek.com>
> ---
> .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 185 +++++++-----------
> 1 file changed, 73 insertions(+), 112 deletions(-)
>
> diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> index cf23414d7..1fd504181 100644
> --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> @@ -20,16 +20,11 @@
> #define MAX_DOZE_WAITING_TIMES_9x 64
>
> /**
> -* Function: phy_CalculateBitShift
> -*
> -* OverView: Get shifted position of the BitMask
> -*
> -* Input:
> -* u32 BitMask,
> -*
> -* Output: none
> -* Return: u32 Return the shift bit bit position of the mask
> -*/
> + * phy_CalculateBitShift - Get shifted position of the BitMask.
> + * @BitMask: Bitmask.
> + *
> + * Return: Return the shift bit position of the mask
> + */
Why indent these comments by a tab? A single space is fine.
thanks,
greg k-h
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
2021-02-11 10:04 ` Greg Kroah-Hartman
@ 2021-02-11 10:39 ` karthek
0 siblings, 0 replies; 11+ messages in thread
From: karthek @ 2021-02-11 10:39 UTC (permalink / raw)
To: Greg Kroah-Hartman; +Cc: Stephen Rothwell, devel, linux-kernel, Dan Carpenter
Sorry
On Thu, Feb 11, 2021 at 3:34 PM Greg Kroah-Hartman
<gregkh@linuxfoundation.org> wrote:
>
> On Thu, Feb 11, 2021 at 12:48:16AM +0530, karthek wrote:
> > check this out
>
> Why ask us again when you already sent a patch? Do you see any other
> developers doing that on the mailing lists?
>
> thanks,
>
> greg k-h
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
2021-02-10 19:18 ` karthek
@ 2021-02-11 10:04 ` Greg Kroah-Hartman
2021-02-11 10:39 ` karthek
0 siblings, 1 reply; 11+ messages in thread
From: Greg Kroah-Hartman @ 2021-02-11 10:04 UTC (permalink / raw)
To: karthek; +Cc: Stephen Rothwell, devel, linux-kernel, Dan Carpenter
On Thu, Feb 11, 2021 at 12:48:16AM +0530, karthek wrote:
> check this out
Why ask us again when you already sent a patch? Do you see any other
developers doing that on the mailing lists?
thanks,
greg k-h
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
2021-02-10 19:10 karthik alapati
@ 2021-02-10 19:18 ` karthek
2021-02-11 10:04 ` Greg Kroah-Hartman
2021-02-11 11:12 ` Greg Kroah-Hartman
1 sibling, 1 reply; 11+ messages in thread
From: karthek @ 2021-02-10 19:18 UTC (permalink / raw)
To: Greg Kroah-Hartman, Stephen Rothwell; +Cc: devel, linux-kernel, Dan Carpenter
check this out
^ permalink raw reply [flat|nested] 11+ messages in thread
* [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
@ 2021-02-10 19:10 karthik alapati
2021-02-10 19:18 ` karthek
2021-02-11 11:12 ` Greg Kroah-Hartman
0 siblings, 2 replies; 11+ messages in thread
From: karthik alapati @ 2021-02-10 19:10 UTC (permalink / raw)
To: Greg Kroah-Hartman, Stephen Rothwell; +Cc: devel, linux-kernel
fix checkpatch.pl warning for "block comments should align the
* on each line" and make function comments follow kernel-doc
Signed-off-by: karthik alapati <mail@karthek.com>
---
.../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 185 +++++++-----------
1 file changed, 73 insertions(+), 112 deletions(-)
diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
index cf23414d7..1fd504181 100644
--- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
+++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
@@ -20,16 +20,11 @@
#define MAX_DOZE_WAITING_TIMES_9x 64
/**
-* Function: phy_CalculateBitShift
-*
-* OverView: Get shifted position of the BitMask
-*
-* Input:
-* u32 BitMask,
-*
-* Output: none
-* Return: u32 Return the shift bit bit position of the mask
-*/
+ * phy_CalculateBitShift - Get shifted position of the BitMask.
+ * @BitMask: Bitmask.
+ *
+ * Return: Return the shift bit position of the mask
+ */
static u32 phy_CalculateBitShift(u32 BitMask)
{
u32 i;
@@ -43,19 +38,17 @@ static u32 phy_CalculateBitShift(u32 BitMask)
/**
-* Function: PHY_QueryBBReg
-*
-* OverView: Read "specific bits" from BB register
-*
-* Input:
-* struct adapter * Adapter,
-* u32 RegAddr, The target address to be readback
-* u32 BitMask The target bit position in the target address
-* to be readback
-* Output: None
-* Return: u32 Data The readback register value
-* Note: This function is equal to "GetRegSetting" in PHY programming guide
-*/
+ * PHY_QueryBBReg - Read "specific bits" from BB register.
+ * @Adapter:
+ * @RegAddr: The target address to be readback
+ * @BitMask: The target bit position in the target address
+ * to be readback
+ *
+ * Return: The readback register value
+ *
+ * .. Note:: This function is equal to "GetRegSetting" in PHY programming
+ * guide
+ */
u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
{
u32 OriginalValue, BitShift;
@@ -75,22 +68,17 @@ u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
/**
-* Function: PHY_SetBBReg
-*
-* OverView: Write "Specific bits" to BB register (page 8~)
-*
-* Input:
-* struct adapter * Adapter,
-* u32 RegAddr, The target address to be modified
-* u32 BitMask The target bit position in the target address
-* to be modified
-* u32 Data The new register value in the target bit position
-* of the target address
-*
-* Output: None
-* Return: None
-* Note: This function is equal to "PutRegSetting" in PHY programming guide
-*/
+ * PHY_SetBBReg - Write "Specific bits" to BB register (page 8~).
+ * @Adapter:
+ * @RegAddr: The target address to be modified
+ * @BitMask: The target bit position in the target address
+ * to be modified
+ * @Data: The new register value in the target bit position
+ * of the target address
+ *
+ * .. Note:: This function is equal to "PutRegSetting" in PHY programming
+ * guide
+ */
void PHY_SetBBReg_8723B(
struct adapter *Adapter,
@@ -184,27 +172,21 @@ static u32 phy_RFSerialRead_8723B(
}
/**
-* Function: phy_RFSerialWrite_8723B
-*
-* OverView: Write data to RF register (page 8~)
-*
-* Input:
-* struct adapter * Adapter,
-* RF_PATH eRFPath, Radio path of A/B/C/D
-* u32 Offset, The target address to be read
-* u32 Data The new register Data in the target bit position
-* of the target to be read
-*
-* Output: None
-* Return: None
-* Note: Threre are three types of serial operations:
-* 1. Software serial write
-* 2. Hardware LSSI-Low Speed Serial Interface
-* 3. Hardware HSSI-High speed
-* serial write. Driver need to implement (1) and (2).
-* This function is equal to the combination of RF_ReadReg() and RFLSSIRead()
+ * phy_RFSerialWrite_8723B - Write data to RF register (page 8~).
+ * @Adapter:
+ * @eRFPath: Radio path of A/B/C/D
+ * @Offset: The target address to be read
+ * @Data: The new register Data in the target bit position
+ * of the target to be read
+ *
+ * .. Note:: Threre are three types of serial operations:
+ * 1. Software serial write
+ * 2. Hardware LSSI-Low Speed Serial Interface
+ * 3. Hardware HSSI-High speed
+ * serial write. Driver need to implement (1) and (2).
+ * This function is equal to the combination of RF_ReadReg() and RFLSSIRead()
*
- * Note: For RF8256 only
+ * .. Note:: For RF8256 only
* The total count of RTL8256(Zebra4) register is around 36 bit it only employs
* 4-bit RF address. RTL8256 uses "register mode control bit" (Reg00[12], Reg00[10])
* to access register address bigger than 0xf. See "Appendix-4 in PHY Configuration
@@ -225,7 +207,7 @@ static u32 phy_RFSerialRead_8723B(
*
*
*
-*/
+ */
static void phy_RFSerialWrite_8723B(
struct adapter *Adapter,
enum RF_PATH eRFPath,
@@ -261,21 +243,18 @@ static void phy_RFSerialWrite_8723B(
/**
-* Function: PHY_QueryRFReg
-*
-* OverView: Query "Specific bits" to RF register (page 8~)
-*
-* Input:
-* struct adapter * Adapter,
-* RF_PATH eRFPath, Radio path of A/B/C/D
-* u32 RegAddr, The target address to be read
-* u32 BitMask The target bit position in the target address
-* to be read
-*
-* Output: None
-* Return: u32 Readback value
-* Note: This function is equal to "GetRFRegSetting" in PHY programming guide
-*/
+ * PHY_QueryRFReg - Query "Specific bits" to RF register (page 8~).
+ * @Adapter:
+ * @eRFPath: Radio path of A/B/C/D
+ * @RegAdd: The target address to be read
+ * @BitMask: The target bit position in the target address
+ * to be read
+ *
+ * Return: Readback value
+ *
+ * .. Note:: This function is equal to "GetRFRegSetting" in PHY
+ * programming guide
+ */
u32 PHY_QueryRFReg_8723B(
struct adapter *Adapter,
u8 eRFPath,
@@ -296,23 +275,18 @@ u32 PHY_QueryRFReg_8723B(
}
/**
-* Function: PHY_SetRFReg
-*
-* OverView: Write "Specific bits" to RF register (page 8~)
-*
-* Input:
-* struct adapter * Adapter,
-* RF_PATH eRFPath, Radio path of A/B/C/D
-* u32 RegAddr, The target address to be modified
-* u32 BitMask The target bit position in the target address
-* to be modified
-* u32 Data The new register Data in the target bit position
-* of the target address
-*
-* Output: None
-* Return: None
-* Note: This function is equal to "PutRFRegSetting" in PHY programming guide
-*/
+ * PHY_SetRFReg - Write "Specific bits" to RF register (page 8~).
+ * @Adapter:
+ * @eRFPath: Radio path of A/B/C/D
+ * @RegAddr: The target address to be modified
+ * @BitMask: The target bit position in the target address
+ * to be modified
+ * @Data: The new register Data in the target bit position
+ * of the target address
+ *
+ * .. Note:: This function is equal to "PutRFRegSetting" in PHY
+ * programming guide.
+ */
void PHY_SetRFReg_8723B(
struct adapter *Adapter,
u8 eRFPath,
@@ -344,15 +318,7 @@ void PHY_SetRFReg_8723B(
/*-----------------------------------------------------------------------------
- * Function: PHY_MACConfig8192C
- *
- * Overview: Condig MAC by header file or parameter file.
- *
- * Input: NONE
- *
- * Output: NONE
- *
- * Return: NONE
+ * PHY_MACConfig8192C - Condig MAC by header file or parameter file.
*
* Revised History:
* When Who Remark
@@ -369,17 +335,12 @@ s32 PHY_MACConfig8723B(struct adapter *Adapter)
}
/**
-* Function: phy_InitBBRFRegisterDefinition
-*
-* OverView: Initialize Register definition offset for Radio Path A/B/C/D
-*
-* Input:
-* struct adapter * Adapter,
-*
-* Output: None
-* Return: None
-* Note: The initialization value is constant and it should never be changes
-*/
+ * phy_InitBBRFRegisterDefinition - Initialize Register definition offset for
+ * Radio Path A/B/C/D
+ * @Adapter:
+ *
+ * .. Note:: The initialization value is constant and it should never be changes
+ */
static void phy_InitBBRFRegisterDefinition(struct adapter *Adapter)
{
struct hal_com_data *pHalData = GET_HAL_DATA(Adapter);
--
2.30.0
^ permalink raw reply related [flat|nested] 11+ messages in thread
end of thread, other threads:[~2021-02-11 11:44 UTC | newest]
Thread overview: 11+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-02-09 21:12 [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc karthik alapati
2021-02-10 8:06 ` Dan Carpenter
2021-02-10 8:58 ` karthek
2021-02-10 9:01 ` Dan Carpenter
[not found] ` <CAJ5zXr1OW+RfNNuXOZDjUvm=EKz5C9=GPc243z3Wk_qc3N=6sQ@mail.gmail.com>
2021-02-10 9:27 ` karthek
2021-02-10 12:06 ` Dan Carpenter
2021-02-10 19:10 karthik alapati
2021-02-10 19:18 ` karthek
2021-02-11 10:04 ` Greg Kroah-Hartman
2021-02-11 10:39 ` karthek
2021-02-11 11:12 ` Greg Kroah-Hartman
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).