From 56edc81b5d323b7bc4e754c1adfb0f86d4d3783a Mon Sep 17 00:00:00 2001 From: Cao Sen Miao Date: Wed, 1 Dec 2021 15:13:02 +0800 Subject: [PATCH] spi_flash: add support for th 1M flash --- .../bootloader_support/src/flash_qio_mode.c | 1 + components/spi_flash/CMakeLists.txt | 1 + components/spi_flash/Kconfig | 13 +++- .../spi_flash/include/spi_flash_chip_th.h | 13 ++++ components/spi_flash/linker.lf | 5 +- components/spi_flash/spi_flash_chip_drivers.c | 22 +++--- components/spi_flash/spi_flash_chip_th.c | 78 +++++++++++++++++++ tools/ci/check_copyright_ignore.txt | 1 - tools/ci/check_public_headers_exceptions.txt | 1 + 9 files changed, 117 insertions(+), 18 deletions(-) create mode 100644 components/spi_flash/include/spi_flash_chip_th.h create mode 100644 components/spi_flash/spi_flash_chip_th.c diff --git a/components/bootloader_support/src/flash_qio_mode.c b/components/bootloader_support/src/flash_qio_mode.c index 4fb7d5d313..1d7a4e78f3 100644 --- a/components/bootloader_support/src/flash_qio_mode.c +++ b/components/bootloader_support/src/flash_qio_mode.c @@ -51,6 +51,7 @@ const bootloader_qio_info_t __attribute__((weak)) bootloader_flash_qe_support_li { "WinBond", 0xEF, 0x4000, 0xFF00, bootloader_read_status_16b_rdsr_rdsr2, bootloader_write_status_16b_wrsr, 9 }, { "GD", 0xC8, 0x6000, 0xFF00, bootloader_read_status_16b_rdsr_rdsr2, bootloader_write_status_16b_wrsr, 9 }, { "XM25QU64A", 0x20, 0x3817, 0xFFFF, bootloader_read_status_8b_xmc25qu64a, bootloader_write_status_8b_xmc25qu64a, 6 }, + { "TH", 0xcd, 0x6000, 0xFF00, bootloader_read_status_16b_rdsr_rdsr2, bootloader_write_status_16b_wrsr, 9 }, /* Final entry is default entry, if no other IDs have matched. diff --git a/components/spi_flash/CMakeLists.txt b/components/spi_flash/CMakeLists.txt index 4b1039dc24..51406d2e72 100644 --- a/components/spi_flash/CMakeLists.txt +++ b/components/spi_flash/CMakeLists.txt @@ -35,6 +35,7 @@ else() "spi_flash_chip_winbond.c" "spi_flash_chip_boya.c" "spi_flash_chip_mxic_opi.c" + "spi_flash_chip_th.c" "memspi_host_driver.c") list(APPEND cache_srcs diff --git a/components/spi_flash/Kconfig b/components/spi_flash/Kconfig index 32a2544f1a..9a56da7604 100644 --- a/components/spi_flash/Kconfig +++ b/components/spi_flash/Kconfig @@ -241,13 +241,24 @@ menu "SPI Flash driver" config SPI_FLASH_SUPPORT_BOYA_CHIP bool "BOYA" - depends on !IDF_TARGET_ESP32 + # ESP32 doens't usually use this chip, default n to save iram. + default n if IDF_TARGET_ESP32 default y help Enable this to support auto detection of BOYA chips if chip vendor not directly given by ``chip_drv`` member of the chip struct. This adds support for variant chips, however will extend detecting time. + config SPI_FLASH_SUPPORT_TH_CHIP + bool "TH" + # ESP32 doens't usually use this chip, default n to save iram. + default n if IDF_TARGET_ESP32 + default y + help + Enable this to support auto detection of TH chips if chip vendor not directly + given by ``chip_drv`` member of the chip struct. This adds support for variant + chips, however will extend detecting time. + config SPI_FLASH_SUPPORT_MXIC_OPI_CHIP bool "mxic (opi)" depends on IDF_TARGET_ESP32S3 diff --git a/components/spi_flash/include/spi_flash_chip_th.h b/components/spi_flash/include/spi_flash_chip_th.h new file mode 100644 index 0000000000..7f631faf13 --- /dev/null +++ b/components/spi_flash/include/spi_flash_chip_th.h @@ -0,0 +1,13 @@ +/* + * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#pragma once + +#include +#include "esp_flash.h" +#include "spi_flash_chip_driver.h" + +extern const spi_flash_chip_t esp_flash_chip_th; diff --git a/components/spi_flash/linker.lf b/components/spi_flash/linker.lf index 92beb351a8..fdba7df429 100644 --- a/components/spi_flash/linker.lf +++ b/components/spi_flash/linker.lf @@ -7,11 +7,10 @@ entries: spi_flash_chip_mxic (noflash) spi_flash_chip_gd (noflash) spi_flash_chip_winbond (noflash) + spi_flash_chip_boya (noflash) + spi_flash_chip_th (noflash) memspi_host_driver (noflash) - if IDF_TARGET_ESP32 = n: - spi_flash_chip_boya (noflash) - if IDF_TARGET_ESP32S3 = y: spi_flash_timing_tuning (noflash) spi_timing_config (noflash) diff --git a/components/spi_flash/spi_flash_chip_drivers.c b/components/spi_flash/spi_flash_chip_drivers.c index d54963b84b..51247f7b9e 100644 --- a/components/spi_flash/spi_flash_chip_drivers.c +++ b/components/spi_flash/spi_flash_chip_drivers.c @@ -1,16 +1,8 @@ -// Copyright 2015-2019 Espressif Systems (Shanghai) PTE LTD -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +/* + * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ #include #include "spi_flash_chip_driver.h" @@ -20,6 +12,7 @@ #include "spi_flash_chip_gd.h" #include "spi_flash_chip_winbond.h" #include "spi_flash_chip_boya.h" +#include "spi_flash_chip_th.h" #include "sdkconfig.h" #if !CONFIG_SPI_FLASH_OVERRIDE_CHIP_DRIVER_LIST @@ -48,6 +41,9 @@ static const spi_flash_chip_t *default_registered_chips[] = { #ifdef CONFIG_SPI_FLASH_SUPPORT_BOYA_CHIP &esp_flash_chip_boya, #endif +#ifdef CONFIG_SPI_FLASH_SUPPORT_TH_CHIP + &esp_flash_chip_th, +#endif #ifdef CONFIG_SPI_FLASH_SUPPORT_MXIC_OPI_CHIP &esp_flash_chip_mxic_opi, #endif diff --git a/components/spi_flash/spi_flash_chip_th.c b/components/spi_flash/spi_flash_chip_th.c new file mode 100644 index 0000000000..cc8001b772 --- /dev/null +++ b/components/spi_flash/spi_flash_chip_th.c @@ -0,0 +1,78 @@ +/* + * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#include +#include "spi_flash_chip_generic.h" +#include "spi_flash_defs.h" + +esp_err_t spi_flash_chip_th_probe(esp_flash_t *chip, uint32_t flash_id) +{ + /* Check manufacturer and product IDs match our desired masks */ + const uint8_t MFG_ID = 0xcd; + if (flash_id >> 16 != MFG_ID) { + return ESP_ERR_NOT_FOUND; + } + + const uint16_t FLASH_ID_MASK = 0xFF00; + const uint16_t FLASH_ID_VALUE = 0x6000; + if ((flash_id & FLASH_ID_MASK) != FLASH_ID_VALUE) { + return ESP_ERR_NOT_FOUND; + } + + return ESP_OK; +} + +spi_flash_caps_t spi_flash_chip_th_get_caps(esp_flash_t *chip) +{ + spi_flash_caps_t caps_flags = 0; + // 32-bit-address flash is not supported + // 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[] = "th"; + +// The th 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_th = { + .name = chip_name, + .timeout = &spi_flash_chip_generic_timeout, + .probe = spi_flash_chip_th_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_generic_erase_sector, + .erase_block = spi_flash_chip_generic_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_generic_read, + .write = spi_flash_chip_generic_write, + .program_page = spi_flash_chip_generic_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_th_get_caps, + .config_host_io_mode = spi_flash_chip_generic_config_host_io_mode, +}; diff --git a/tools/ci/check_copyright_ignore.txt b/tools/ci/check_copyright_ignore.txt index 584576eb6e..d629585a1f 100644 --- a/tools/ci/check_copyright_ignore.txt +++ b/tools/ci/check_copyright_ignore.txt @@ -2122,7 +2122,6 @@ components/spi_flash/sim/flash_mock.cpp components/spi_flash/sim/flash_mock_util.c components/spi_flash/sim/sdkconfig/sdkconfig.h components/spi_flash/spi_flash_chip_boya.c -components/spi_flash/spi_flash_chip_drivers.c components/spi_flash/spi_flash_chip_gd.c components/spi_flash/spi_flash_chip_generic.c components/spi_flash/spi_flash_chip_issi.c diff --git a/tools/ci/check_public_headers_exceptions.txt b/tools/ci/check_public_headers_exceptions.txt index 60b708de55..de76bf9673 100644 --- a/tools/ci/check_public_headers_exceptions.txt +++ b/tools/ci/check_public_headers_exceptions.txt @@ -34,6 +34,7 @@ components/spi_flash/include/spi_flash_chip_mxic.h components/spi_flash/include/spi_flash_chip_gd.h components/spi_flash/include/spi_flash_chip_winbond.h components/spi_flash/include/spi_flash_chip_boya.h +components/spi_flash/include/spi_flash_chip_th.h components/spi_flash/include/memspi_host_driver.h components/spi_flash/include/spi_flash_chip_driver.h components/spi_flash/include/spi_flash_chip_generic.h