📄 gthwcntl.h
字号:
*
* INPUTS:
* portNum - Port number to read the register for.
* regAddr - The register's address.
* fieldOffset - The field start bit index. (0 - 15)
* fieldLength - Number of bits to read.
*
* OUTPUTS:
* data - The read register field.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* 1. The sum of fieldOffset & fieldLength parameters must be smaller-
* equal to 16.
*
*******************************************************************************/
GT_STATUS hwGetPortRegField
(
IN GT_QD_DEV *dev,
IN GT_U8 portNum,
IN GT_U8 regAddr,
IN GT_U8 fieldOffset,
IN GT_U8 fieldLength,
OUT GT_U16 *data
);
/*******************************************************************************
* hwSetPortRegField
*
* DESCRIPTION:
* This function writes to specified field in a switch's port register.
*
* INPUTS:
* portNum - Port number to write the register for.
* regAddr - The register's address.
* fieldOffset - The field start bit index. (0 - 15)
* fieldLength - Number of bits to write.
* data - Data to be written.
*
* OUTPUTS:
* None.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* 1. The sum of fieldOffset & fieldLength parameters must be smaller-
* equal to 16.
*
*******************************************************************************/
GT_STATUS hwSetPortRegField
(
IN GT_QD_DEV *dev,
IN GT_U8 portNum,
IN GT_U8 regAddr,
IN GT_U8 fieldOffset,
IN GT_U8 fieldLength,
IN GT_U16 data
);
/*******************************************************************************
* hwSetPortRegBits
*
* DESCRIPTION:
* This function writes to specified bits in a switch's port register.
*
* INPUTS:
* portNum - Port number to write the register for.
* regAddr - The register's address.
* mask - The bits to write.
* data - Data to be written.
*
* OUTPUTS:
* None.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* 1. When Data is 0x1002 and mask is 0xF00F, 0001b is written to bit[31:24]* and 0010b is written to bit[3:0]
*
*******************************************************************************/
GT_STATUS hwSetPortRegBits
(
IN GT_QD_DEV *dev,
IN GT_U8 portNum,
IN GT_U8 regAddr,
IN GT_U16 mask,
IN GT_U16 data
);
/****************************************************************************/
/* Global registers related functions. */
/****************************************************************************/
/*******************************************************************************
* hwReadGlobalReg
*
* DESCRIPTION:
* This function reads a switch's global register.
*
* INPUTS:
* regAddr - The register's address.
*
* OUTPUTS:
* data - The read register's data.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* None.
*
*******************************************************************************/
GT_STATUS hwReadGlobalReg
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
OUT GT_U16 *data
);
/*******************************************************************************
* hwWriteGlobalReg
*
* DESCRIPTION:
* This function writes to a switch's global register.
*
* INPUTS:
* regAddr - The register's address.
* data - The data to be written.
*
* OUTPUTS:
* None.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* None.
*
*******************************************************************************/
GT_STATUS hwWriteGlobalReg
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
IN GT_U16 data
);
/*******************************************************************************
* hwGetGlobalRegField
*
* DESCRIPTION:
* This function reads a specified field from a switch's global register.
*
* INPUTS:
* regAddr - The register's address.
* fieldOffset - The field start bit index. (0 - 15)
* fieldLength - Number of bits to read.
*
* OUTPUTS:
* data - The read register field.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* 1. The sum of fieldOffset & fieldLength parameters must be smaller-
* equal to 16.
*
*******************************************************************************/
GT_STATUS hwGetGlobalRegField
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
IN GT_U8 fieldOffset,
IN GT_U8 fieldLength,
OUT GT_U16 *data
);
/*******************************************************************************
* hwSetGlobalRegField
*
* DESCRIPTION:
* This function writes to specified field in a switch's global register.
*
* INPUTS:
* regAddr - The register's address.
* fieldOffset - The field start bit index. (0 - 15)
* fieldLength - Number of bits to write.
* data - Data to be written.
*
* OUTPUTS:
* None.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* 1. The sum of fieldOffset & fieldLength parameters must be smaller-
* equal to 16.
*
*******************************************************************************/
GT_STATUS hwSetGlobalRegField
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
IN GT_U8 fieldOffset,
IN GT_U8 fieldLength,
IN GT_U16 data
);
/****************************************************************************/
/* Global 2 registers related functions. */
/****************************************************************************/
/*******************************************************************************
* hwReadGlobal2Reg
*
* DESCRIPTION:
* This function reads a switch's global 2 register.
*
* INPUTS:
* regAddr - The register's address.
*
* OUTPUTS:
* data - The read register's data.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* None.
*
*******************************************************************************/
GT_STATUS hwReadGlobal2Reg
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
OUT GT_U16 *data
);
/*******************************************************************************
* hwWriteGlobal2Reg
*
* DESCRIPTION:
* This function writes to a switch's global 2 register.
*
* INPUTS:
* regAddr - The register's address.
* data - The data to be written.
*
* OUTPUTS:
* None.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* None.
*
*******************************************************************************/
GT_STATUS hwWriteGlobal2Reg
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
IN GT_U16 data
);
/*******************************************************************************
* hwGetGlobal2RegField
*
* DESCRIPTION:
* This function reads a specified field from a switch's global 2 register.
*
* INPUTS:
* regAddr - The register's address.
* fieldOffset - The field start bit index. (0 - 15)
* fieldLength - Number of bits to read.
*
* OUTPUTS:
* data - The read register field.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* 1. The sum of fieldOffset & fieldLength parameters must be smaller-
* equal to 16.
*
*******************************************************************************/
GT_STATUS hwGetGlobal2RegField
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
IN GT_U8 fieldOffset,
IN GT_U8 fieldLength,
OUT GT_U16 *data
);
/*******************************************************************************
* hwSetGlobal2RegField
*
* DESCRIPTION:
* This function writes to specified field in a switch's global 2 register.
*
* INPUTS:
* regAddr - The register's address.
* fieldOffset - The field start bit index. (0 - 15)
* fieldLength - Number of bits to write.
* data - Data to be written.
*
* OUTPUTS:
* None.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
*
*******************************************************************************/
GT_STATUS hwSetGlobal2RegField
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
IN GT_U8 fieldOffset,
IN GT_U8 fieldLength,
IN GT_U16 data
);
/*******************************************************************************
* hwSetGlobal2RegBits
*
* DESCRIPTION:
* This function writes to specified bits in a switch's global 2 register.
*
* INPUTS:
* regAddr - The register's address.
* mask - The bits to write.
* data - Data to be written.
*
* OUTPUTS:
* None.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* 1. When Data is 0x1002 and mask is 0xF00F, 0001b is written to bit[31:24]* and 0010b is written to bit[3:0]
*
*******************************************************************************/
GT_STATUS hwSetGlobal2RegBits
(
IN GT_QD_DEV *dev,
IN GT_U8 regAddr,
IN GT_U16 mask,
IN GT_U16 data
);
/*******************************************************************************
* hwReadMiiReg
*
* DESCRIPTION:
* This function reads a switch register.
*
* INPUTS:
* phyAddr - Phy Address to read the register for.( 0 ~ 0x1F )
* regAddr - The register's address.
*
* OUTPUTS:
* data - The read register's data.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* None.
*
*******************************************************************************/
GT_STATUS hwReadMiiReg
(
IN GT_QD_DEV *dev,
IN GT_U8 phyAddr,
IN GT_U8 regAddr,
OUT GT_U16 *data
);
/*******************************************************************************
* hwWriteMiiReg
*
* DESCRIPTION:
* This function writes a switch register.
*
* INPUTS:
* phyAddr - Phy Address to read the register for.( 0 ~ 0x1F )
* regAddr - The register's address.
*
* OUTPUTS:
* data - The read register's data.
*
* RETURNS:
* GT_OK on success, or
* GT_FAIL otherwise.
*
* COMMENTS:
* None.
*
*******************************************************************************/
GT_STATUS hwWriteMiiReg
(
IN GT_QD_DEV *dev,
IN GT_U8 phyAddr,
IN GT_U8 regAddr,
IN GT_U16 data
);
#ifdef __cplusplus
}
#endif
#endif /* __gtHwCntlh */
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -