1
0
forked from me/IronOS

Cleanup comments

This commit is contained in:
Ben V. Brown
2022-11-20 18:16:17 +11:00
parent a15f10e5e7
commit d3ac9eb7b2

View File

@@ -89,7 +89,7 @@ intCallback_Type *i2cIntCbfArra[I2C_ID_MAX][I2C_INT_ALL] = {{NULL}};
* @{
*/
/****************************************************************************/ /**
/**
* @brief I2C interrupt handler
*
* @param i2cNo: I2C ID type
@@ -157,7 +157,7 @@ static void I2C_IntHandler(I2C_ID_Type i2cNo) {
* @{
*/
/****************************************************************************/ /**
/**
* @brief I2C write word data
*
* @param i2cNo: I2C ID type
@@ -174,7 +174,7 @@ void I2C_SendWord(I2C_ID_Type i2cNo, uint32_t data) {
BL_WR_REG(I2Cx, I2C_FIFO_WDATA, data);
}
/****************************************************************************/ /**
/**
* @brief I2C read word data
*
* @param i2cNo: I2C ID type
@@ -190,7 +190,7 @@ uint32_t I2C_RecieveWord(I2C_ID_Type i2cNo) {
return BL_RD_REG(I2Cx, I2C_FIFO_RDATA);
}
/****************************************************************************/ /**
/**
* @brief I2C enable
*
* @param i2cNo: I2C ID type
@@ -210,7 +210,7 @@ void I2C_Enable(I2C_ID_Type i2cNo) {
BL_WR_REG(I2Cx, I2C_CONFIG, tmpVal);
}
/****************************************************************************/ /**
/**
* @brief I2C disable
*
* @param i2cNo: I2C ID type
@@ -243,7 +243,7 @@ void I2C_Disable(I2C_ID_Type i2cNo) {
BL_WR_REG(I2Cx, I2C_INT_STS, tmpVal);
}
/****************************************************************************/ /**
/**
* @brief I2C set global reset function
*
* @param i2cNo: I2C ID type
@@ -259,7 +259,7 @@ BL_Err_Type I2C_Reset(I2C_ID_Type i2cNo) {
return SUCCESS;
}
/****************************************************************************/ /**
/**
* @brief I2C init function
*
* @param i2cNo: I2C ID type
@@ -308,7 +308,7 @@ void I2C_Init(I2C_ID_Type i2cNo, I2C_Direction_Type direct, I2C_Transfer_Cfg *cf
#endif
}
/****************************************************************************/ /**
/**
* @brief Set de-glitch function cycle count value
*
* @param i2cNo: I2C ID type
@@ -343,7 +343,7 @@ BL_Err_Type I2C_SetDeglitchCount(I2C_ID_Type i2cNo, uint8_t cnt) {
return SUCCESS;
}
/****************************************************************************/ /**
/**
* @brief Set i2c prd
*
* @param i2cNo: I2C ID type
@@ -380,7 +380,7 @@ void I2C_SetPrd(I2C_ID_Type i2cNo, uint8_t phase) {
BL_WR_REG(I2Cx, I2C_PRD_DATA, tmpVal);
}
/****************************************************************************/ /**
/**
* @brief I2C set scl output clock
*
* @param i2cNo: I2C ID type
@@ -412,7 +412,7 @@ void I2C_ClockSet(I2C_ID_Type i2cNo, uint32_t clk) {
}
}
/****************************************************************************/ /**
/**
* @brief I2C set scl sync
*
* @param i2cNo: I2C ID type
@@ -439,7 +439,7 @@ void I2C_SetSclSync(I2C_ID_Type i2cNo, uint8_t enable) {
BL_WR_REG(I2Cx, I2C_CONFIG, tmpVal);
}
/****************************************************************************/ /**
/**
* @brief Get i2c busy state
*
* @param i2cNo: I2C ID type
@@ -458,7 +458,7 @@ BL_Sts_Type I2C_IsBusy(I2C_ID_Type i2cNo) {
return ((BL_IS_REG_BIT_SET(tmpVal, I2C_STS_I2C_BUS_BUSY)) ? SET : RESET);
}
/****************************************************************************/ /**
/**
* @brief Get i2c transfer end state
*
* @param i2cNo: I2C ID type
@@ -477,7 +477,7 @@ BL_Sts_Type I2C_TransferEndStatus(I2C_ID_Type i2cNo) {
return ((BL_IS_REG_BIT_SET(tmpVal, I2C_END_INT)) ? SET : RESET);
}
/****************************************************************************/ /**
/**
* @brief I2C master write block data
*
* @param i2cNo: I2C ID type
@@ -550,7 +550,7 @@ BL_Err_Type I2C_MasterSendBlocking(I2C_ID_Type i2cNo, I2C_Transfer_Cfg *cfg) {
return SUCCESS;
}
/****************************************************************************/ /**
/**
* @brief I2C master read block data
*
* @param i2cNo: I2C ID type
@@ -643,7 +643,7 @@ BL_Err_Type I2C_MasterReceiveBlocking(I2C_ID_Type i2cNo, I2C_Transfer_Cfg *cfg)
return SUCCESS;
}
/****************************************************************************/ /**
/**
* @brief Mask/Unmask the I2C interrupt
*
* @param i2cNo: I2C ID type
@@ -783,7 +783,7 @@ void I2C_IntMask(I2C_ID_Type i2cNo, I2C_INT_Type intType, BL_Mask_Type intMask)
BL_WR_REG(I2Cx, I2C_INT_STS, tmpVal);
}
/****************************************************************************/ /**
/**
* @brief Install I2C interrupt callback function
*
* @param i2cNo: I2C ID type
@@ -803,7 +803,7 @@ void I2C_Int_Callback_Install(I2C_ID_Type i2cNo, I2C_INT_Type intType, intCallba
}
#endif
/****************************************************************************/ /**
/**
* @brief I2C IRQ handler
*
* @param None