1 /*
2  * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 
7 #include <stdlib.h>
8 #include "spi_flash_chip_generic.h"
9 #include "spi_flash_defs.h"
10 
spi_flash_chip_th_probe(esp_flash_t * chip,uint32_t flash_id)11 esp_err_t spi_flash_chip_th_probe(esp_flash_t *chip, uint32_t flash_id)
12 {
13     /* Check manufacturer and product IDs match our desired masks */
14     const uint8_t MFG_ID = 0xcd;
15     if (flash_id >> 16 != MFG_ID) {
16         return ESP_ERR_NOT_FOUND;
17     }
18 
19     const uint16_t FLASH_ID_MASK = 0xFF00;
20     const uint16_t FLASH_ID_VALUE = 0x6000;
21     if ((flash_id & FLASH_ID_MASK) != FLASH_ID_VALUE) {
22         return ESP_ERR_NOT_FOUND;
23     }
24 
25     return ESP_OK;
26 }
27 
spi_flash_chip_th_get_caps(esp_flash_t * chip)28 spi_flash_caps_t spi_flash_chip_th_get_caps(esp_flash_t *chip)
29 {
30     spi_flash_caps_t caps_flags = 0;
31     // 32-bit-address flash is not supported
32     // flash-suspend is not supported
33     // flash read unique id.
34     caps_flags |= SPI_FLASH_CHIP_CAP_UNIQUE_ID;
35     return caps_flags;
36 }
37 
38 static const char chip_name[] = "th";
39 
40 // The th chip can use the functions for generic chips except from set read mode and probe,
41 // So we only replace these two functions.
42 const spi_flash_chip_t esp_flash_chip_th = {
43     .name = chip_name,
44     .timeout = &spi_flash_chip_generic_timeout,
45     .probe = spi_flash_chip_th_probe,
46     .reset = spi_flash_chip_generic_reset,
47     .detect_size = spi_flash_chip_generic_detect_size,
48     .erase_chip = spi_flash_chip_generic_erase_chip,
49     .erase_sector = spi_flash_chip_generic_erase_sector,
50     .erase_block = spi_flash_chip_generic_erase_block,
51     .sector_size = 4 * 1024,
52     .block_erase_size = 64 * 1024,
53 
54     .get_chip_write_protect = spi_flash_chip_generic_get_write_protect,
55     .set_chip_write_protect = spi_flash_chip_generic_set_write_protect,
56 
57     .num_protectable_regions = 0,
58     .protectable_regions = NULL,
59     .get_protected_regions = NULL,
60     .set_protected_regions = NULL,
61 
62     .read = spi_flash_chip_generic_read,
63     .write = spi_flash_chip_generic_write,
64     .program_page = spi_flash_chip_generic_page_program,
65     .page_size = 256,
66     .write_encrypted = spi_flash_chip_generic_write_encrypted,
67 
68     .wait_idle = spi_flash_chip_generic_wait_idle,
69     .set_io_mode = spi_flash_chip_generic_set_io_mode,
70     .get_io_mode = spi_flash_chip_generic_get_io_mode,
71 
72     .read_reg = spi_flash_chip_generic_read_reg,
73     .yield = spi_flash_chip_generic_yield,
74     .sus_setup = spi_flash_chip_generic_suspend_cmd_conf,
75     .read_unique_id = spi_flash_chip_generic_read_unique_id,
76     .get_chip_caps = spi_flash_chip_th_get_caps,
77     .config_host_io_mode = spi_flash_chip_generic_config_host_io_mode,
78 };
79