ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include <stdlib.h>
#include <string.h>
#include <sys/param.h>
#include "esp_log.h"
#include "spi_flash_chip_generic.h"
#include "spi_flash_defs.h"
#define REGION_32BIT
#define ADDR_32BIT
TAG
spi_flash_chip_winbond_probe(esp_flash_t *, uint32_t)
spi_flash_chip_winbond_read(esp_flash_t *, void *, uint32_t, uint32_t)
spi_flash_chip_winbond_page_program(esp_flash_t *, const void *, uint32_t, uint32_t)
spi_flash_chip_winbond_erase_sector(esp_flash_t *, uint32_t)
spi_flash_chip_winbond_erase_block(esp_flash_t *, uint32_t)
spi_flash_chip_winbond_get_caps(esp_flash_t *)
chip_name
esp_flash_chip_winbond
spi_flash_command_winbond_program_4B(esp_flash_t *, const void *, uint32_t, uint32_t)
spi_flash_command_winbond_erase_sector_4B(esp_flash_t *, uint32_t)
spi_flash_command_erase_block_4B(esp_flash_t *, uint32_t)
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/spi_flash/spi_flash_chip_winbond.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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #include <stdlib.h> #include <string.h> #include <sys/param.h> // For MIN/MAX #include "esp_log.h" #include "spi_flash_chip_generic.h" #include "spi_flash_defs.h"6 includes #define REGION_32BIT(start, len) ((start) + (len) > (1<<24)) #define ADDR_32BIT(addr) (addr >= (1<<24)) static const char TAG[] = "chip_wb"; /* Driver for Winbond flash chip */ static esp_err_t spi_flash_command_winbond_program_4B(esp_flash_t *chip, const void *buffer, uint32_t address, uint32_t length); static esp_err_t spi_flash_command_winbond_erase_sector_4B(esp_flash_t *chip, uint32_t start_address); static esp_err_t spi_flash_command_erase_block_4B(esp_flash_t *chip, uint32_t start_address); esp_err_t spi_flash_chip_winbond_probe(esp_flash_t *chip, uint32_t flash_id) { /* Check manufacturer and product IDs match our desired masks */ const uint8_t MFG_ID = 0xEF; if (flash_id >> 16 != MFG_ID) { return ESP_ERR_NOT_FOUND; }{...} return ESP_OK; }{ ... } esp_err_t spi_flash_chip_winbond_read(esp_flash_t *chip, void *buffer, uint32_t address, uint32_t length) { esp_err_t err = ESP_OK; const uint32_t page_size = chip->chip_drv->page_size; uint32_t align_address; uint8_t temp_buffer[64]; //spiflash hal max length of read no longer than 64byte uint32_t config_io_flags = 0; // Configure the host, and return if (REGION_32BIT(address, length)) { config_io_flags |= SPI_FLASH_CONFIG_IO_MODE_32B_ADDR; }{...} err = chip->chip_drv->config_host_io_mode(chip, config_io_flags); if (err == ESP_ERR_NOT_SUPPORTED) { ESP_LOGE(TAG, "configure host io mode failed - unsupported"); return err; }{...} while (err == ESP_OK && length > 0) { memset(temp_buffer, 0xFF, sizeof(temp_buffer)); uint32_t read_len = chip->host->driver->read_data_slicer(chip->host, address, length, &align_address, page_size); uint32_t left_off = address - align_address; uint32_t data_len = MIN(align_address + read_len, address + length) - address; err = chip->host->driver->read(chip->host, temp_buffer, align_address, read_len); memcpy(buffer, temp_buffer + left_off, data_len); address += data_len; buffer = (void *)((intptr_t)buffer + data_len); length = length - data_len; }{...} return err; }{ ... } esp_err_t spi_flash_chip_winbond_page_program(esp_flash_t *chip, const void *buffer, uint32_t address, uint32_t length) { esp_err_t err; err = chip->chip_drv->wait_idle(chip, chip->chip_drv->timeout->idle_timeout); if (err == ESP_OK) { // Perform the actual Page Program command err = spi_flash_command_winbond_program_4B(chip, buffer, address, length); if (err != ESP_OK) { return err; }{...} err = chip->chip_drv->wait_idle(chip, chip->chip_drv->timeout->page_program_timeout); }{...} return err; }{ ... } esp_err_t spi_flash_chip_winbond_erase_sector(esp_flash_t *chip, uint32_t start_address) { esp_err_t err = chip->chip_drv->set_chip_write_protect(chip, false); if (err == ESP_OK) { err = chip->chip_drv->wait_idle(chip, chip->chip_drv->timeout->idle_timeout); }{...} if (err == ESP_OK) { err = spi_flash_command_winbond_erase_sector_4B(chip, start_address); if (err != ESP_OK) { return err; }{...} //to save time, flush cache here if (chip->host->driver->flush_cache) { err = chip->host->driver->flush_cache(chip->host, start_address, chip->chip_drv->sector_size); if (err != ESP_OK) { return err; }{...} }{...} err = chip->chip_drv->wait_idle(chip, chip->chip_drv->timeout->sector_erase_timeout); }{...} return err; }{ ... } esp_err_t spi_flash_chip_winbond_erase_block(esp_flash_t *chip, uint32_t start_address) { esp_err_t err = chip->chip_drv->set_chip_write_protect(chip, false); if (err == ESP_OK) { err = chip->chip_drv->wait_idle(chip, chip->chip_drv->timeout->idle_timeout); }{...} if (err == ESP_OK) { err = spi_flash_command_erase_block_4B(chip, start_address); if (err != ESP_OK) { return err; }{...} //to save time, flush cache here if (chip->host->driver->flush_cache) { err = chip->host->driver->flush_cache(chip->host, start_address, chip->chip_drv->block_erase_size); if (err != ESP_OK) { return err; }{...} }{...} err = chip->chip_drv->wait_idle(chip, chip->chip_drv->timeout->block_erase_timeout); }{...} return err; }{ ... } spi_flash_caps_t spi_flash_chip_winbond_get_caps(esp_flash_t *chip) { spi_flash_caps_t caps_flags = 0; // 32M-bits address support if ((chip->chip_id & 0xFF) >= 0x19) { caps_flags |= SPI_FLASH_CHIP_CAP_32MB_SUPPORT; }{...} // flash-suspend is not supported // flash read unique id. caps_flags |= SPI_FLASH_CHIP_CAP_UNIQUE_ID; return caps_flags; }{ ... } static const char chip_name[] = "winbond"; // The issi chip can use the functions for generic chips except from set read mode and probe, // So we only replace these two functions. const spi_flash_chip_t esp_flash_chip_winbond = { .name = chip_name, .timeout = &spi_flash_chip_generic_timeout, .probe = spi_flash_chip_winbond_probe, .reset = spi_flash_chip_generic_reset, .detect_size = spi_flash_chip_generic_detect_size, .erase_chip = spi_flash_chip_generic_erase_chip, .erase_sector = spi_flash_chip_winbond_erase_sector, .erase_block = spi_flash_chip_winbond_erase_block, .sector_size = 4 * 1024, .block_erase_size = 64 * 1024, .get_chip_write_protect = spi_flash_chip_generic_get_write_protect, .set_chip_write_protect = spi_flash_chip_generic_set_write_protect, .num_protectable_regions = 0, .protectable_regions = NULL, .get_protected_regions = NULL, .set_protected_regions = NULL, .read = spi_flash_chip_winbond_read, .write = spi_flash_chip_generic_write, .program_page = spi_flash_chip_winbond_page_program, .page_size = 256, .write_encrypted = spi_flash_chip_generic_write_encrypted, .wait_idle = spi_flash_chip_generic_wait_idle, .set_io_mode = spi_flash_chip_generic_set_io_mode, .get_io_mode = spi_flash_chip_generic_get_io_mode, .read_reg = spi_flash_chip_generic_read_reg, .yield = spi_flash_chip_generic_yield, .sus_setup = spi_flash_chip_generic_suspend_cmd_conf, .read_unique_id = spi_flash_chip_generic_read_unique_id, .get_chip_caps = spi_flash_chip_winbond_get_caps, .config_host_io_mode = spi_flash_chip_generic_config_host_io_mode, }{...}; static esp_err_t spi_flash_command_winbond_program_4B(esp_flash_t *chip, const void *buffer, uint32_t address, uint32_t length) { bool addr_4b = ADDR_32BIT(address); spi_flash_trans_t t = { .command = (addr_4b? CMD_PROGRAM_PAGE_4B: CMD_PROGRAM_PAGE), .address_bitlen = (addr_4b? 32: 24), .address = address, .mosi_len = length, .mosi_data = buffer, .flags = SPI_FLASH_TRANS_FLAG_PE_CMD, }{...}; return chip->host->driver->common_command(chip->host, &t); }{ ... } esp_err_t spi_flash_command_winbond_erase_sector_4B(esp_flash_t *chip, uint32_t start_address) { bool addr_4b = ADDR_32BIT(start_address); spi_flash_trans_t t = { .command = (addr_4b? CMD_SECTOR_ERASE_4B: CMD_SECTOR_ERASE), .address_bitlen = (addr_4b? 32: 24), .address = start_address, .flags = SPI_FLASH_TRANS_FLAG_PE_CMD, }{...}; return chip->host->driver->common_command(chip->host, &t); }{ ... } esp_err_t spi_flash_command_erase_block_4B(esp_flash_t *chip, uint32_t start_address) { bool addr_4b = ADDR_32BIT(start_address); spi_flash_trans_t t = { .command = (addr_4b? CMD_LARGE_BLOCK_ERASE_4B: CMD_LARGE_BLOCK_ERASE), .address_bitlen = (addr_4b? 32: 24), .address = start_address, .flags = SPI_FLASH_TRANS_FLAG_PE_CMD, }{...}; return chip->host->driver->common_command(chip->host, &t); }{ ... }
Details
Show:
from
Types: Columns:
This file uses the notable symbols shown below. Click anywhere in the file to view more details.