1 // Copyright 2015-2020 Espressif Systems (Shanghai) PTE LTD
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //     http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #include <stdlib.h>
16 #include "spi_flash_chip_generic.h"
17 #include "spi_flash_defs.h"
18 
19 /* Driver for MXIC flash chip */
20 
spi_flash_chip_mxic_probe(esp_flash_t * chip,uint32_t flash_id)21 esp_err_t spi_flash_chip_mxic_probe(esp_flash_t *chip, uint32_t flash_id)
22 {
23     /* Check manufacturer and product IDs match our desired masks */
24     const uint8_t MFG_ID = 0xC2;
25     if (flash_id >> 16 != MFG_ID) {
26         return ESP_ERR_NOT_FOUND;
27     }
28 
29     return ESP_OK;
30 }
31 
32 esp_err_t spi_flash_chip_issi_set_io_mode(esp_flash_t *chip);
33 esp_err_t spi_flash_chip_issi_get_io_mode(esp_flash_t *chip, esp_flash_io_mode_t* out_io_mode);
34 
35 // Use the same implementation as ISSI chips
36 #define spi_flash_chip_mxic_set_io_mode spi_flash_chip_issi_set_io_mode
37 #define spi_flash_chip_mxic_get_io_mode spi_flash_chip_issi_get_io_mode
38 #define spi_flash_chip_mxic_read_reg        spi_flash_chip_generic_read_reg
39 
40 static const char chip_name[] = "mxic";
41 
42 // The mxic chip can use the functions for generic chips except from set read mode and probe,
43 // So we only replace these two functions.
44 const spi_flash_chip_t esp_flash_chip_mxic = {
45     .name = chip_name,
46     .timeout = &spi_flash_chip_generic_timeout,
47     .probe = spi_flash_chip_mxic_probe,
48     .reset = spi_flash_chip_generic_reset,
49     .detect_size = spi_flash_chip_generic_detect_size,
50     .erase_chip = spi_flash_chip_generic_erase_chip,
51     .erase_sector = spi_flash_chip_generic_erase_sector,
52     .erase_block = spi_flash_chip_generic_erase_block,
53     .sector_size = 4 * 1024,
54     .block_erase_size = 64 * 1024,
55 
56     .get_chip_write_protect = spi_flash_chip_generic_get_write_protect,
57     .set_chip_write_protect = spi_flash_chip_generic_set_write_protect,
58 
59     .num_protectable_regions = 0,
60     .protectable_regions = NULL,
61     .get_protected_regions = NULL,
62     .set_protected_regions = NULL,
63 
64     .read = spi_flash_chip_generic_read,
65     .write = spi_flash_chip_generic_write,
66     .program_page = spi_flash_chip_generic_page_program,
67     .page_size = 256,
68     .write_encrypted = spi_flash_chip_generic_write_encrypted,
69 
70     .wait_idle = spi_flash_chip_generic_wait_idle,
71     .set_io_mode = spi_flash_chip_mxic_set_io_mode,
72     .get_io_mode = spi_flash_chip_mxic_get_io_mode,
73 
74     .read_reg = spi_flash_chip_mxic_read_reg,
75     .yield = spi_flash_chip_generic_yield,
76     .sus_setup = spi_flash_chip_generic_suspend_cmd_conf,
77 };
78