FreeCalypso > hg > freecalypso-sw

comparison gsm-fw/bsp/abb+spi/spi_api.h @ 587:cc0944d35698

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
gsm-fw/bsp/abb+spi/*.h: formatting fixes (line length and tabs)
author Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
date Sun, 17 Aug 2014 00:08:50 +0000
parents 971e84124a6f
children
comparison
equal deleted inserted replaced
586:25a3095e8a98 587:cc0944d35698
80 #endif 80 #endif
81 81
82 82
83 /* Prototypes */ 83 /* Prototypes */
84 84
85 /********************************************************************************/ 85 /******************************************************************************/
86 /* */ 86 /* */
87 /* Function Name: spi_abb_write */ 87 /* Function Name: spi_abb_write */
88 /* */ 88 /* */
89 /* Purpose: This function is used to send to the SPI mailbox a */ 89 /* Purpose: This function is used to send to the SPI mailbox a */
90 /* WRITE REGISTER rqst msg. */ 90 /* WRITE REGISTER rqst msg. */
91 /* */ 91 /* */
92 /* Input Parameters: */ 92 /* Input Parameters: */
93 /* - page : ABB Page where to read the register. */ 93 /* - page : ABB Page where to read the register. */
94 /* - address : address of the ABB register to read. */ 94 /* - address : address of the ABB register to read. */
95 /* - data : data to write in the ABB register */ 95 /* - data : data to write in the ABB register */
96 /* */ 96 /* */
97 /* Return : */ 97 /* Return : */
98 /* - RVM_NOT_READY : the SPI task is not ready */ 98 /* - RVM_NOT_READY : the SPI task is not ready */
99 /* - RV_MEMORY_ERR : the SPI task has not enough memory */ 99 /* - RV_MEMORY_ERR : the SPI task has not enough memory */
100 /* - RV_OK : normal processing */ 100 /* - RV_OK : normal processing */
101 /* */ 101 /* */
102 /* Note: */ 102 /* Note: */
103 /* None. */ 103 /* None. */
104 /* */ 104 /* */
105 /********************************************************************************/ 105 /******************************************************************************/
106 T_RV_RET spi_abb_write(UINT16 page, UINT16 address, UINT16 data); 106 T_RV_RET spi_abb_write(UINT16 page, UINT16 address, UINT16 data);
107 107
108 /********************************************************************************/ 108 /******************************************************************************/
109 /* */ 109 /* */
110 /* Function Name: spi_abb_read */ 110 /* Function Name: spi_abb_read */
111 /* */ 111 /* */
112 /* Purpose: This function is used to send a READ REGISTER rqst msg */ 112 /* Purpose: This function is used to send a READ REGISTER rqst msg */
113 /* to the SPI mailbox. */ 113 /* to the SPI mailbox. */
114 /* */ 114 /* */
115 /* Input Parameters: */ 115 /* Input Parameters: */
116 /* - page : ABB Page where to read the register. */ 116 /* - page : ABB Page where to read the register. */
117 /* - address : address of the ABB register to read. */ 117 /* - address : address of the ABB register to read. */
118 /* - CallBack : callback function called by the spi task */ 118 /* - CallBack : callback function called by the spi task */
119 /* at the end of the read process. */ 119 /* at the end of the read process. */
120 /* */ 120 /* */
121 /* Return : */ 121 /* Return : */
122 /* - RVM_NOT_READY : the SPI task is not ready */ 122 /* - RVM_NOT_READY : the SPI task is not ready */
123 /* - RV_MEMORY_ERR : the SPI task has not enough memory */ 123 /* - RV_MEMORY_ERR : the SPI task has not enough memory */
124 /* - RV_OK : normal processing */ 124 /* - RV_OK : normal processing */
125 /* */ 125 /* */
126 /* Note: */ 126 /* Note: */
127 /* None. */ 127 /* None. */
128 /* */ 128 /* */
129 /********************************************************************************/ 129 /******************************************************************************/
130 T_RV_RET spi_abb_read(UINT16 page, UINT16 address, CALLBACK_FUNC_U16 CallBack); 130 T_RV_RET spi_abb_read(UINT16 page, UINT16 address, CALLBACK_FUNC_U16 CallBack);
131 131
132 /********************************************************************************/ 132 /******************************************************************************/
133 /* */ 133 /* */
134 /* Function Name: spi_abb_conf_ADC */ 134 /* Function Name: spi_abb_conf_ADC */
135 /* */ 135 /* */
136 /* Purpose: This function is used to send to the SPI mailbox a rqst msg */ 136 /* Purpose: This function is used to send to the SPI mailbox a rqst msg*/
137 /* for configuring ABB MADC for conversions. */ 137 /* for configuring ABB MADC for conversions. */
138 /* */ 138 /* */
139 /* Input Parameters: */ 139 /* Input Parameters: */
140 /* - channels : ABB channels to be converted. */ 140 /* - channels : ABB channels to be converted. */
141 /* - itval : configure the End Of Conversion IT. */ 141 /* - itval : configure the End Of Conversion IT. */
142 /* */ 142 /* */
143 /* Return : */ 143 /* Return : */
144 /* - RVM_NOT_READY : the SPI task is not ready */ 144 /* - RVM_NOT_READY : the SPI task is not ready */
145 /* - RV_MEMORY_ERR : the SPI task has not enough memory */ 145 /* - RV_MEMORY_ERR : the SPI task has not enough memory */
146 /* - RV_OK : normal processing */ 146 /* - RV_OK : normal processing */
147 /* */ 147 /* */
148 /* Note: */ 148 /* Note: */
149 /* None. */ 149 /* None. */
150 /* */ 150 /* */
151 /********************************************************************************/ 151 /******************************************************************************/
152 T_RV_RET spi_abb_conf_ADC(UINT16 channels, UINT16 itval); 152 T_RV_RET spi_abb_conf_ADC(UINT16 channels, UINT16 itval);
153 153
154 /********************************************************************************/ 154 /******************************************************************************/
155 /* */ 155 /* */
156 /* Function Name: spi_abb_read_ADC */ 156 /* Function Name: spi_abb_read_ADC */
157 /* */ 157 /* */
158 /* Purpose: This function is used to send to the SPI mailbox a rqst msg */ 158 /* Purpose: This function is used to send to the SPI mailbox a rqst msg*/
159 /* for reading the ABB ADC results. */ 159 /* for reading the ABB ADC results. */
160 /* */ 160 /* */
161 /* Input Parameters: */ 161 /* Input Parameters: */
162 /* - Buff : pointer to the buffer filled with ADC results. */ 162 /* - Buff : pointer to the buffer filled with ADC results.*/
163 /* - CallBack : callback function called by the spi task */ 163 /* - CallBack : callback function called by the spi task */
164 /* at the end of the read process. */ 164 /* at the end of the read process. */
165 /* */ 165 /* */
166 /* Return : */ 166 /* Return : */
167 /* - RVM_NOT_READY : the SPI task is not ready */ 167 /* - RVM_NOT_READY : the SPI task is not ready */
168 /* - RV_MEMORY_ERR : the SPI task has not enough memory */ 168 /* - RV_MEMORY_ERR : the SPI task has not enough memory */
169 /* - RV_OK : normal processing */ 169 /* - RV_OK : normal processing */
170 /* */ 170 /* */
171 /* Note: */ 171 /* Note: */
172 /* None. */ 172 /* None. */
173 /* */ 173 /* */
174 /********************************************************************************/ 174 /******************************************************************************/
175 T_RV_RET spi_abb_read_ADC(UINT16 *Buff, CALLBACK_FUNC_NO_PARAM CallBack); 175 T_RV_RET spi_abb_read_ADC(UINT16 *Buff, CALLBACK_FUNC_NO_PARAM CallBack);
176 176
177 #endif /* __SPI_API_H_ */ 177 #endif /* __SPI_API_H_ */