fix checkpatch.pl warning for "block comments should align the * on each line"
Signed-off-by: karthik alapati <[email protected]>
---
.../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 204 +++++++++---------
1 file changed, 102 insertions(+), 102 deletions(-)
diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
index cf23414d7..003f954c2 100644
--- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
+++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
@@ -20,16 +20,16 @@
#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
-*/
+ * 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
+ */
static u32 phy_CalculateBitShift(u32 BitMask)
{
u32 i;
@@ -43,19 +43,19 @@ 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
-*/
+ * 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
+ */
u32 PHY_QueryBBReg_8723B(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
{
u32 OriginalValue, BitShift;
@@ -75,22 +75,22 @@ 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
-*/
+ * 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
+ */
void PHY_SetBBReg_8723B(
struct adapter *Adapter,
@@ -184,25 +184,25 @@ 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()
+ * 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()
*
* Note: For RF8256 only
* The total count of RTL8256(Zebra4) register is around 36 bit it only employs
@@ -225,7 +225,7 @@ static u32 phy_RFSerialRead_8723B(
*
*
*
-*/
+ */
static void phy_RFSerialWrite_8723B(
struct adapter *Adapter,
enum RF_PATH eRFPath,
@@ -261,21 +261,21 @@ 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
-*/
+ * 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
+ */
u32 PHY_QueryRFReg_8723B(
struct adapter *Adapter,
u8 eRFPath,
@@ -296,23 +296,23 @@ 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
-*/
+ * 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
+ */
void PHY_SetRFReg_8723B(
struct adapter *Adapter,
u8 eRFPath,
@@ -369,17 +369,17 @@ 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
-*/
+ * 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
+ */
static void phy_InitBBRFRegisterDefinition(struct adapter *Adapter)
{
struct hal_com_data *pHalData = GET_HAL_DATA(Adapter);
--
2.30.0
On Wed, Feb 10, 2021 at 12:23:17AM +0530, karthik alapati wrote:
> fix checkpatch.pl warning for "block comments should align the * on each line"
>
> Signed-off-by: karthik alapati <[email protected]>
> ---
> .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 204 +++++++++---------
> 1 file changed, 102 insertions(+), 102 deletions(-)
>
> diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> index cf23414d7..003f954c2 100644
> --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> @@ -20,16 +20,16 @@
> #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
> -*/
> + * 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
> + */
These huge function comments are not normal kernel coding style anyway,
why not fix them up to use the correct style, don't paper over it and
keep this mess around any longer than it needs to be.
thanks,
greg k-h
On Wed, Feb 10, 2021 at 12:39:15AM +0530, karthek wrote:
> On Tue, Feb 09, 2021 at 07:59:02PM +0100, Greg Kroah-Hartman wrote:
> > On Wed, Feb 10, 2021 at 12:23:17AM +0530, karthik alapati wrote:
> > > fix checkpatch.pl warning for "block comments should align the * on each line"
> > >
> > > Signed-off-by: karthik alapati <[email protected]>
> > > ---
> > > .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 204 +++++++++---------
> > > 1 file changed, 102 insertions(+), 102 deletions(-)
> > >
> > > diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > > index cf23414d7..003f954c2 100644
> > > --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > > +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > > @@ -20,16 +20,16 @@
> > > #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
> > > -*/
> > > + * 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
> > > + */
> >
> > These huge function comments are not normal kernel coding style anyway,
> > why not fix them up to use the correct style, don't paper over it and
can you please say it straight?
what exactly do you want me to do?
> > keep this mess around any longer than it needs to be.
what mess? my mails?
> >
> > thanks,
> >
> > greg k-h
On Wed, Feb 10, 2021 at 10:27:17AM +0300, Dan Carpenter wrote:
> On Wed, Feb 10, 2021 at 12:23:17AM +0530, karthik alapati wrote:
> > fix checkpatch.pl warning for "block comments should align the * on each line"
> >
> > Signed-off-by: karthik alapati <[email protected]>
> > ---
> > .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 204 +++++++++---------
> > 1 file changed, 102 insertions(+), 102 deletions(-)
> >
> > diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > index cf23414d7..003f954c2 100644
> > --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > @@ -20,16 +20,16 @@
> > #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
> > -*/
> > + * Function: phy_CalculateBitShift
> > + *
> > + * OverView: Get shifted position of the BitMask
> > + *
> > + * Input:
> > + * u32 BitMask,
>
> Why is this on a different line??
>
> > + *
> > + * Output: none
> > + * Return: u32 Return the shift bit bit position of the mask
>
> The "u32" is indented more than the "none". "bit bit" is probably a
> typo?
>
> > + */
> > static u32 phy_CalculateBitShift(u32 BitMask)
> > {
> > u32 i;
>
> There is a proper kernel-doc style that function comments are supposed
> to use. https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
>
> ./scripts/kernel-doc -v -none drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
>
> regards,
> dan carpenter
>
thats my old patch
the new one is already sent to greg,lkml
On Wed, Feb 10, 2021 at 12:23:17AM +0530, karthik alapati wrote:
> fix checkpatch.pl warning for "block comments should align the * on each line"
>
> Signed-off-by: karthik alapati <[email protected]>
> ---
> .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 204 +++++++++---------
> 1 file changed, 102 insertions(+), 102 deletions(-)
>
> diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> index cf23414d7..003f954c2 100644
> --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> @@ -20,16 +20,16 @@
> #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
> -*/
> + * Function: phy_CalculateBitShift
> + *
> + * OverView: Get shifted position of the BitMask
> + *
> + * Input:
> + * u32 BitMask,
Why is this on a different line??
> + *
> + * Output: none
> + * Return: u32 Return the shift bit bit position of the mask
The "u32" is indented more than the "none". "bit bit" is probably a
typo?
> + */
> static u32 phy_CalculateBitShift(u32 BitMask)
> {
> u32 i;
There is a proper kernel-doc style that function comments are supposed
to use. https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
./scripts/kernel-doc -v -none drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
regards,
dan carpenter