FreeCalypso > hg > fc-tourmaline
diff src/cs/drivers/drv_app/spi/spi_api.h @ 260:34b7059b9337
drv_app/spi/*: code readability fixes
| author | Mychaela Falconia <falcon@freecalypso.org> |
|---|---|
| date | Fri, 14 May 2021 02:13:47 +0000 |
| parents | 365833d1d186 |
| children |
line wrap: on
line diff
--- a/src/cs/drivers/drv_app/spi/spi_api.h Fri May 14 01:30:13 2021 +0000 +++ b/src/cs/drivers/drv_app/spi/spi_api.h Fri May 14 02:13:47 2021 +0000 @@ -40,30 +40,29 @@ typedef void (*CALLBACK_FUNC_U16)(UINT16 *); - /*****************************************/ /* structures of messages send to SPI */ /*****************************************/ typedef struct { T_RV_HDR os_hdr; - UINT16 page; - UINT16 address; + UINT16 page; + UINT16 address; UINT16 data; } T_SPI_WRITE; typedef struct { T_RV_HDR os_hdr; - UINT16 page; - UINT16 address; + UINT16 page; + UINT16 address; } T_SPI_READ; typedef struct { T_RV_HDR os_hdr; - UINT16 channels; - UINT16 itval; + UINT16 channels; + UINT16 itval; } T_SPI_ABB_CONF_ADC; @@ -74,7 +73,6 @@ } T_SPI_ABB_READ_ADC; - #ifdef __cplusplus } #endif @@ -82,97 +80,96 @@ /* Prototypes */ -/********************************************************************************/ -/* */ -/* Function Name: spi_abb_write */ -/* */ -/* Purpose: This function is used to send to the SPI mailbox a */ -/* WRITE REGISTER rqst msg. */ -/* */ -/* Input Parameters: */ -/* - page : ABB Page where to read the register. */ -/* - address : address of the ABB register to read. */ -/* - data : data to write in the ABB register */ -/* */ -/* Return : */ -/* - RVM_NOT_READY : the SPI task is not ready */ -/* - RV_MEMORY_ERR : the SPI task has not enough memory */ -/* - RV_OK : normal processing */ -/* */ -/* Note: */ -/* None. */ -/* */ -/********************************************************************************/ +/******************************************************************************/ +/* */ +/* Function Name: spi_abb_write */ +/* */ +/* Purpose: This function is used to send to the SPI mailbox a */ +/* WRITE REGISTER rqst msg. */ +/* */ +/* Input Parameters: */ +/* - page : ABB Page where to read the register. */ +/* - address : address of the ABB register to read. */ +/* - data : data to write in the ABB register */ +/* */ +/* Return : */ +/* - RVM_NOT_READY : the SPI task is not ready */ +/* - RV_MEMORY_ERR : the SPI task has not enough memory */ +/* - RV_OK : normal processing */ +/* */ +/* Note: */ +/* None. */ +/* */ +/******************************************************************************/ T_RV_RET spi_abb_write(UINT16 page, UINT16 address, UINT16 data); -/********************************************************************************/ -/* */ -/* Function Name: spi_abb_read */ -/* */ -/* Purpose: This function is used to send a READ REGISTER rqst msg */ -/* to the SPI mailbox. */ -/* */ -/* Input Parameters: */ -/* - page : ABB Page where to read the register. */ -/* - address : address of the ABB register to read. */ -/* - CallBack : callback function called by the spi task */ -/* at the end of the read process. */ -/* */ -/* Return : */ -/* - RVM_NOT_READY : the SPI task is not ready */ -/* - RV_MEMORY_ERR : the SPI task has not enough memory */ -/* - RV_OK : normal processing */ -/* */ -/* Note: */ -/* None. */ -/* */ -/********************************************************************************/ +/******************************************************************************/ +/* */ +/* Function Name: spi_abb_read */ +/* */ +/* Purpose: This function is used to send a READ REGISTER rqst msg */ +/* to the SPI mailbox. */ +/* */ +/* Input Parameters: */ +/* - page : ABB Page where to read the register. */ +/* - address : address of the ABB register to read. */ +/* - CallBack : callback function called by the spi task */ +/* at the end of the read process. */ +/* */ +/* Return : */ +/* - RVM_NOT_READY : the SPI task is not ready */ +/* - RV_MEMORY_ERR : the SPI task has not enough memory */ +/* - RV_OK : normal processing */ +/* */ +/* Note: */ +/* None. */ +/* */ +/******************************************************************************/ T_RV_RET spi_abb_read(UINT16 page, UINT16 address, CALLBACK_FUNC_U16 CallBack); -/********************************************************************************/ -/* */ -/* Function Name: spi_abb_conf_ADC */ -/* */ -/* Purpose: This function is used to send to the SPI mailbox a rqst msg */ -/* for configuring ABB MADC for conversions. */ -/* */ -/* Input Parameters: */ -/* - channels : ABB channels to be converted. */ -/* - itval : configure the End Of Conversion IT. */ -/* */ -/* Return : */ -/* - RVM_NOT_READY : the SPI task is not ready */ -/* - RV_MEMORY_ERR : the SPI task has not enough memory */ -/* - RV_OK : normal processing */ -/* */ -/* Note: */ -/* None. */ -/* */ -/********************************************************************************/ +/******************************************************************************/ +/* */ +/* Function Name: spi_abb_conf_ADC */ +/* */ +/* Purpose: This function is used to send to the SPI mailbox a rqst msg*/ +/* for configuring ABB MADC for conversions. */ +/* */ +/* Input Parameters: */ +/* - channels : ABB channels to be converted. */ +/* - itval : configure the End Of Conversion IT. */ +/* */ +/* Return : */ +/* - RVM_NOT_READY : the SPI task is not ready */ +/* - RV_MEMORY_ERR : the SPI task has not enough memory */ +/* - RV_OK : normal processing */ +/* */ +/* Note: */ +/* None. */ +/* */ +/******************************************************************************/ T_RV_RET spi_abb_conf_ADC(UINT16 channels, UINT16 itval); -/********************************************************************************/ -/* */ -/* Function Name: spi_abb_read_ADC */ -/* */ -/* Purpose: This function is used to send to the SPI mailbox a rqst msg */ -/* for reading the ABB ADC results. */ -/* */ -/* Input Parameters: */ -/* - Buff : pointer to the buffer filled with ADC results. */ -/* - CallBack : callback function called by the spi task */ -/* at the end of the read process. */ -/* */ -/* Return : */ -/* - RVM_NOT_READY : the SPI task is not ready */ -/* - RV_MEMORY_ERR : the SPI task has not enough memory */ -/* - RV_OK : normal processing */ -/* */ -/* Note: */ -/* None. */ -/* */ -/********************************************************************************/ +/******************************************************************************/ +/* */ +/* Function Name: spi_abb_read_ADC */ +/* */ +/* Purpose: This function is used to send to the SPI mailbox a rqst msg*/ +/* for reading the ABB ADC results. */ +/* */ +/* Input Parameters: */ +/* - Buff : pointer to the buffer filled with ADC results.*/ +/* - CallBack : callback function called by the spi task */ +/* at the end of the read process. */ +/* */ +/* Return : */ +/* - RVM_NOT_READY : the SPI task is not ready */ +/* - RV_MEMORY_ERR : the SPI task has not enough memory */ +/* - RV_OK : normal processing */ +/* */ +/* Note: */ +/* None. */ +/* */ +/******************************************************************************/ T_RV_RET spi_abb_read_ADC(UINT16 *Buff, CALLBACK_FUNC_NO_PARAM CallBack); #endif /* __SPI_API_H_ */ -