aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/sdc.h
blob: 82b083125787c5c7d319dc72fbc2daa14c9a3708 (plain)
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
/*
    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
                 2011,2012 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    sdc.h
 * @brief   SDC Driver macros and structures.
 *
 * @addtogroup SDC
 * @{
 */

#ifndef _SDC_H_
#define _SDC_H_

#if HAL_USE_SDC || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver constants.                                                         */
/*===========================================================================*/

#define SDC_BLOCK_SIZE                  512     /**< Fixed block size.      */

/**
 * @brief   Fixed pattern for CMD8.
 */
#define SDC_CMD8_PATTERN                0x000001AA

/**
 * @name    SD cart types
 * @{
 */
#define SDC_MODE_CARDTYPE_MASK          0xF     /**< @brief Card type mask. */
#define SDC_MODE_CARDTYPE_SDV11         0       /**< @brief Card is SD V1.1.*/
#define SDC_MODE_CARDTYPE_SDV20         1       /**< @brief Card is SD V2.0.*/
#define SDC_MODE_CARDTYPE_MMC           2       /**< @brief Card is MMC.    */
#define SDC_MODE_HIGH_CAPACITY          0x10    /**< @brief High cap.card.  */
/** @} */

/**
 * @brief   Mask of error bits in R1 responses.
 */
#define SDC_R1_ERROR_MASK               0xFDFFE008

#define SDC_STS_IDLE                    0
#define SDC_STS_READY                   1
#define SDC_STS_IDENT                   2
#define SDC_STS_STBY                    3
#define SDC_STS_TRAN                    4
#define SDC_STS_DATA                    5
#define SDC_STS_RCV                     6
#define SDC_STS_PRG                     7
#define SDC_STS_DIS                     8

#define SDC_CMD_GO_IDLE_STATE           0
#define SDC_CMD_INIT                    1
#define SDC_CMD_ALL_SEND_CID            2
#define SDC_CMD_SEND_RELATIVE_ADDR      3
#define SDC_CMD_SET_BUS_WIDTH           6
#define SDC_CMD_SEL_DESEL_CARD          7
#define SDC_CMD_SEND_IF_COND            8
#define SDC_CMD_SEND_CSD                9
#define SDC_CMD_STOP_TRANSMISSION       12
#define SDC_CMD_SEND_STATUS             13
#define SDC_CMD_SET_BLOCKLEN            16
#define SDC_CMD_READ_SINGLE_BLOCK       17
#define SDC_CMD_READ_MULTIPLE_BLOCK     18
#define SDC_CMD_SET_BLOCK_COUNT         23
#define SDC_CMD_WRITE_BLOCK             24
#define SDC_CMD_WRITE_MULTIPLE_BLOCK    25
#define SDC_CMD_APP_OP_COND             41
#define SDC_CMD_LOCK_UNLOCK             42
#define SDC_CMD_APP_CMD                 55

/**
 * @name    SDC bus error conditions
 * @{
 */
#define SDC_NO_ERROR          0           /**< @brief No error.              */
#define SDC_CMD_CRC_ERROR     1           /**< @brief Command CRC error.     */
#define SDC_DATA_CRC_ERROR    2           /**< @brief Data CRC error.        */
#define SDC_DATA_TIMEOUT      4           /**< @brief Hardware write timeout.*/
#define SDC_COMMAND_TIMEOUT   8           /**< @brief Hardware read timeout. */
#define SDC_TX_UNDERRUN       16          /**< @brief TX buffer underrun.    */
#define SDC_RX_OVERRUN        32          /**< @brief RX buffer overrun.     */
#define SDC_STARTBIT_ERROR    64          /**< @brief Start bit not detected.*/
#define SDC_OVERFLOW_ERROR    128         /**< @brief Card overflow error.   */
#define SDC_UNHANDLED_ERROR   0xFFFFFFFF

/*===========================================================================*/
/* Driver pre-compile time settings.                                         */
/*===========================================================================*/

/**
 * @name    SDC configuration options
 * @{
 */
/**
 * @brief   Number of initialization attempts before rejecting the card.
 * @note    Attempts are performed at 10mS intervals.
 */
#if !defined(SDC_INIT_RETRY) || defined(__DOXYGEN__)
#define SDC_INIT_RETRY                  100
#endif

/**
 * @brief   Include support for MMC cards.
 * @note    MMC support is not yet implemented so this option must be kept
 *          at @p FALSE.
 */
#if !defined(SDC_MMC_SUPPORT) || defined(__DOXYGEN__)
#define SDC_MMC_SUPPORT                 FALSE
#endif

/**
 * @brief   Delays insertions.
 * @details If enabled this options inserts delays into the MMC waiting
 *          routines releasing some extra CPU time for the threads with
 *          lower priority, this may slow down the driver a bit however.
 */
#if !defined(SDC_NICE_WAITING) || defined(__DOXYGEN__)
#define SDC_NICE_WAITING                TRUE
#endif
/** @} */

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/*===========================================================================*/
/* Driver data structures and types.                                         */
/*===========================================================================*/

