sdcard_spi_internal.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Michel Rottleuthner <michel.rottleuthner@haw-hamburg.de>
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
24 #ifndef SDCARD_SPI_INTERNAL_H
25 #define SDCARD_SPI_INTERNAL_H
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 #include "periph/spi.h"
32 #include "periph/gpio.h"
33 #include "stdbool.h"
34 #include "sdcard_spi.h"
35 
36 
37 /* number of clocks that should be applied to the card on init
38  before taking further actions (see sd spec. 6.4.1.1 Power Up Time of Card) */
39 #define SD_POWERSEQUENCE_CLOCK_COUNT 74
40 
41 #define SD_CARD_PREINIT_CLOCK_PERIOD_US 10 /* used to generate 100 kHz clock in init phase*/
42 #define SD_CARD_WAIT_AFTER_POWER_UP_US 1000
43 
44 /* R1 response bits (see sd spec. 7.3.2.1 Format R1) */
45 #define SD_R1_RESPONSE_PARAM_ERROR (1<<6)
46 #define SD_R1_RESPONSE_ADDR_ERROR (1<<5)
47 #define SD_R1_RESPONSE_ERASE_SEQ_ERROR (1<<4)
48 #define SD_R1_RESPONSE_CMD_CRC_ERROR (1<<3)
49 #define SD_R1_RESPONSE_ILLEGAL_CMD_ERROR (1<<2)
50 #define SD_R1_RESPONSE_ERASE_RESET (1<<1)
51 #define SD_R1_RESPONSE_IN_IDLE_STATE (0x01)
52 #define SD_INVALID_R1_RESPONSE (1<<7)
53 
54 #define R1_VALID(X) (((X) >> 7) == 0)
55 #define R1_PARAM_ERR(X) ((((X) &SD_R1_RESPONSE_PARAM_ERROR) != 0))
56 #define R1_ADDR_ERR(X) ((((X) &SD_R1_RESPONSE_ADDR_ERROR) != 0))
57 #define R1_ERASE_ERR(X) ((((X) &SD_R1_RESPONSE_ERASE_SEQ_ERROR) != 0))
58 #define R1_CMD_CRC_ERR(X) ((((X) &SD_R1_RESPONSE_CMD_CRC_ERROR) != 0))
59 #define R1_ILL_CMD_ERR(X) ((((X) &SD_R1_RESPONSE_ILLEGAL_CMD_ERROR) != 0))
60 #define R1_IDLE_BIT_SET(X) (((X) &SD_R1_RESPONSE_IN_IDLE_STATE) != 0)
61 #define R1_ERROR(X) (R1_PARAM_ERR(X) || R1_ADDR_ERR(X) || R1_ERASE_ERR(X) || \
62  R1_CMD_CRC_ERR(X) || R1_ILL_CMD_ERR(X))
63 
64 /* see sd spec. 7.3.3.1 Data Response Token */
65 #define DATA_RESPONSE_IS_VALID(X) (((X) & 0x11) == 0x01)
66 #define DATA_RESPONSE_ACCEPTED(X) (((X) & 0x0E) == (1<<2))
67 #define DATA_RESPONSE_CRC_ERR(X) (((X) & 0x0E) == 0x0A)
68 #define DATA_RESPONSE_WRITE_ERR(X) (((X) & 0x0E) == 0x0C)
69 
70 /* see sd spec. 5.1 OCR register */
71 #define OCR_VOLTAGE_3_2_TO_3_3 (1L << 20)
72 #define OCR_VOLTAGE_3_3_TO_3_4 (1L << 21)
73 
74 /* card capacity status (CCS=0: the card is SDSD; CCS=1: card is SDHC or SDXC) */
75 #define OCR_CCS (1L << 30)
76 
77 /* This bit is set to low if the card has not finished power up routine */
78 #define OCR_POWER_UP_STATUS (1L << 31)
79 
80 /* to ensure the voltage range check on init is done properly you need to
81  define this according to your actual interface/wiring with the sd-card */
82 #define SYSTEM_VOLTAGE (OCR_VOLTAGE_3_2_TO_3_3 | OCR_VOLTAGE_3_2_TO_3_3)
83 
84 
85 /* see sd spec. 7.3.1.3 Detailed Command Description */
86 #define SD_CMD_PREFIX_MASK (1<<6)
87 
88 #define SD_CMD_0 0 /* Resets the SD Memory Card */
89 #define SD_CMD_1 1 /* Sends host capacity support info and starts the cards init process */
90 #define SD_CMD_8 8 /* Sends SD Card interface condition incl. host supply voltage info */
91 #define SD_CMD_9 9 /* Asks the selected card to send its card-specific data (CSD) */
92 #define SD_CMD_10 10 /* Asks the selected card to send its card identification (CID) */
93 #define SD_CMD_12 12 /* Forces the card to stop transmission in Multiple Block Read Operation */
94 #define SD_CMD_13 13 /* Sent as ACMD13 asks the card to send it's SD status */
95 
96 #define SD_CMD_16 16 /* In case of SDSC Card, block length is set by this command */
97 #define SD_CMD_17 17 /* Reads a block of the size selected by the SET_BLOCKLEN command */
98 #define SD_CMD_18 18 /* Continuously transfers data blocks from card to host
99  until interrupted by a STOP_TRANSMISSION command */
100 #define SD_CMD_24 24 /* Writes a block of the size selected by the SET_BLOCKLEN command */
101 #define SD_CMD_25 25 /* Continuously writes blocks of data until 'Stop Tran'token is sent */
102 #define SD_CMD_41 41 /* Reserved (used for ACMD41) */
103 #define SD_CMD_55 55 /* Defines to the card that the next command is an application specific
104  command rather than a standard command */
105 #define SD_CMD_58 58 /* Reads the OCR register of a card */
106 #define SD_CMD_59 59 /* Turns the CRC option on or off. Argument: 1:on; 0:off */
107 
108 #define SD_CMD_8_VHS_2_7_V_TO_3_6_V 0x01
109 #define SD_CMD_8_CHECK_PATTERN 0xB5
110 #define SD_CMD_NO_ARG 0x00000000
111 #define SD_ACMD_41_ARG_HC 0x40000000
112 #define SD_CMD_59_ARG_EN 0x00000001
113 #define SD_CMD_59_ARG_DIS 0x00000000
114 
115 /* see sd spec. 7.3.3 Control Tokens */
116 #define SD_DATA_TOKEN_CMD_17_18_24 0xFE
117 #define SD_DATA_TOKEN_CMD_25 0xFC
118 #define SD_DATA_TOKEN_CMD_25_STOP 0xFD
119 
120 #define SD_SIZE_OF_CID_AND_CSD_REG 16
121 #define SD_SIZE_OF_SD_STATUS 64
122 #define SD_BLOCKS_FOR_REG_READ 1
123 #define SD_GET_CSD_STRUCTURE(CSD_RAW_DATA) ((CSD_RAW_DATA)[0] >> 6)
124 #define SD_CSD_V1 0
125 #define SD_CSD_V2 1
126 #define SD_CSD_VUNSUPPORTED -1
127 
137 #ifndef INIT_CMD_RETRY_US
138 #define INIT_CMD_RETRY_US (250 * US_PER_MS)
139 #endif
140 #ifndef INIT_CMD0_RETRY_US
141 #define INIT_CMD0_RETRY_US (100UL)
142 #endif
143 #ifndef R1_POLLING_RETRY_US
144 #define R1_POLLING_RETRY_US (100 * US_PER_MS)
145 #endif
146 #ifndef SD_DATA_TOKEN_RETRY_US
147 #define SD_DATA_TOKEN_RETRY_US (100 * US_PER_MS)
148 #endif
149 #ifndef SD_WAIT_FOR_NOT_BUSY_US
150 #define SD_WAIT_FOR_NOT_BUSY_US (250 * US_PER_MS)
151 #endif
152 #ifndef SD_BLOCK_READ_CMD_RETRY_US
153 #define SD_BLOCK_READ_CMD_RETRY_US (100UL)
154 #endif
155 #ifndef SD_BLOCK_WRITE_CMD_RETRY_US
156 #define SD_BLOCK_WRITE_CMD_RETRY_US (100UL)
157 #endif
158 
163 #define SD_CSD_V2_C_SIZE_BLOCK_MULT 1024
164 
168 #ifndef SD_CARD_SPI_MODE
169 #define SD_CARD_SPI_MODE SPI_MODE_0
170 #endif
171 
175 #ifndef SD_CARD_SPI_SPEED_PREINIT
176 #define SD_CARD_SPI_SPEED_PREINIT SPI_CLK_400KHZ
177 #endif
178 
182 #ifndef SD_CARD_SPI_SPEED_POSTINIT
183 #define SD_CARD_SPI_SPEED_POSTINIT SPI_CLK_10MHZ
184 #endif
185 
189 #define SD_CARD_DUMMY_BYTE (0xFF)
190 
194 #define SDCARD_SPI_IEC_KIBI (1024L)
195 
199 #define SDCARD_SPI_SI_KILO (1000L)
200 
205 typedef enum {
206  SD_INIT_START,
207  SD_INIT_SPI_POWER_SEQ,
208  SD_INIT_SEND_CMD0,
209  SD_INIT_SEND_CMD8,
210  SD_INIT_CARD_UNKNOWN,
211  SD_INIT_SEND_ACMD41_HCS,
212  SD_INIT_SEND_ACMD41,
213  SD_INIT_SEND_CMD1,
214  SD_INIT_SEND_CMD58,
215  SD_INIT_SEND_CMD16,
216  SD_INIT_ENABLE_CRC,
217  SD_INIT_READ_CID,
218  SD_INIT_READ_CSD,
219  SD_INIT_SET_MAX_SPI_SPEED,
220  SD_INIT_FINISH
221 } sd_init_fsm_state_t;
240 uint8_t sdcard_spi_send_cmd(sdcard_spi_t *card, uint8_t sd_cmd_idx, uint32_t argument, uint32_t retry_us);
241 
258 uint8_t sdcard_spi_send_acmd(sdcard_spi_t *card, uint8_t sd_cmd_idx, uint32_t argument, uint32_t retry_us);
259 
267 uint32_t sdcard_spi_get_sector_count(sdcard_spi_t *card);
268 
276 uint32_t sdcard_spi_get_au_size(sdcard_spi_t *card);
277 
286 sd_rw_response_t sdcard_spi_read_sds(sdcard_spi_t *card, sd_status_t *sd_status);
287 
288 
289 #ifdef __cplusplus
290 }
291 #endif
292 
293 #endif /* SDCARD_SPI_INTERNAL_H */
294 
sdcard_spi_send_cmd
uint8_t sdcard_spi_send_cmd(sdcard_spi_t *card, uint8_t sd_cmd_idx, uint32_t argument, uint32_t retry_us)
Sends a cmd to the sd card.
spi.h
Low-level SPI peripheral driver interface definition.
sd_init_fsm_state_t
sd_init_fsm_state_t
SD card driver internal states.
Definition: sdcard_spi_internal.h:203
sd_status_t
SD status register (see section 4.10.2 in SD-Spec v5.00)
Definition: sdcard_spi.h:130
sdcard_spi_read_sds
sd_rw_response_t sdcard_spi_read_sds(sdcard_spi_t *card, sd_status_t *sd_status)
Gets the SD status of the card.
sd_rw_response_t
sd_rw_response_t
sdcard_spi r/w-operation return values
Definition: sdcard_spi.h:161
sdcard_spi_get_sector_count
uint32_t sdcard_spi_get_sector_count(sdcard_spi_t *card)
Gets the sector count of the card.
sdcard_spi.h
Public interface for the sdcard_spi driver.
sdcard_spi_send_acmd
uint8_t sdcard_spi_send_acmd(sdcard_spi_t *card, uint8_t sd_cmd_idx, uint32_t argument, uint32_t retry_us)
Sends an acmd to the sd card.
sdcard_spi_get_au_size
uint32_t sdcard_spi_get_au_size(sdcard_spi_t *card)
Gets the allocation unit size of the card.
gpio.h
Low-level GPIO peripheral driver interface definitions.
sdcard_spi_t
Device descriptor for sdcard_spi.
Definition: sdcard_spi.h:187