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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
|
/******************************************************************************
*
* Microchip Memory Disk Drive File System
*
******************************************************************************
* FileName: SD-SPI.h
* Dependencies: GenericTypeDefs.h
* FSconfig.h
* FSDefs.h
* Processor: PIC18/PIC24/dsPIC30/dsPIC33/PIC32
* Compiler: C18/C30/C32
* Company: Microchip Technology, Inc.
* Version: 1.2.0
*
* Software License Agreement
*
* The software supplied herewith by Microchip Technology Incorporated
* (the “Company”) for its PICmicro® Microcontroller is intended and
* supplied to you, the Company’s customer, for use solely and
* exclusively on Microchip PICmicro Microcontroller products. The
* software is owned by the Company and/or its supplier, and is
* protected under applicable copyright laws. All rights are reserved.
* Any use in violation of the foregoing restrictions may subject the
* user to criminal sanctions under applicable laws, as well as to
* civil liability for the breach of the terms and conditions of this
* license.
*
* THIS SOFTWARE IS PROVIDED IN AN “AS IS” CONDITION. NO WARRANTIES,
* WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED
* TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,
* IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
* CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
*
*****************************************************************************/
#ifndef SDMMC_H
#define SDMMC_H
#include "GenericTypeDefs.h"
#include "FSconfig.h"
#include "FSDefs.h"
#ifdef __18CXX
// Description: This macro is used to initialize a PIC18 SPI module with a 4x prescale divider
#define SYNC_MODE_FAST 0x00
// Description: This macro is used to initialize a PIC18 SPI module with a 16x prescale divider
#define SYNC_MODE_MED 0x01
// Description: This macro is used to initialize a PIC18 SPI module with a 64x prescale divider
#define SYNC_MODE_SLOW 0x02
#elif defined __PIC32MX__
// Description: This macro is used to initialize a PIC32 SPI module
#define SYNC_MODE_FAST 0x3E
// Description: This macro is used to initialize a PIC32 SPI module
#define SYNC_MODE_SLOW 0x3C
#else
// Description: This macro indicates the SPI enable bit for 16-bit PICs
#ifndef MASTER_ENABLE_ON
#define MASTER_ENABLE_ON 0x0020
#endif
// Description: This macro is used to initialize a 16-bit PIC SPI module
#ifndef SYNC_MODE_FAST
#define SYNC_MODE_FAST 0x3E
#endif
// Description: This macro is used to initialize a 16-bit PIC SPI module
#ifndef SYNC_MODE_SLOW
#define SYNC_MODE_SLOW 0x3C
#endif
// Description: This macro is used to initialize a 16-bit PIC SPI module secondary prescaler
#ifndef SEC_PRESCAL_1_1
#define SEC_PRESCAL_1_1 0x001c
#endif
// Description: This macro is used to initialize a 16-bit PIC SPI module primary prescaler
#ifndef PRI_PRESCAL_1_1
#define PRI_PRESCAL_1_1 0x0003
#endif
#endif
/*****************************************************************/
/* Strcutures and defines */
/*****************************************************************/
// Description: This macro represents an SD card start token
#define DATA_START_TOKEN 0xFE
// Description: This macro represents an SD card data accepted token
#define DATA_ACCEPTED 0x05
// Description: This macro indicates that the SD card expects to transmit or receive more data
#define MOREDATA !0
// Description: This macro indicates that the SD card does not expect to transmit or receive more data
#define NODATA 0
// Description: This macro represents a floating SPI bus condition
#define MMC_FLOATING_BUS 0xFF
// Description: This macro represents a bad SD card response byte
#define MMC_BAD_RESPONSE MMC_FLOATING_BUS
// The SDMMC Commands
// Description: This macro defines the command code to reset the SD card
#define cmdGO_IDLE_STATE 0
// Description: This macro defines the command code to initialize the SD card
#define cmdSEND_OP_COND 1
// Description: This macro defines the command code to get the Card Specific Data
#define cmdSEND_CSD 9
// Description: This macro defines the command code to get the Card Information
#define cmdSEND_CID 10
// Description: This macro defines the command code to stop transmission during a multi-block read
#define cmdSTOP_TRANSMISSION 12
// Description: This macro defines the command code to get the card status information
#define cmdSEND_STATUS 13
// Description: This macro defines the command code to set the block length of the card
#define cmdSET_BLOCKLEN 16
// Description: This macro defines the command code to read one block from the card
#define cmdREAD_SINGLE_BLOCK 17
// Description: This macro defines the command code to read multiple blocks from the card
#define cmdREAD_MULTI_BLOCK 18
// Description: This macro defines the command code to write one block to the card
#define cmdWRITE_SINGLE_BLOCK 24
// Description: This macro defines the command code to write multiple blocks to the card
#define cmdWRITE_MULTI_BLOCK 25
// Description: This macro defines the command code to set the address of the start of an erase operation
#define cmdTAG_SECTOR_START 32
// Description: This macro defines the command code to set the address of the end of an erase operation
#define cmdTAG_SECTOR_END 33
// Description: This macro defines the command code to erase all previously selected blocks
#define cmdERASE 38
// Description: This macro defines the command code to begin application specific command inputs
#define cmdAPP_CMD 55
// Description: This macro defines the command code to get the OCR register information from the card
#define cmdREAD_OCR 58
// Description: This macro defines the command code to disable CRC checking
#define cmdCRC_ON_OFF 59
// Description: Enumeration of different SD response types
typedef enum
{
R1, // R1 type response
R1b, // R1b type response
R2, // R2 type response
R3 // R3 type response
}RESP;
// Summary: SD card command data structure
// Description: The typMMC_CMD structure is used to create a command table of information needed for each relevant SD command
typedef struct
{
BYTE CmdCode; // The command code
BYTE CRC; // The CRC value for that command
RESP responsetype; // The response type
BYTE moredataexpected; // Set to MOREDATA or NODATA, depending on whether more data is expected or not
} typMMC_CMD;
// Summary: An SD command packet
// Description: This union represents different ways to access an SD card command packet
typedef union
{
// This structure allows array-style access of command bytes
struct
{
#ifdef __18CXX
BYTE field[6]; // BYTE array
#else
BYTE field[7];
#endif
};
// This structure allows byte-wise access of packet command bytes
struct
{
BYTE crc; // The CRC byte
#if defined __C30__
BYTE c30filler; // Filler space (since bitwise declarations can't cross a WORD boundary)
#elif defined __C32__
BYTE c32filler[3]; // Filler space (since bitwise declarations can't cross a DWORD boundary)
#endif
BYTE addr0; // Address byte 0
BYTE addr1; // Address byte 1
BYTE addr2; // Address byte 2
BYTE addr3; // Address byte 3
BYTE cmd; // Command code byte
};
// This structure allows bitwise access to elements of the command bytes
struct
{
BYTE END_BIT:1; // Packet end bit
BYTE CRC7:7; // CRC value
DWORD address; // Address
BYTE CMD_INDEX:6; // Command code
BYTE TRANSMIT_BIT:1; // Transmit bit
BYTE START_BIT:1; // Packet start bit
};
} CMD_PACKET;
// Summary: The format of an R1 type response
// Description: This union represents different ways to access an SD card R1 type response packet.
typedef union
{
BYTE _byte; // Byte-wise access
// This structure allows bitwise access of the response
struct
{
unsigned IN_IDLE_STATE:1; // Card is in idle state
unsigned ERASE_RESET:1; // Erase reset flag
unsigned ILLEGAL_CMD:1; // Illegal command flag
unsigned CRC_ERR:1; // CRC error flag
unsigned ERASE_SEQ_ERR:1; // Erase sequence error flag
unsigned ADDRESS_ERR:1; // Address error flag
unsigned PARAM_ERR:1; // Parameter flag
unsigned B7:1; // Unused bit 7
};
} RESPONSE_1;
// Summary: The format of an R2 type response
// Description: This union represents different ways to access an SD card R2 type response packet
typedef union
{
WORD _word;
struct
{
BYTE _byte0;
BYTE _byte1;
};
struct
{
unsigned IN_IDLE_STATE:1;
unsigned ERASE_RESET:1;
unsigned ILLEGAL_CMD:1;
unsigned CRC_ERR:1;
unsigned ERASE_SEQ_ERR:1;
unsigned ADDRESS_ERR:1;
unsigned PARAM_ERR:1;
unsigned B7:1;
unsigned CARD_IS_LOCKED:1;
unsigned WP_ERASE_SKIP_LK_FAIL:1;
unsigned ERROR:1;
unsigned CC_ERROR:1;
unsigned CARD_ECC_FAIL:1;
unsigned WP_VIOLATION:1;
unsigned ERASE_PARAM:1;
unsigned OUTRANGE_CSD_OVERWRITE:1;
};
} RESPONSE_2;
// Summary: A union of responses from an SD card
// Description: The MMC_RESPONSE union represents any of the possible responses that an SD card can return after
// being issued a command.
typedef union
{
RESPONSE_1 r1;
RESPONSE_2 r2;
}MMC_RESPONSE;
// Summary: A description of the card specific data register
// Description: This union represents different ways to access information in a packet with SD card CSD informaiton. For more
// information on the CSD register, consult an SD card user's manual.
typedef union
{
struct
{
DWORD _u320;
DWORD _u321;
DWORD _u322;
DWORD _u323;
};
struct
{
BYTE _byte[16];
};
struct
{
unsigned NOT_USED :1;
unsigned CRC :7;
unsigned ECC :2;
unsigned FILE_FORMAT :2;
unsigned TMP_WRITE_PROTECT :1;
unsigned PERM_WRITE_PROTECT :1;
unsigned COPY :1;
unsigned FILE_FORMAT_GRP :1;
unsigned RESERVED_1 :5;
unsigned WRITE_BL_PARTIAL :1;
unsigned WRITE_BL_LEN_L :2;
unsigned WRITE_BL_LEN_H :2;
unsigned R2W_FACTOR :3;
unsigned DEFAULT_ECC :2;
unsigned WP_GRP_ENABLE :1;
unsigned WP_GRP_SIZE :5;
unsigned ERASE_GRP_SIZE_L :3;
unsigned ERASE_GRP_SIZE_H :2;
unsigned SECTOR_SIZE :5;
unsigned C_SIZE_MULT_L :1;
unsigned C_SIZE_MULT_H :2;
unsigned VDD_W_CURR_MAX :3;
unsigned VDD_W_CUR_MIN :3;
unsigned VDD_R_CURR_MAX :3;
unsigned VDD_R_CURR_MIN :3;
unsigned C_SIZE_L :2;
unsigned C_SIZE_H :8;
unsigned C_SIZE_U :2;
unsigned RESERVED_2 :2;
unsigned DSR_IMP :1;
unsigned READ_BLK_MISALIGN :1;
unsigned WRITE_BLK_MISALIGN :1;
unsigned READ_BL_PARTIAL :1;
unsigned READ_BL_LEN :4;
unsigned CCC_L :4;
unsigned CCC_H :8;
unsigned TRAN_SPEED :8;
unsigned NSAC :8;
unsigned TAAC :8;
unsigned RESERVED_3 :2;
unsigned SPEC_VERS :4;
unsigned CSD_STRUCTURE :2;
};
} CSD;
// Summary: A description of the card information register
// Description: This union represents different ways to access information in a packet with SD card CID register informaiton. For more
// information on the CID register, consult an SD card user's manual.
typedef union
{
struct
{
DWORD _u320;
DWORD _u321;
DWORD _u322;
DWORD _u323;
};
struct
{
BYTE _byte[16];
};
struct
{
unsigned NOT_USED :1;
unsigned CRC :7;
unsigned MDT :8;
DWORD PSN;
unsigned PRV :8;
char PNM[6];
WORD OID;
unsigned MID :8;
};
} CID;
#ifndef FALSE
#define FALSE 0
#endif
#ifndef TRUE
#define TRUE !FALSE
#endif
#define INPUT 1
#define OUTPUT 0
// Description: A delay prescaler
#define DELAY_PRESCALER (BYTE) 8
// Description: An approximation of the number of cycles per delay loop of overhead
#define DELAY_OVERHEAD (BYTE) 5
// Description: An approximate calculation of how many times to loop to delay 1 ms in the Delayms function
#define MILLISECDELAY (WORD) ((GetInstructionClock()/DELAY_PRESCALER/(WORD)1000) - DELAY_OVERHEAD)
// Summary: An enumeration of SD commands
// Description: This enumeration corresponds to the position of each command in the sdmmc_cmdtable array
// These macros indicate to the SendMMCCmd function which element of the sdmmc_cmdtable array
// to retrieve command code information from.
typedef enum
{
GO_IDLE_STATE,
SEND_OP_COND,
SEND_CSD,
SEND_CID,
STOP_TRANSMISSION,
SEND_STATUS,
SET_BLOCKLEN,
READ_SINGLE_BLOCK,
READ_MULTI_BLOCK,
WRITE_SINGLE_BLOCK,
WRITE_MULTI_BLOCK,
TAG_SECTOR_START,
TAG_SECTOR_END,
ERASE,
APP_CMD,
READ_OCR,
CRC_ON_OFF
}sdmmc_cmd;
/***************************************************************************/
/* Macros */
/***************************************************************************/
// Description: A macro to send clock cycles to dummy-read the CRC
#define mReadCRC() WriteSPIM(0xFF);WriteSPIM(0xFF);
// Description: A macro to send clock cycles to dummy-write the CRC
#define mSendCRC() WriteSPIM(0xFF);WriteSPIM(0xFF);
// Description: A macro to send 8 clock cycles for SD timing requirements
#define mSend8ClkCycles() WriteSPIM(0xFF);
/*****************************************************************************/
/* Prototypes */
/*****************************************************************************/
DWORD MDD_SDSPI_ReadCapacity(void);
WORD MDD_SDSPI_ReadSectorSize(void);
void MDD_SDSPI_InitIO(void);
BYTE MDD_SDSPI_MediaDetect(void);
BYTE MDD_SDSPI_MediaInitialize(void);
BYTE MDD_SDSPI_SectorRead(DWORD sector_addr, BYTE* buffer);
BYTE MDD_SDSPI_SectorWrite(DWORD sector_addr, BYTE* buffer, BYTE allowWriteToZero);
BYTE MDD_SDSPI_WriteProtectState(void);
BYTE MDD_SDSPI_ShutdownMedia(void);
#if defined __C30__ || defined __C32__
extern BYTE ReadByte( BYTE* pBuffer, WORD index );
extern WORD ReadWord( BYTE* pBuffer, WORD index );
extern DWORD ReadDWord( BYTE* pBuffer, WORD index );
#endif
#endif
|