/**
 * @brief   Driver state machine possible states.
 */
typedef enum {
  SDC_UNINIT = 0,                   /**< Not initialized.                   */
  SDC_STOP = 1,                     /**< Stopped.                           */
  SDC_READY = 2,                    /**< Ready.                             */
  SDC_CONNECTING = 3,               /**< Card connection in progress.       */
  SDC_DISCONNECTING = 4,            /**< Card disconnection in progress.    */
  SDC_ACTIVE = 5,                   /**< Cart initialized.                  */
  SDC_READING = 6,                  /**< Read operation in progress.        */
  SDC_WRITING = 7,                  /**< Write operation in progress.       */
} sdcstate_t;

#include "sdc_lld.h"

/*===========================================================================*/
/* Driver macros.                                                            */
/*===========================================================================*/

/**
 * @name    R1 response utilities
 * @{
 */
/**
 * @brief   Evaluates to @p TRUE if the R1 response contains error flags.
 *
 * @param[in] r1        the r1 response
 */
#define SDC_R1_ERROR(r1)                (((r1) & SDC_R1_ERROR_MASK) != 0)

/**
 * @brief   Returns the status field of an R1 response.
 *
 * @param[in] r1        the r1 response
 */
#define SDC_R1_STS(r1)                  (((r1) >> 9) & 15)

/**
 * @brief   Evaluates to @p TRUE if the R1 response indicates a locked card.
 *
 * @param[in] r1        the r1 response
 */
#define SDC_R1_IS_CARD_LOCKED(r1)       (((r1) >> 21) & 1)
/** @} */

/**
 * @name    Macro Functions
 * @{
 */
/**
 * @brief   Returns the driver state.
 *
 * @param[in] sdcp      pointer to the @p SDCDriver object
 * @return              The driver state.
 *
 * @api
 */
#define sdcGetDriverState(sdcp)         ((sdcp)->state)

/**
 * @brief   Returns the card insertion status.
 * @note    This macro wraps a low level function named
 *          @p sdc_lld_is_card_inserted(), this function must be
 *          provided by the application because it is not part of the
 *          SDC driver.
 *
 * @param[in] sdcp      pointer to the @p SDCDriver object
 * @return              The card state.
 * @retval FALSE        card not inserted.
 * @retval TRUE         card inserted.
 *
 * @api
 */
#define sdcIsCardInserted(sdcp) (sdc_lld_is_card_inserted(sdcp))

/**
 * @brief   Returns the write protect status.
 * @note    This macro wraps a low level function named
 *          @p sdc_lld_is_write_protected(), this function must be
 *          provided by the application because it is not part of the
 *          SDC driver.
 *
 * @param[in] sdcp      pointer to the @p SDCDriver object
 * @return              The card state.
 * @retval FALSE        not write protected.
 * @retval TRUE         write protected.
 *
 * @api
 */
#define sdcIsWriteProtected(sdcp) (sdc_lld_is_write_protected(sdcp))

/**
 * @brief   Returns the card capacity in blocks.
 *
 * @param[in] sdcp      pointer to the @p SDCDriver object
 * @return              The card capacity.
 *
 * @api
 */
#define sdcGetCardCapacity(sdcp)  ((sdcp)->capacity)
/** @} */

/**
 * @name   CSD record offsets
 */
/**
 * @brief  Slice position of values in CSD register.
 */
/* CSD version 2.0 */
#define SDC_CSD_20_CRC_SLICE                7,1
#define SDC_CSD_20_FILE_FORMAT_SLICE        11,10
#define SDC_CSD_20_TMP_WRITE_PROTECT_SLICE  12,12
#define SDC_CSD_20_PERM_WRITE_PROTECT_SLICE 13,13
#define SDC_CSD_20_COPY_SLICE               14,14
#define SDC_CSD_20_FILE_FORMAT_GRP_SLICE    15,15
#define SDC_CSD_20_WRITE_BL_PARTIAL_SLICE   21,21
#define SDC_CSD_20_WRITE_BL_LEN_SLICE       25,12
#define SDC_CSD_20_R2W_FACTOR_SLICE         28,26
#define SDC_CSD_20_WP_GRP_ENABLE_SLICE      31,31
#define SDC_CSD_20_WP_GRP_SIZE_SLICE        38,32
#define SDC_CSD_20_ERASE_SECTOR_SIZE_SLICE  45,39
#define SDC_CSD_20_ERASE_BLK_EN_SLICE       46,46
#define SDC_CSD_20_C_SIZE_SLICE             69,48
#define SDC_CSD_20_DSR_IMP_SLICE            76,76
#define SDC_CSD_20_READ_BLK_MISALIGN_SLICE  77,77
#define SDC_CSD_20_WRITE_BLK_MISALIGN_SLICE 78,78
#define SDC_CSD_20_READ_BL_PARTIAL_SLICE    79,79
#define SDC_CSD_20_READ_BL_LEN_SLICE        83,80
#define SDC_CSD_20_CCC_SLICE                95,84
#define SDC_CSD_20_TRANS_SPEED_SLICE        103,96
#define SDC_CSD_20_NSAC_SLICE               111,104
#define SDC_CSD_20_TAAC_SLICE               119,112
#define SDC_CSD_20_STRUCTURE_SLICE          127,126

