From a626b26cf97c00546e546e4a69cdfece1d1edc08 Mon Sep 17 00:00:00 2001 From: "Michael (XIAO Xufeng)" Date: Sat, 3 Aug 2019 09:59:10 +0800 Subject: [PATCH] esp_flash: improve the comments a bit --- components/soc/include/hal/spi_flash_hal.h | 15 +++++--- .../spi_flash/include/memspi_host_driver.h | 2 + .../include/spi_flash_chip_generic.h | 37 +++++++++++-------- components/spi_flash/spi_flash_chip_issi.c | 1 - 4 files changed, 33 insertions(+), 22 deletions(-) diff --git a/components/soc/include/hal/spi_flash_hal.h b/components/soc/include/hal/spi_flash_hal.h index 3a18e4ca5f..bf89c41488 100644 --- a/components/soc/include/hal/spi_flash_hal.h +++ b/components/soc/include/hal/spi_flash_hal.h @@ -88,14 +88,15 @@ esp_err_t spi_flash_hal_device_config(spi_flash_host_driver_t *driver); esp_err_t spi_flash_hal_common_command(spi_flash_host_driver_t *driver, spi_flash_trans_t *trans); /** - * Erase whole flash chip. + * Erase whole flash chip by using the erase chip (C7h) command. * * @param driver The driver context. */ void spi_flash_hal_erase_chip(spi_flash_host_driver_t *driver); /** - * Erase a specific sector by its start address. + * Erase a specific sector by its start address through the sector erase (20h) + * command. * * @param driver The driver context. * @param start_address Start address of the sector to erase. @@ -103,7 +104,8 @@ void spi_flash_hal_erase_chip(spi_flash_host_driver_t *driver); void spi_flash_hal_erase_sector(spi_flash_host_driver_t *driver, uint32_t start_address); /** - * Erase a specific block by its start address. + * Erase a specific 64KB block by its start address through the 64KB block + * erase (D8h) command. * * @param driver The driver context. * @param start_address Start address of the block to erase. @@ -111,7 +113,7 @@ void spi_flash_hal_erase_sector(spi_flash_host_driver_t *driver, uint32_t start_ void spi_flash_hal_erase_block(spi_flash_host_driver_t *driver, uint32_t start_address); /** - * Program a page of the flash. + * Program a page of the flash using the page program (02h) command. * * @param driver The driver context. * @param address Address of the page to program @@ -121,7 +123,8 @@ void spi_flash_hal_erase_block(spi_flash_host_driver_t *driver, uint32_t start_a void spi_flash_hal_program_page(spi_flash_host_driver_t *driver, const void *buffer, uint32_t address, uint32_t length); /** - * Read from the flash. The read command should be set by ``spi_flash_hal_configure_host_read_mode`` before. + * Read from the flash. Call ``spi_flash_hal_configure_host_read_mode`` to + * configure the read command before calling this function. * * @param driver The driver context. * @param buffer Buffer to store the read data @@ -133,7 +136,7 @@ void spi_flash_hal_program_page(spi_flash_host_driver_t *driver, const void *buf esp_err_t spi_flash_hal_read(spi_flash_host_driver_t *driver, void *buffer, uint32_t address, uint32_t read_len); /** - * Enable or disable the write protection of the flash chip. + * @brief Send the write enable (06h) or write disable (04h) command to the flash chip. * * @param driver The driver context. * @param wp true to enable the write protection, otherwise false. diff --git a/components/spi_flash/include/memspi_host_driver.h b/components/spi_flash/include/memspi_host_driver.h index 2347398aa1..434361d970 100644 --- a/components/spi_flash/include/memspi_host_driver.h +++ b/components/spi_flash/include/memspi_host_driver.h @@ -62,6 +62,8 @@ esp_err_t memspi_host_init_pointers(spi_flash_host_driver_t *host, memspi_host_d ******************************************************************************/ /** + * @brief Read the Status Register read from RDSR (05h). + * * High speed implementation of RDID through memspi interface relying on the * ``common_command``. * diff --git a/components/spi_flash/include/spi_flash_chip_generic.h b/components/spi_flash/include/spi_flash_chip_generic.h index 885bd72e75..672ca6550b 100644 --- a/components/spi_flash/include/spi_flash_chip_generic.h +++ b/components/spi_flash/include/spi_flash_chip_generic.h @@ -66,7 +66,7 @@ esp_err_t spi_flash_chip_generic_reset(esp_flash_t *chip); esp_err_t spi_flash_chip_generic_detect_size(esp_flash_t *chip, uint32_t *size); /** - * @brief Erase chip by using the generic erase chip (C7h) command. + * @brief Erase chip by using the generic erase chip command. * * @param chip Pointer to SPI flash chip to use. If NULL, esp_flash_default_chip is substituted. * @@ -77,7 +77,7 @@ esp_err_t spi_flash_chip_generic_detect_size(esp_flash_t *chip, uint32_t *size); esp_err_t spi_flash_chip_generic_erase_chip(esp_flash_t *chip); /** - * @brief Erase sector by using the generic sector erase (20h) command. + * @brief Erase sector by using the generic sector erase command. * * @param chip Pointer to SPI flash chip to use. If NULL, esp_flash_default_chip is substituted. * @param start_address Start address of the sector to erase @@ -89,7 +89,7 @@ esp_err_t spi_flash_chip_generic_erase_chip(esp_flash_t *chip); esp_err_t spi_flash_chip_generic_erase_sector(esp_flash_t *chip, uint32_t start_address); /** - * @brief Erase block by using the generic 64KB block erase (D8h) command + * @brief Erase block by the generic 64KB block erase command * * @param chip Pointer to SPI flash chip to use. If NULL, esp_flash_default_chip is substituted. * @param start_address Start address of the block to erase @@ -114,7 +114,7 @@ esp_err_t spi_flash_chip_generic_erase_block(esp_flash_t *chip, uint32_t start_a esp_err_t spi_flash_chip_generic_read(esp_flash_t *chip, void *buffer, uint32_t address, uint32_t length); /** - * @brief Perform a page program using the page program (02h) command. + * @brief Perform a page program using the page program command. * * @note Length of each call should not excced the limitation in * ``chip->host->max_write_bytes``. This function is called in @@ -163,7 +163,7 @@ esp_err_t spi_flash_chip_generic_write_encrypted(esp_flash_t *chip, const void *buffer, uint32_t address, uint32_t length); /** - * @brief Send the write enable (06h) command and verify the expected bit (1) in + * @brief Send the write enable or write disable command and verify the expected bit (1) in * the status register is set. * * @param chip Pointer to SPI flash chip to use. If NULL, esp_flash_default_chip is substituted. @@ -171,12 +171,13 @@ spi_flash_chip_generic_write_encrypted(esp_flash_t *chip, const void *buffer, ui * * @return * - ESP_OK if success - * - or other error passed from the ``wait_idle``, ``read_status`` or ``set_write_protect`` function of host driver + * - or other error passed from the ``wait_idle``, ``read_status`` or + * ``set_write_protect`` function of host driver */ esp_err_t spi_flash_chip_generic_set_write_protect(esp_flash_t *chip, bool write_protect); /** - * @brief Check whether WEL (write enable latch) bit is set in the Status Register read from RDSR (05h). + * @brief Check whether WEL (write enable latch) bit is set in the Status Register read from RDSR. * * @param chip Pointer to SPI flash chip to use. If NULL, esp_flash_default_chip is substituted. * @param out_write_protect Output of whether the write protect is set. @@ -188,8 +189,8 @@ esp_err_t spi_flash_chip_generic_set_write_protect(esp_flash_t *chip, bool write esp_err_t spi_flash_chip_generic_get_write_protect(esp_flash_t *chip, bool *out_write_protect); /** - * @brief Read flash status via the RDSR command (05h) and wait for bit 0 (write - * in progress bit) to be cleared. + * @brief Read flash status via the RDSR command and wait for bit 0 (write in + * progress bit) to be cleared. * * @param chip Pointer to SPI flash chip to use. If NULL, esp_flash_default_chip is substituted. * @param timeout_ms Time to wait before timeout, in ms. @@ -244,13 +245,15 @@ extern const spi_flash_chip_t esp_flash_chip_generic; esp_err_t spi_flash_generic_wait_host_idle(esp_flash_t *chip, uint32_t *timeout_ms); /** - * @brief Utility function for set_read_mode chip_drv function + * @brief Utility function for set_read_mode chip_drv function. If required, + * set and check the QE bit in the flash chip to enable the QIO/QOUT mode. * - * Most setting of read mode follows a common pattern, except for how to enable Quad I/O modes (QIO/QOUT). - * These use different commands to read/write the status register, and a different bit is set/cleared. + * Most chip QE enable follows a common pattern, though commands to read/write + * the status register may be different, as well as the position of QE bit. * - * This is a generic utility function to implement set_read_mode() for this pattern. Also configures host - * registers via spi_flash_common_configure_host_read_mode(). + * Registers to actually do Quad transtions and command to be sent in reading + * should also be configured via + * spi_flash_chip_generic_config_host_read_mode(). * * @param qe_rdsr_command SPI flash command to read status register * @param qe_wrsr_command SPI flash command to write status register @@ -262,7 +265,11 @@ esp_err_t spi_flash_generic_wait_host_idle(esp_flash_t *chip, uint32_t *timeout_ esp_err_t spi_flash_common_set_read_mode(esp_flash_t *chip, uint8_t qe_rdsr_command, uint8_t qe_wrsr_command, uint8_t qe_sr_bitwidth, unsigned qe_sr_bit); /** - * @brief Configure the host to use the specified read mode set in the ``chip->read_mode``. + * @brief Configure the host registers to use the specified read mode set in + * the ``chip->read_mode``. + * + * Usually called in chip_drv read() functions before actual reading + * transactions. Also prepare the command to be sent in read functions. * * @param chip Pointer to SPI flash chip to use. If NULL, esp_flash_default_chip is substituted. * diff --git a/components/spi_flash/spi_flash_chip_issi.c b/components/spi_flash/spi_flash_chip_issi.c index d0b025637f..71684ec195 100644 --- a/components/spi_flash/spi_flash_chip_issi.c +++ b/components/spi_flash/spi_flash_chip_issi.c @@ -57,7 +57,6 @@ const spi_flash_chip_t esp_flash_chip_issi = { .sector_size = 4 * 1024, .block_erase_size = 64 * 1024, - // TODO: support get/set chip write protect for ISSI flash .get_chip_write_protect = spi_flash_chip_generic_get_write_protect, .set_chip_write_protect = spi_flash_chip_generic_set_write_protect,