Select one of the symbols to view example projects that use it.
 
Outline
#include <string.h>
#include <sys/unistd.h>
#include <sys/stat.h>
#include "esp_vfs_fat.h"
#include "sdmmc_cmd.h"
#include "driver/sdmmc_host.h"
#include "sd_test_io.h"
#include "sd_pwr_ctrl_by_on_chip_ldo.h"
#define EXAMPLE_MAX_CHAR_SIZE
TAG
#define MOUNT_POINT
#define EXAMPLE_IS_UHS1
s_example_write_file(const char *, char *)
s_example_read_file(const char *)
app_main()
Files
loading...
SourceVuESP-IDF Framework and Examplessdmmc samplemain/sd_card_example_main.c
 
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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* SD card and FAT filesystem example. This example code is in the Public Domain (or CC0 licensed, at your option.) Unless required by applicable law or agreed to in writing, this software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *//* ... */ // This example uses SDMMC peripheral to communicate with SD card. #include <string.h> #include <sys/unistd.h> #include <sys/stat.h> #include "esp_vfs_fat.h" #include "sdmmc_cmd.h" #include "driver/sdmmc_host.h" #include "sd_test_io.h"7 includes #if SOC_SDMMC_IO_POWER_EXTERNAL #include "sd_pwr_ctrl_by_on_chip_ldo.h" #endif #define EXAMPLE_MAX_CHAR_SIZE 64 static const char *TAG = "example"; #define MOUNT_POINT "/sdcard" #define EXAMPLE_IS_UHS1 (CONFIG_EXAMPLE_SDMMC_SPEED_UHS_I_SDR50 || CONFIG_EXAMPLE_SDMMC_SPEED_UHS_I_DDR50) #ifdef CONFIG_EXAMPLE_DEBUG_PIN_CONNECTIONS const char* names[] = {"CLK", "CMD", "D0", "D1", "D2", "D3"}; const int pins[] = {CONFIG_EXAMPLE_PIN_CLK, CONFIG_EXAMPLE_PIN_CMD, CONFIG_EXAMPLE_PIN_D0 #ifdef CONFIG_EXAMPLE_SDMMC_BUS_WIDTH_4 ,CONFIG_EXAMPLE_PIN_D1, CONFIG_EXAMPLE_PIN_D2, CONFIG_EXAMPLE_PIN_D3/* ... */ #endif }{...}; const int pin_count = sizeof(pins)/sizeof(pins[0]); #if CONFIG_EXAMPLE_ENABLE_ADC_FEATURE const int adc_channels[] = {CONFIG_EXAMPLE_ADC_PIN_CLK, CONFIG_EXAMPLE_ADC_PIN_CMD, CONFIG_EXAMPLE_ADC_PIN_D0 #ifdef CONFIG_EXAMPLE_SDMMC_BUS_WIDTH_4 ,CONFIG_EXAMPLE_ADC_PIN_D1, CONFIG_EXAMPLE_ADC_PIN_D2, CONFIG_EXAMPLE_ADC_PIN_D3/* ... */ #endif }{...};/* ... */ #endif //CONFIG_EXAMPLE_ENABLE_ADC_FEATURE pin_configuration_t config = { .names = names, .pins = pins, #if CONFIG_EXAMPLE_ENABLE_ADC_FEATURE .adc_channels = adc_channels, #endif }{...};/* ... */ #endif //CONFIG_EXAMPLE_DEBUG_PIN_CONNECTIONS static esp_err_t s_example_write_file(const char *path, char *data) { ESP_LOGI(TAG, "Opening file %s", path); FILE *f = fopen(path, "w"); if (f == NULL) { ESP_LOGE(TAG, "Failed to open file for writing"); return ESP_FAIL; }{...} fprintf(f, data); fclose(f); ESP_LOGI(TAG, "File written"); return ESP_OK; }{ ... } static esp_err_t s_example_read_file(const char *path) { ESP_LOGI(TAG, "Reading file %s", path); FILE *f = fopen(path, "r"); if (f == NULL) { ESP_LOGE(TAG, "Failed to open file for reading"); return ESP_FAIL; }{...} char line[EXAMPLE_MAX_CHAR_SIZE]; fgets(line, sizeof(line), f); fclose(f); // strip newline char *pos = strchr(line, '\n'); if (pos) { *pos = '\0'; }{...} ESP_LOGI(TAG, "Read from file: '%s'", line); return ESP_OK; }{ ... } void app_main(void) { esp_err_t ret; // Options for mounting the filesystem. // If format_if_mount_failed is set to true, SD card will be partitioned and // formatted in case when mounting fails. esp_vfs_fat_sdmmc_mount_config_t mount_config = { #ifdef CONFIG_EXAMPLE_FORMAT_IF_MOUNT_FAILED .format_if_mount_failed = true, #else .format_if_mount_failed = false, #endif // EXAMPLE_FORMAT_IF_MOUNT_FAILED .max_files = 5, .allocation_unit_size = 16 * 1024 }{...}; sdmmc_card_t *card; const char mount_point[] = MOUNT_POINT; ESP_LOGI(TAG, "Initializing SD card"); // Use settings defined above to initialize SD card and mount FAT filesystem. // Note: esp_vfs_fat_sdmmc/sdspi_mount is all-in-one convenience functions. // Please check its source code and implement error recovery when developing // production applications. ESP_LOGI(TAG, "Using SDMMC peripheral"); // By default, SD card frequency is initialized to SDMMC_FREQ_DEFAULT (20MHz) // For setting a specific frequency, use host.max_freq_khz (range 400kHz - 40MHz for SDMMC) // Example: for fixed frequency of 10MHz, use host.max_freq_khz = 10000; sdmmc_host_t host = SDMMC_HOST_DEFAULT(); #if CONFIG_EXAMPLE_SDMMC_SPEED_HS host.max_freq_khz = SDMMC_FREQ_HIGHSPEED; #elif CONFIG_EXAMPLE_SDMMC_SPEED_UHS_I_SDR50 host.slot = SDMMC_HOST_SLOT_0; host.max_freq_khz = SDMMC_FREQ_SDR50; host.flags &= ~SDMMC_HOST_FLAG_DDR;/* ... */ #elif CONFIG_EXAMPLE_SDMMC_SPEED_UHS_I_DDR50 host.slot = SDMMC_HOST_SLOT_0; host.max_freq_khz = SDMMC_FREQ_DDR50;/* ... */ #endif // For SoCs where the SD power can be supplied both via an internal or external (e.g. on-board LDO) power supply. // When using specific IO pins (which can be used for ultra high-speed SDMMC) to connect to the SD card // and the internal LDO power supply, we need to initialize the power supply first. #if CONFIG_EXAMPLE_SD_PWR_CTRL_LDO_INTERNAL_IO sd_pwr_ctrl_ldo_config_t ldo_config = { .ldo_chan_id = CONFIG_EXAMPLE_SD_PWR_CTRL_LDO_IO_ID, }{...}; sd_pwr_ctrl_handle_t pwr_ctrl_handle = NULL; ret = sd_pwr_ctrl_new_on_chip_ldo(&ldo_config, &pwr_ctrl_handle); if (ret != ESP_OK) { ESP_LOGE(TAG, "Failed to create a new on-chip LDO power control driver"); return; }{...} host.pwr_ctrl_handle = pwr_ctrl_handle;/* ... */ #endif // This initializes the slot without card detect (CD) and write protect (WP) signals. // Modify slot_config.gpio_cd and slot_config.gpio_wp if your board has these signals. sdmmc_slot_config_t slot_config = SDMMC_SLOT_CONFIG_DEFAULT(); #if EXAMPLE_IS_UHS1 slot_config.flags |= SDMMC_SLOT_FLAG_UHS1; #endif // Set bus width to use: #ifdef CONFIG_EXAMPLE_SDMMC_BUS_WIDTH_4 slot_config.width = 4; #else slot_config.width = 1; #endif // On chips where the GPIOs used for SD card can be configured, set them in // the slot_config structure: #ifdef CONFIG_SOC_SDMMC_USE_GPIO_MATRIX slot_config.clk = CONFIG_EXAMPLE_PIN_CLK; slot_config.cmd = CONFIG_EXAMPLE_PIN_CMD; slot_config.d0 = CONFIG_EXAMPLE_PIN_D0; #ifdef CONFIG_EXAMPLE_SDMMC_BUS_WIDTH_4 slot_config.d1 = CONFIG_EXAMPLE_PIN_D1; slot_config.d2 = CONFIG_EXAMPLE_PIN_D2; slot_config.d3 = CONFIG_EXAMPLE_PIN_D3;/* ... */ #endif // CONFIG_EXAMPLE_SDMMC_BUS_WIDTH_4/* ... */ #endif // CONFIG_SOC_SDMMC_USE_GPIO_MATRIX // Enable internal pullups on enabled pins. The internal pullups // are insufficient however, please make sure 10k external pullups are // connected on the bus. This is for debug / example purpose only. slot_config.flags |= SDMMC_SLOT_FLAG_INTERNAL_PULLUP; ESP_LOGI(TAG, "Mounting filesystem"); ret = esp_vfs_fat_sdmmc_mount(mount_point, &host, &slot_config, &mount_config, &card); if (ret != ESP_OK) { if (ret == ESP_FAIL) { ESP_LOGE(TAG, "Failed to mount filesystem. " "If you want the card to be formatted, set the EXAMPLE_FORMAT_IF_MOUNT_FAILED menuconfig option."); }{...} else { ESP_LOGE(TAG, "Failed to initialize the card (%s). " "Make sure SD card lines have pull-up resistors in place.", esp_err_to_name(ret)); #ifdef CONFIG_EXAMPLE_DEBUG_PIN_CONNECTIONS check_sd_card_pins(&config, pin_count); #endif }{...} return; }{...} ESP_LOGI(TAG, "Filesystem mounted"); // Card has been initialized, print its properties sdmmc_card_print_info(stdout, card); // Use POSIX and C standard library functions to work with files: // First create a file. const char *file_hello = MOUNT_POINT"/hello.txt"; char data[EXAMPLE_MAX_CHAR_SIZE]; snprintf(data, EXAMPLE_MAX_CHAR_SIZE, "%s %s!\n", "Hello", card->cid.name); ret = s_example_write_file(file_hello, data); if (ret != ESP_OK) { return; }{...} const char *file_foo = MOUNT_POINT"/foo.txt"; // Check if destination file exists before renaming struct stat st; if (stat(file_foo, &st) == 0) { // Delete it if it exists unlink(file_foo); }{...} // Rename original file ESP_LOGI(TAG, "Renaming file %s to %s", file_hello, file_foo); if (rename(file_hello, file_foo) != 0) { ESP_LOGE(TAG, "Rename failed"); return; }{...} ret = s_example_read_file(file_foo); if (ret != ESP_OK) { return; }{...} // Format FATFS #ifdef CONFIG_EXAMPLE_FORMAT_SD_CARD ret = esp_vfs_fat_sdcard_format(mount_point, card); if (ret != ESP_OK) { ESP_LOGE(TAG, "Failed to format FATFS (%s)", esp_err_to_name(ret)); return; }{...} if (stat(file_foo, &st) == 0) { ESP_LOGI(TAG, "file still exists"); return; }{...} else { ESP_LOGI(TAG, "file doesn't exist, formatting done"); }{...} #endif/* ... */ // CONFIG_EXAMPLE_FORMAT_SD_CARD const char *file_nihao = MOUNT_POINT"/nihao.txt"; memset(data, 0, EXAMPLE_MAX_CHAR_SIZE); snprintf(data, EXAMPLE_MAX_CHAR_SIZE, "%s %s!\n", "Nihao", card->cid.name); ret = s_example_write_file(file_nihao, data); if (ret != ESP_OK) { return; }{...} //Open file for reading ret = s_example_read_file(file_nihao); if (ret != ESP_OK) { return; }{...} // All done, unmount partition and disable SDMMC peripheral esp_vfs_fat_sdcard_unmount(mount_point, card); ESP_LOGI(TAG, "Card unmounted"); // Deinitialize the power control driver if it was used #if CONFIG_EXAMPLE_SD_PWR_CTRL_LDO_INTERNAL_IO ret = sd_pwr_ctrl_del_on_chip_ldo(pwr_ctrl_handle); if (ret != ESP_OK) { ESP_LOGE(TAG, "Failed to delete the on-chip LDO power control driver"); return; }{...} #endif/* ... */ }{ ... }
Details