/* CSD version 1.0 */
#define SDC_CSD_10_CRC_SLICE                SDC_CSD_20_CRC_SLICE
#define SDC_CSD_10_FILE_FORMAT_SLICE        SDC_CSD_20_FILE_FORMAT_SLICE
#define SDC_CSD_10_TMP_WRITE_PROTECT_SLICE  SDC_CSD_20_TMP_WRITE_PROTECT_SLICE
#define SDC_CSD_10_PERM_WRITE_PROTECT_SLICE SDC_CSD_20_PERM_WRITE_PROTECT_SLICE
#define SDC_CSD_10_COPY_SLICE               SDC_CSD_20_COPY_SLICE
#define SDC_CSD_10_FILE_FORMAT_GRP_SLICE    SDC_CSD_20_FILE_FORMAT_GRP_SLICE
#define SDC_CSD_10_WRITE_BL_PARTIAL_SLICE   SDC_CSD_20_WRITE_BL_PARTIAL_SLICE
#define SDC_CSD_10_WRITE_BL_LEN_SLICE       SDC_CSD_20_WRITE_BL_LEN_SLICE
#define SDC_CSD_10_R2W_FACTOR_SLICE         SDC_CSD_20_R2W_FACTOR_SLICE
#define SDC_CSD_10_WP_GRP_ENABLE_SLICE      SDC_CSD_20_WP_GRP_ENABLE_SLICE
#define SDC_CSD_10_WP_GRP_SIZE_SLICE        SDC_CSD_20_WP_GRP_SIZE_SLICE
#define SDC_CSD_10_ERASE_SECTOR_SIZE_SLICE  SDC_CSD_20_ERASE_SECTOR_SIZE_SLICE
#define SDC_CSD_10_ERASE_BLK_EN_SLICE       SDC_CSD_20_ERASE_BLK_EN_SLICE
#define SDC_CSD_10_C_SIZE_MULT_SLICE        49,47
#define SDC_CSD_10_VDD_W_CURR_MAX_SLICE     52,50
#define SDC_CSD_10_VDD_W_CURR_MIN_SLICE     55,53
#define SDC_CSD_10_VDD_R_CURR_MAX_SLICE     58,56
#define SDC_CSD_10_VDD_R_CURR_MIX_SLICE     61,59
#define SDC_CSD_10_C_SIZE_SLICE             73,62
#define SDC_CSD_10_DSR_IMP_SLICE            SDC_CSD_20_DSR_IMP_SLICE
#define SDC_CSD_10_READ_BLK_MISALIGN_SLICE  SDC_CSD_20_READ_BLK_MISALIGN_SLICE
#define SDC_CSD_10_WRITE_BLK_MISALIGN_SLICE SDC_CSD_20_WRITE_BLK_MISALIGN_SLICE
#define SDC_CSD_10_READ_BL_PARTIAL_SLICE    SDC_CSD_20_READ_BL_PARTIAL_SLICE
#define SDC_CSD_10_READ_BL_LEN_SLICE        83, 80
#define SDC_CSD_10_CCC_SLICE                SDC_CSD_20_CCC_SLICE
#define SDC_CSD_10_TRANS_SPEED_SLICE        SDC_CSD_20_TRANS_SPEED_SLICE
#define SDC_CSD_10_NSAC_SLICE               SDC_CSD_20_NSAC_SLICE
#define SDC_CSD_10_TAAC_SLICE               SDC_CSD_20_TAAC_SLICE
#define SDC_CSD_10_STRUCTURE_SLICE          SDC_CSD_20_STRUCTURE_SLICE
/** @} */

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif
  void sdcInit(void);
  void sdcObjectInit(SDCDriver *sdcp);
  void sdcStart(SDCDriver *sdcp, const SDCConfig *config);
  void sdcStop(SDCDriver *sdcp);
  bool_t sdcConnect(SDCDriver *sdcp);
  bool_t sdcDisconnect(SDCDriver *sdcp);
  bool_t sdcRead(SDCDriver *sdcp, uint32_t startblk,
                 uint8_t *buffer, uint32_t n);
  bool_t sdcWrite(SDCDriver *sdcp, uint32_t startblk,
                  const uint8_t *buffer, uint32_t n);
  sdcflags_t sdcGetAndClearErrors(SDCDriver *sdcp);
  bool_t _sdc_wait_for_transfer_state(SDCDriver *sdcp);
#ifdef __cplusplus
}
#endif

#endif /* HAL_USE_SDC */

#endif /* _SDC_H_ */

/** @} */