1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
/*
ChibiOS/RT - Copyright (C) 2006-2013 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file LPC8xx/spi_lld.h
* @brief LPC8xx low level SPI driver header.
*
* @addtogroup SPI
* @{
*/
#ifndef _SPI_LLD_H_
#define _SPI_LLD_H_
#if HAL_USE_SPI || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
#define SPI_CFG_ENABLE (1<<0)
#define SPI_CFG_MASTER (1<<2)
#define SPI_CFG_LSBF (1<<3)
#define SPI_CFG_CHPA (1<<4)
#define SPI_CFG_CPOL (1<<5)
#define SPI_CFG_LOOP (1<<7)
#define SPI_CFG_SPOL (1<<8)
#define SPI_DLY_PRE(n) (((n)&0x0f)<< 0)
#define SPI_DLY_POST(n) (((n)&0x0f)<< 4)
#define SPI_DLY_FRAME(n) (((n)&0x0f)<< 8)
#define SPI_DLY_TFER(n) (((n)&0x0f)<<12)
#define SPI_STAT_RXRDY (1<<0)
#define SPI_STAT_TXRDY (1<<1)
#define SPI_STAT_RXOV (1<<2)
#define SPI_STAT_TXUR (1<<3)
#define SPI_STAT_SSA (1<<4)
#define SPI_STAT_SSD (1<<5)
#define SPI_STAT_STALL (1<<6)
#define SPI_STAT_EOT (1<<7)
#define SPI_STAT_IDLE (1<<8)
#define SPI_TXCTRL_TXSSELN (1<<16)
#define SPI_TXCTRL_EOT (1<<20)
#define SPI_TXCTRL_EOF (1<<21)
#define SPI_TXCTRL_RXIGNORE (1<<22)
#define SPI_TXCTRL_FLEN(n) (((n)-1)<<24)
#define SPI_TXCTRL_FLEN_MASK (0x0f<<24)
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @brief SPI1 driver enable switch.
* @details If set to @p TRUE the support for device SPI0 is included.
* @note The default is @p TRUE.
*/
#if !defined(LPC8xx_SPI_USE_SPI0) || defined(__DOXYGEN__)
#define LPC8xx_SPI_USE_SPI0 TRUE
#endif
/**
* @brief SPI2 driver enable switch.
* @details If set to @p TRUE the support for device SPI1 is included.
* @note The default is @p TRUE.
*/
#if !defined(LPC8xx_SPI_USE_SPI1) || defined(__DOXYGEN__)
#define LPC8xx_SPI_USE_SPI1 FALSE
#endif
/**
* @brief SPI0 PCLK divider.
*/
#if !defined(LPC8xx_SPI_SPI0CLKDIV) || defined(__DOXYGEN__)
#define LPC8xx_SPI_SPI0CLKDIV 1
#endif
/**
* @brief SPI1 PCLK divider.
*/
#if !defined(LPC8xx_SPI_SPI1CLKDIV) || defined(__DOXYGEN__)
#define LPC8xx_SPI_SPI1CLKDIV 1
#endif
/**
* @brief SPI0 interrupt priority level setting.
*/
#if !defined(LPC8xx_SPI_SPI0_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define LPC8xx_SPI_SPI0_IRQ_PRIORITY 1
#endif
/**
* @brief SPI1 interrupt priority level setting.
*/
#if !defined(LPC8xx_SPI_SPI1_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define LPC8xx_SPI_SPI1_IRQ_PRIORITY 1
#endif
/**
* @brief Overflow error hook.
* @details The default action is to stop the system.
*/
#if !defined(LPC8xx_SPI_ERROR_HOOK) || defined(__DOXYGEN__)
#define LPC8xx_SPI_ERROR_HOOK(spip) chSysHalt()
#endif
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if (LPC8xx_SPI_SPI0CLKDIV < 1) || (LPC8xx_SPI_SPI0CLKDIV > 255)
#error "invalid LPC8xx_SPI_SSP0CLKDIV setting"
#endif
#if (LPC8xx_SPI_SPI1CLKDIV < 1) || (LPC8xx_SPI_SPI1CLKDIV > 255)
#error "invalid LPC8xx_SPI_SSP1CLKDIV setting"
#endif
#if !LPC8xx_SPI_USE_SPI0 && !LPC8xx_SPI_USE_SPI1
#error "SPI driver activated but no SPI peripheral assigned"
#endif
/**
* @brief SPI0 clock.
*/
#define LPC8xx_SPI_SPI0_PCLK \
(LPC8xx_SYSCLK / LPC8xx_SPI_SPI0CLKDIV)
/**
* @brief SPI1 clock.
*/
#define LPC8xx_SPI_SPI1_PCLK \
(LPC8xx_SYSCLK / LPC8xx_SPI_SPI1CLKDIV)
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a structure representing an SPI driver.
*/
typedef struct SPIDriver SPIDriver;
/**
* @brief SPI notification callback type.
*
* @param[in] spip pointer to the @p SPIDriver object triggering the
* callback
*/
typedef void (*spicallback_t)(SPIDriver *spip);
/**
* @brief Driver configuration structure.
*/
typedef struct {
/**
* @brief Operation complete callback or @p NULL.
*/
spicallback_t end_cb;
/* End of the mandatory fields.*/
/**
* @brief SPI CFG initialization data.
*/
uint16_t cfg;
/**
* @brief SPI DLY initialization data.
*/
uint16_t dly;
/**
* @brief SPI TXCTRL initialization data.
*/
uint32_t txctrl;
} SPIConfig;
/**
* @brief Structure representing a SPI driver.
*/
struct SPIDriver {
/**
* @brief Driver state.
*/
spistate_t state;
/**
* @brief Current configuration data.
*/
const SPIConfig *config;
#if SPI_USE_WAIT || defined(__DOXYGEN__)
/**
* @brief Waiting thread.
*/
Thread *thread;
#endif /* SPI_USE_WAIT */
#if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)
#if CH_CFG_USE_MUTEXES || defined(__DOXYGEN__)
/**
* @brief Mutex protecting the bus.
*/
Mutex mutex;
#elif CH_CFG_USE_SEMAPHORES
Semaphore semaphore;
#endif
#endif /* SPI_USE_MUTUAL_EXCLUSION */
#if defined(SPI_DRIVER_EXT_FIELDS)
SPI_DRIVER_EXT_FIELDS
#endif
/* End of the mandatory fields.*/
/**
* @brief Pointer to the SPI registers block.
*/
LPC_SPI_TypeDef *spi;
/**
* @brief Number of words yet to be received.
*/
uint32_t rxcnt;
/**
* @brief Receive pointer or @p NULL.
*/
void *rxptr;
/**
* @brief Number of words yet to be transmitted.
*/
uint32_t txcnt;
/**
* @brief Transmit pointer or @p NULL.
*/
const void *txptr;
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#if LPC8xx_SPI_USE_SPI0 && !defined(__DOXYGEN__)
extern SPIDriver SPID1;
#endif
#if LPC8xx_SPI_USE_SPI1 && !defined(__DOXYGEN__)
extern SPIDriver SPID2;
#endif
#ifdef __cplusplus
extern "C" {
#endif
void spi_lld_init(void);
void spi_lld_start(SPIDriver *spip);
void spi_lld_stop(SPIDriver *spip);
void spi_lld_select(SPIDriver *spip);
void spi_lld_unselect(SPIDriver *spip);
void spi_lld_ignore(SPIDriver *spip, size_t n);
void spi_lld_exchange(SPIDriver *spip, size_t n,
const void *txbuf, void *rxbuf);
void spi_lld_send(SPIDriver *spip, size_t n, const void *txbuf);
void spi_lld_receive(SPIDriver *spip, size_t n, void *rxbuf);
uint16_t spi_lld_polled_exchange(SPIDriver *spip, uint16_t frame);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_SPI */
#endif /* _SPI_LLD_H_ */
/** @} */
|
