2021-09-28 02:12:56 -04:00
|
|
|
/*
|
|
|
|
|
* SPDX-FileCopyrightText: 2010-2021 Espressif Systems (Shanghai) CO LTD
|
|
|
|
|
*
|
|
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
*/
|
2019-03-14 05:29:32 -04:00
|
|
|
|
|
|
|
|
#ifndef _ROM_SPI_FLASH_H_
|
|
|
|
|
#define _ROM_SPI_FLASH_H_
|
|
|
|
|
|
|
|
|
|
#include <stdint.h>
|
|
|
|
|
#include <stdbool.h>
|
|
|
|
|
|
|
|
|
|
#include "esp_attr.h"
|
|
|
|
|
|
global: move the soc component out of the common list
This MR removes the common dependency from every IDF components to the SOC component.
Currently, in the ``idf_functions.cmake`` script, we include the header path of SOC component by default for all components.
But for better code organization (or maybe also benifits to the compiling speed), we may remove the dependency to SOC components for most components except the driver and kernel related components.
In CMAKE, we have two kinds of header visibilities (set by include path visibility):
(Assume component A --(depends on)--> B, B is the current component)
1. public (``COMPONENT_ADD_INCLUDEDIRS``): means this path is visible to other depending components (A) (visible to A and B)
2. private (``COMPONENT_PRIV_INCLUDEDIRS``): means this path is only visible to source files inside the component (visible to B only)
and we have two kinds of depending ways:
(Assume component A --(depends on)--> B --(depends on)--> C, B is the current component)
1. public (```COMPONENT_REQUIRES```): means B can access to public include path of C. All other components rely on you (A) will also be available for the public headers. (visible to A, B)
2. private (``COMPONENT_PRIV_REQUIRES``): means B can access to public include path of C, but don't propagate this relation to other components (A). (visible to B)
1. remove the common requirement in ``idf_functions.cmake``, this makes the SOC components invisible to all other components by default.
2. if a component (for example, DRIVER) really needs the dependency to SOC, add a private dependency to SOC for it.
3. some other components that don't really depends on the SOC may still meet some errors saying "can't find header soc/...", this is because it's depended component (DRIVER) incorrectly include the header of SOC in its public headers. Moving all this kind of #include into source files, or private headers
4. Fix the include requirements for some file which miss sufficient #include directives. (Previously they include some headers by the long long long header include link)
This is a breaking change. Previous code may depends on the long include chain.
You may need to include the following headers for some files after this commit:
- soc/soc.h
- soc/soc_memory_layout.h
- driver/gpio.h
- esp_sleep.h
The major broken include chain includes:
1. esp_system.h no longer includes esp_sleep.h. The latter includes driver/gpio.h and driver/touch_pad.h.
2. ets_sys.h no longer includes soc/soc.h
3. freertos/portmacro.h no longer includes soc/soc_memory_layout.h
some peripheral headers no longer includes their hw related headers, e.g. rom/gpio.h no longer includes soc/gpio_pins.h and soc/gpio_reg.h
BREAKING CHANGE
2019-04-03 01:17:38 -04:00
|
|
|
#include "sdkconfig.h"
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_LEGACY_INCLUDE_COMMON_HEADERS
|
2019-03-14 05:29:32 -04:00
|
|
|
#include "soc/spi_reg.h"
|
global: move the soc component out of the common list
This MR removes the common dependency from every IDF components to the SOC component.
Currently, in the ``idf_functions.cmake`` script, we include the header path of SOC component by default for all components.
But for better code organization (or maybe also benifits to the compiling speed), we may remove the dependency to SOC components for most components except the driver and kernel related components.
In CMAKE, we have two kinds of header visibilities (set by include path visibility):
(Assume component A --(depends on)--> B, B is the current component)
1. public (``COMPONENT_ADD_INCLUDEDIRS``): means this path is visible to other depending components (A) (visible to A and B)
2. private (``COMPONENT_PRIV_INCLUDEDIRS``): means this path is only visible to source files inside the component (visible to B only)
and we have two kinds of depending ways:
(Assume component A --(depends on)--> B --(depends on)--> C, B is the current component)
1. public (```COMPONENT_REQUIRES```): means B can access to public include path of C. All other components rely on you (A) will also be available for the public headers. (visible to A, B)
2. private (``COMPONENT_PRIV_REQUIRES``): means B can access to public include path of C, but don't propagate this relation to other components (A). (visible to B)
1. remove the common requirement in ``idf_functions.cmake``, this makes the SOC components invisible to all other components by default.
2. if a component (for example, DRIVER) really needs the dependency to SOC, add a private dependency to SOC for it.
3. some other components that don't really depends on the SOC may still meet some errors saying "can't find header soc/...", this is because it's depended component (DRIVER) incorrectly include the header of SOC in its public headers. Moving all this kind of #include into source files, or private headers
4. Fix the include requirements for some file which miss sufficient #include directives. (Previously they include some headers by the long long long header include link)
This is a breaking change. Previous code may depends on the long include chain.
You may need to include the following headers for some files after this commit:
- soc/soc.h
- soc/soc_memory_layout.h
- driver/gpio.h
- esp_sleep.h
The major broken include chain includes:
1. esp_system.h no longer includes esp_sleep.h. The latter includes driver/gpio.h and driver/touch_pad.h.
2. ets_sys.h no longer includes soc/soc.h
3. freertos/portmacro.h no longer includes soc/soc_memory_layout.h
some peripheral headers no longer includes their hw related headers, e.g. rom/gpio.h no longer includes soc/gpio_pins.h and soc/gpio_reg.h
BREAKING CHANGE
2019-04-03 01:17:38 -04:00
|
|
|
#endif
|
2019-03-14 05:29:32 -04:00
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
extern "C" {
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/*************************************************************
|
|
|
|
|
* Note
|
|
|
|
|
*************************************************************
|
|
|
|
|
* 1. ESP32 chip have 4 SPI slave/master, however, SPI0 is
|
|
|
|
|
* used as an SPI master to access Flash and ext-SRAM by
|
|
|
|
|
* Cache module. It will support Decryto read for Flash,
|
|
|
|
|
* read/write for ext-SRAM. And SPI1 is also used as an
|
|
|
|
|
* SPI master for Flash read/write and ext-SRAM read/write.
|
|
|
|
|
* It will support Encrypto write for Flash.
|
|
|
|
|
* 2. As an SPI master, SPI support Highest clock to 80M,
|
|
|
|
|
* however, Flash with 80M Clock should be configured
|
|
|
|
|
* for different Flash chips. If you want to use 80M
|
|
|
|
|
* clock We should use the SPI that is certified by
|
|
|
|
|
* Espressif. However, the certification is not started
|
|
|
|
|
* at the time, so please use 40M clock at the moment.
|
|
|
|
|
* 3. SPI Flash can use 2 lines or 4 lines mode. If you
|
|
|
|
|
* use 2 lines mode, you can save two pad SPIHD and
|
|
|
|
|
* SPIWP for gpio. ESP32 support configured SPI pad for
|
|
|
|
|
* Flash, the configuration is stored in efuse and flash.
|
|
|
|
|
* However, the configurations of pads should be certified
|
|
|
|
|
* by Espressif. If you use this function, please use 40M
|
|
|
|
|
* clock at the moment.
|
|
|
|
|
* 4. ESP32 support to use Common SPI command to configure
|
|
|
|
|
* Flash to QIO mode, if you failed to configure with fix
|
|
|
|
|
* command. With Common SPI Command, ESP32 can also provide
|
|
|
|
|
* a way to use same Common SPI command groups on different
|
|
|
|
|
* Flash chips.
|
|
|
|
|
* 5. This functions are not protected by packeting, Please use the
|
|
|
|
|
*************************************************************
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#define PERIPHS_SPI_FLASH_CMD SPI_CMD_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_ADDR SPI_ADDR_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_CTRL SPI_CTRL_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_CTRL1 SPI_CTRL1_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_STATUS SPI_RD_STATUS_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_USRREG SPI_USER_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_USRREG1 SPI_USER1_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_USRREG2 SPI_USER2_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_C0 SPI_W0_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_C1 SPI_W1_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_C2 SPI_W2_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_C3 SPI_W3_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_C4 SPI_W4_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_C5 SPI_W5_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_C6 SPI_W6_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_C7 SPI_W7_REG(1)
|
|
|
|
|
#define PERIPHS_SPI_FLASH_TX_CRC SPI_TX_CRC_REG(1)
|
|
|
|
|
|
|
|
|
|
#define SPI0_R_QIO_DUMMY_CYCLELEN 3
|
|
|
|
|
#define SPI0_R_QIO_ADDR_BITSLEN 31
|
|
|
|
|
#define SPI0_R_FAST_DUMMY_CYCLELEN 7
|
2019-05-20 03:26:52 -04:00
|
|
|
#define SPI0_R_DIO_DUMMY_CYCLELEN 1
|
|
|
|
|
#define SPI0_R_DIO_ADDR_BITSLEN 27
|
2019-03-14 05:29:32 -04:00
|
|
|
#define SPI0_R_FAST_ADDR_BITSLEN 23
|
|
|
|
|
#define SPI0_R_SIO_ADDR_BITSLEN 23
|
|
|
|
|
|
|
|
|
|
#define SPI1_R_QIO_DUMMY_CYCLELEN 3
|
|
|
|
|
#define SPI1_R_QIO_ADDR_BITSLEN 31
|
|
|
|
|
#define SPI1_R_FAST_DUMMY_CYCLELEN 7
|
|
|
|
|
#define SPI1_R_DIO_DUMMY_CYCLELEN 3
|
|
|
|
|
#define SPI1_R_DIO_ADDR_BITSLEN 31
|
|
|
|
|
#define SPI1_R_FAST_ADDR_BITSLEN 23
|
|
|
|
|
#define SPI1_R_SIO_ADDR_BITSLEN 23
|
|
|
|
|
|
|
|
|
|
#define ESP_ROM_SPIFLASH_W_SIO_ADDR_BITSLEN 23
|
|
|
|
|
|
|
|
|
|
#define ESP_ROM_SPIFLASH_TWO_BYTE_STATUS_EN SPI_WRSR_2B
|
|
|
|
|
|
|
|
|
|
//SPI address register
|
|
|
|
|
#define ESP_ROM_SPIFLASH_BYTES_LEN 24
|
|
|
|
|
#define ESP_ROM_SPIFLASH_BUFF_BYTE_WRITE_NUM 32
|
|
|
|
|
#define ESP_ROM_SPIFLASH_BUFF_BYTE_READ_NUM 64
|
|
|
|
|
#define ESP_ROM_SPIFLASH_BUFF_BYTE_READ_BITS 0x3f
|
|
|
|
|
|
|
|
|
|
//SPI status register
|
2019-07-05 08:21:36 -04:00
|
|
|
#define ESP_ROM_SPIFLASH_BUSY_FLAG BIT0
|
|
|
|
|
#define ESP_ROM_SPIFLASH_WRENABLE_FLAG BIT1
|
|
|
|
|
#define ESP_ROM_SPIFLASH_BP0 BIT2
|
|
|
|
|
#define ESP_ROM_SPIFLASH_BP1 BIT3
|
|
|
|
|
#define ESP_ROM_SPIFLASH_BP2 BIT4
|
|
|
|
|
#define ESP_ROM_SPIFLASH_WR_PROTECT (ESP_ROM_SPIFLASH_BP0|ESP_ROM_SPIFLASH_BP1|ESP_ROM_SPIFLASH_BP2)
|
|
|
|
|
#define ESP_ROM_SPIFLASH_QE BIT9
|
bootloader: fix the WRSR format for ISSI flash chips
1. The 2nd bootloader always call `rom_spiflash_unlock()`, but never help to clear the WEL bit when exit. This may cause system unstability.
This commit helps to clear WEL when flash configuration is done.
**RISK:** When the app starts, it didn't have to clear the WEL before it actually write/erase. But now the very first write/erase operation should be done after a WEL clear. Though the risk is little (all the following write/erase also need to clear the WEL), we still have to test this carefully, especially for those functions used by the OTA.
2. The `rom_spiflash_unlock()` function in the patch of ESP32 may (1) trigger the QPI, (2) clear the QE or (3) fail to unlock the ISSI chips.
Status register bitmap of ISSI chip and GD chip:
| SR | ISSI | GD25LQ32C |
| -- | ---- | --------- |
| 0 | WIP | WIP |
| 1 | WEL | WEL |
| 2 | BP0 | BP0 |
| 3 | BP1 | BP1 |
| 4 | BP2 | BP2 |
| 5 | BP3 | BP3 |
| 6 | QE | BP4 |
| 7 | SRWD | SRP0 |
| 8 | | SRP1 |
| 9 | | QE |
| 10 | | SUS2 |
| 11 | | LB1 |
| 12 | | LB2 |
| 13 | | LB3 |
| 14 | | CMP |
| 15 | | SUS1 |
QE bit of other chips are at the bit 9 of the status register (i.e. bit 1 of SR2), which should be read by RDSR2 command.
However, the RDSR2 (35H, Read Status 2) command for chip of other vendors happens to be the QIOEN (Enter QPI mode) command of ISSI chips. When the `rom_spiflash_unlock()` function trys to read SR2, it may trigger the QPI of ISSI chips.
Moreover, when `rom_spiflash_unlock()` try to clear the BP4 bit in the status register, QE (bit 6) of ISSI chip may be cleared by accident. Or if the ISSI chip doesn't accept WRSR command with argument of two bytes (since it only have status register of one byte), it may fail to clear the other protect bits (BP0~BP3) as expected.
This commit makes the `rom_spiflash_unlock()` check whether the vendor is issi. if so, `rom_spiflash_unlock()` only send RDSR to read the status register, send WRSR with only 1 byte argument, and also avoid clearing the QE bit (bit 6).
3. `rom_spiflash_unlock()` always send WRSR command to clear protection bits even when there is no protection bit active. And the execution of clearing status registers, which takes about 700us, will also happen even when there's no bits cleared.
This commit skips the clearing of status register if there is no protection bits active.
Also move the execute_flash_command to be a bootloader API; move
implementation of spi_flash_wrap_set to the bootloader
2020-03-12 06:20:31 -04:00
|
|
|
#define ESP_ROM_SPIFLASH_BP_MASK_ISSI (BIT7 | BIT5 | BIT4 | BIT3 | BIT2)
|
2019-07-05 08:21:36 -04:00
|
|
|
|
|
|
|
|
//Extra dummy for flash read
|
|
|
|
|
#define ESP_ROM_SPIFLASH_DUMMY_LEN_PLUS_20M 0
|
2021-01-27 04:11:33 -05:00
|
|
|
#define ESP_ROM_SPIFLASH_DUMMY_LEN_PLUS_26M 0
|
2019-07-05 08:21:36 -04:00
|
|
|
#define ESP_ROM_SPIFLASH_DUMMY_LEN_PLUS_40M 1
|
|
|
|
|
#define ESP_ROM_SPIFLASH_DUMMY_LEN_PLUS_80M 2
|
2019-03-14 05:29:32 -04:00
|
|
|
|
|
|
|
|
#define FLASH_ID_GD25LQ32C 0xC86016
|
|
|
|
|
|
2021-09-28 07:35:36 -04:00
|
|
|
typedef enum {
|
|
|
|
|
ESP_ROM_SPIFLASH_RESULT_OK,
|
|
|
|
|
ESP_ROM_SPIFLASH_RESULT_ERR,
|
|
|
|
|
ESP_ROM_SPIFLASH_RESULT_TIMEOUT
|
|
|
|
|
} esp_rom_spiflash_result_t;
|
|
|
|
|
|
2020-11-25 23:47:32 -05:00
|
|
|
extern uint8_t g_rom_spiflash_dummy_len_plus[];
|
|
|
|
|
|
2019-03-14 05:29:32 -04:00
|
|
|
/**
|
|
|
|
|
* @}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#endif /* _ROM_SPI_FLASH_H_ */
|
