staging: rtl8723bs: fix function comments to follow kernel-doc
there are some good function comments not following kernel-doc. Make them follow kernel-doc style Signed-off-by: karthik alapati <mail@karthek.com> Link: https://lore.kernel.org/r/ca8feff68a247c54b67d9c19555d1d8c1f16ebfe.1613048573.git.mail@karthek.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
karthik alapati
Greg Kroah-Hartman
Родитель
5e911c3d9d
Коммит
697805c7b3
|
|
@ -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: For RF8256 only
|
||||
* .. 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
|
||||
* 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);
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче