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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
/*
ChibiOS - Copyright (C) 2006..2018 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 hal_wspi.h
* @brief WSPI Driver macros and structures.
*
* @addtogroup WSPI
* @{
*/
#ifndef HAL_WSPI_H
#define HAL_WSPI_H
#if (HAL_USE_WSPI == TRUE) || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/**
* @name Transfer options
* @note The Low Level Driver should undef those modes that are not
* supported. The LLD can also define additional modes or reorder
* the bit masks in a more convenient way for the underlying
* implementation. It is important however to maintain the same
* same for the same functionality.
* @{
*/
#define WSPI_CFG_INSTRUCTION_MODE_MASK (7LU << 0LU)
#define WSPI_CFG_INSTRUCTION_MODE_NONE (0LU << 0LU)
#define WSPI_CFG_INSTRUCTION_MODE_ONE_LINES (1LU << 0LU)
#define WSPI_CFG_INSTRUCTION_MODE_TWO_LINES (2LU << 0LU)
#define WSPI_CFG_INSTRUCTION_MODE_FOUR_LINES (3LU << 0LU)
#define WSPI_CFG_INSTRUCTION_MODE_EIGHT_LINES (4LU << 0LU)
#define WSPI_CFG_INSTRUCTION_DDR (1LU << 3LU)
#define WSPI_CFG_INSTRUCTION_SIZE_MASK (3LU << 4LU)
#define WSPI_CFG_INSTRUCTION_SIZE_8 (0LU << 4LU)
#define WSPI_CFG_INSTRUCTION_SIZE_16 (1LU << 4LU)
#define WSPI_CFG_INSTRUCTION_SIZE_24 (2LU << 4LU)
#define WSPI_CFG_INSTRUCTION_SIZE_32 (3LU << 4LU)
#define WSPI_CFG_ADDR_MODE_MASK (7LU << 8LU)
#define WSPI_CFG_ADDR_MODE_NONE (0LU << 8LU)
#define WSPI_CFG_ADDR_MODE_ONE_LINE (1LU << 8LU)
#define WSPI_CFG_ADDR_MODE_TWO_LINES (2LU << 8LU)
#define WSPI_CFG_ADDR_MODE_FOUR_LINES (3LU << 8LU)
#define WSPI_CFG_ADDR_MODE_EIGHT_LINES (4LU << 8LU)
#define WSPI_CFG_ADDR_DDR (1LU << 11LU)
#define WSPI_CFG_ADDR_SIZE_MASK (3LU << 12LU)
#define WSPI_CFG_ADDR_SIZE_8 (0LU << 12LU)
#define WSPI_CFG_ADDR_SIZE_16 (1LU << 12LU)
#define WSPI_CFG_ADDR_SIZE_24 (2LU << 12LU)
#define WSPI_CFG_ADDR_SIZE_32 (3LU << 12LU)
#define WSPI_CFG_ALT_MODE_MASK (7LU << 16LU)
#define WSPI_CFG_ALT_MODE_NONE (0LU << 16LU)
#define WSPI_CFG_ALT_MODE_ONE_LINE (1LU << 16LU)
#define WSPI_CFG_ALT_MODE_TWO_LINES (2LU << 16LU)
#define WSPI_CFG_ALT_MODE_FOUR_LINES (3LU << 16LU)
#define WSPI_CFG_ALT_MODE_EIGHT_LINES (4LU << 16LU)
#define WSPI_CFG_ALT_DDR (1LU << 19LU)
#define WSPI_CFG_ALT_SIZE_MASK (3LU << 20LU)
#define WSPI_CFG_ALT_SIZE_8 (0LU << 20LU)
#define WSPI_CFG_ALT_SIZE_16 (1LU << 20LU)
#define WSPI_CFG_ALT_SIZE_24 (2LU << 20LU)
#define WSPI_CFG_ALT_SIZE_32 (3LU << 20LU)
#define WSPI_CFG_DATA_MODE_MASK (7LU << 24LU)
#define WSPI_CFG_DATA_MODE_NONE (0LU << 24LU)
#define WSPI_CFG_DATA_MODE_ONE_LINE (1LU << 24LU)
#define WSPI_CFG_DATA_MODE_TWO_LINES (2LU << 24LU)
#define WSPI_CFG_DATA_MODE_FOUR_LINES (3LU << 24LU)
#define WSPI_CFG_DATA_MODE_EIGHT_LINES (4LU << 24LU)
#define WSPI_CFG_DATA_DDR (1LU << 27LU)
#define WSPI_CFG_SIOO (1LU << 31LU)
/** @} */
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name WSPI configuration options
* @{
*/
/**
* @brief Enables synchronous APIs.
* @note Disabling this option saves both code and data space.
*/
#if !defined(WSPI_USE_WAIT) || defined(__DOXYGEN__)
#define WSPI_USE_WAIT TRUE
#endif
/**
* @brief Enables the @p wspiAcquireBus() and @p wspiReleaseBus() APIs.
* @note Disabling this option saves both code and data space.
*/
#if !defined(WSPI_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
#define WSPI_USE_MUTUAL_EXCLUSION TRUE
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Driver state machine possible states.
*/
typedef enum {
WSPI_UNINIT = 0, /**< Not initialized. */
WSPI_STOP = 1, /**< Stopped. */
WSPI_READY = 2, /**< Ready. */
WSPI_ACTIVE = 3, /**< Exchanging data. */
WSPI_COMPLETE = 4, /**< Asynchronous operation complete. */
WSPI_MEMMAP = 5 /**< In memory mapped mode. */
} wspistate_t;
/**
* @brief Type of a WSPI command descriptor.
*/
typedef struct {
/**
* @brief Transfer configuration field.
*/
uint32_t cfg;
/**
* @brief Command phase data.
*/
uint32_t cmd;
/**
* @brief Address phase data.
*/
uint32_t addr;
/**
* @brief Alternate phase data.
*/
uint32_t alt;
/**
* @brief Number of dummy cycles to be inserted.
*/
uint32_t dummy;
} wspi_command_t;
#include "hal_wspi_lld.h"
#if !defined(WSPI_SUPPORTS_MEMMAP)
#error "low level does not define WSPI_SUPPORTS_MEMMAP"
#endif
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @name Macro Functions
* @{
*/
/**
* @brief Sends a command without data phase.
* @post At the end of the operation the configured callback is invoked.
*
* @param[in] wspip pointer to the @p WSPIDriver object
* @param[in] cmdp pointer to the command descriptor
*
* @iclass
*/
#define wspiStartCommandI(wspip, cmdp) { \
osalDbgAssert(((cmdp)->cfg & WSPI_CFG_DATA_MODE_MASK) == \
WSPI_CFG_DATA_MODE_NONE, \
"data mode specified"); \
(wspip)->state = WSPI_ACTIVE; \
wspi_lld_command(wspip, cmdp); \
}
/**
* @brief Sends data over the WSPI bus.
* @details This asynchronous function starts a transmit operation.
* @post At the end of the operation the configured callback is invoked.
*
* @param[in] wspip pointer to the @p WSPIDriver object
* @param[in] cmdp pointer to the command descriptor
* @param[in] n number of bytes to send or zero if no data phase
* @param[in] txbuf the pointer to the transmit buffer
*
* @iclass
*/
#define wspiStartSendI(wspip, cmdp, n, txbuf) { \
osalDbgAssert(((cmdp)->cfg & WSPI_CFG_DATA_MODE_MASK) != \
WSPI_CFG_DATA_MODE_NONE, \
"data mode required"); \
(wspip)->state = WSPI_ACTIVE; \
wspi_lld_send(wspip, cmdp, n, txbuf); \
}
/**
* @brief Receives data from the WSPI bus.
* @details This asynchronous function starts a receive operation.
* @post At the end of the operation the configured callback is invoked.
*
* @param[in] wspip pointer to the @p WSPIDriver object
* @param[in] cmdp pointer to the command descriptor
* @param[in] n number of bytes to receive or zero if no data phase
* @param[out] rxbuf the pointer to the receive buffer
*
* @iclass
*/
#define wspiStartReceiveI(wspip, cmdp, n, rxbuf) { \
osalDbgAssert(((cmdp)->cfg & WSPI_CFG_DATA_MODE_MASK) != \
WSPI_CFG_DATA_MODE_NONE, \
"data mode required"); \
(wspip)->state = WSPI_ACTIVE; \
wspi_lld_receive(wspip, cmdp, n, rxbuf); \
}
#if (WSPI_SUPPORTS_MEMMAP == TRUE) || defined(__DOXYGEN__)
/**
* @brief Maps in memory space a WSPI flash device.
* @pre The memory flash device must be initialized appropriately
* before mapping it in memory space.
*
* @param[in] wspip pointer to the @p WSPIDriver object
* @param[in] cmdp pointer to the command descriptor
* @param[out] addrp pointer to the memory start address of the mapped
* flash or @p NULL
*
* @iclass
*/
#define wspiMapFlashI(wspip, cmdp, addrp) \
wspi_lld_map_flash(wspip, cmdp, addrp)
/**
* @brief Maps in memory space a WSPI flash device.
* @post The memory flash device must be re-initialized for normal
* commands exchange.
*
* @param[in] wspip pointer to the @p WSPIDriver object
*
* @iclass
*/
#define wspiUnmapFlashI(wspip) \
wspi_lld_unmap_flash(wspip)
#endif /* WSPI_SUPPORTS_MEMMAP == TRUE */
/** @} */
/**
* @name Low level driver helper macros
* @{
*/
#if (WSPI_USE_WAIT == TRUE) || defined(__DOXYGEN__)
/**
* @brief Wakes up the waiting thread.
*
* @param[in] wspip pointer to the @p WSPIDriver object
*
* @notapi
*/
#define _wspi_wakeup_isr(wspip) { \
osalSysLockFromISR(); \
osalThreadResumeI(&(wspip)->thread, MSG_OK); \
osalSysUnlockFromISR(); \
}
#else /* !WSPI_USE_WAIT */
#define _wspi_wakeup_isr(wspip)
#endif /* !WSPI_USE_WAIT */
/**
* @brief Common ISR code.
* @details This code handles the portable part of the ISR code:
* - Callback invocation.
* - Waiting thread wakeup, if any.
* - Driver state transitions.
* .
* @note This macro is meant to be used in the low level drivers
* implementation only.
*
* @param[in] wspip pointer to the @p WSPIDriver object
*
* @notapi
*/
#define _wspi_isr_code(wspip) { \
if ((wspip)->config->end_cb) { \
(wspip)->state = WSPI_COMPLETE; \
(wspip)->config->end_cb(wspip); \
if ((wspip)->state == WSPI_COMPLETE) \
(wspip)->state = WSPI_READY; \
} \
else \
(wspip)->state = WSPI_READY; \
_wspi_wakeup_isr(wspip); \
}
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void wspiInit(void);
void wspiObjectInit(WSPIDriver *wspip);
void wspiStart(WSPIDriver *wspip, const WSPIConfig *config);
void wspiStop(WSPIDriver *wspip);
void wspiStartCommand(WSPIDriver *wspip, const wspi_command_t *cmdp);
void wspiStartSend(WSPIDriver *wspip, const wspi_command_t *cmdp,
size_t n, const uint8_t *txbuf);
void wspiStartReceive(WSPIDriver *wspip, const wspi_command_t *cmdp,
size_t n, uint8_t *rxbuf);
#if WSPI_USE_WAIT == TRUE
void wspiCommand(WSPIDriver *wspip, const wspi_command_t *cmdp);
void wspiSend(WSPIDriver *wspip, const wspi_command_t *cmdp,
size_t n, const uint8_t *txbuf);
void wspiReceive(WSPIDriver *wspip, const wspi_command_t *cmdp,
size_t n, uint8_t *rxbuf);
#endif
#if WSPI_SUPPORTS_MEMMAP == TRUE
void wspiMapFlash(WSPIDriver *wspip,
const wspi_command_t *cmdp,
uint8_t **addrp);
void wspiUnmapFlash(WSPIDriver *wspip);
#endif
#if WSPI_USE_MUTUAL_EXCLUSION == TRUE
void wspiAcquireBus(WSPIDriver *wspip);
void wspiReleaseBus(WSPIDriver *wspip);
#endif
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_WSPI == TRUE */
#endif /* HAL_WSPI_H */
/** @} */
|
