spi_flash.h

/*
 * ESPRSSIF MIT License
 *
 * Copyright (c) 2015 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
 *
 * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,
 * it is free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished
 * to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#ifndef __SPI_FLASH_H__
#define __SPI_FLASH_H__

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    SPI_FLASH_RESULT_OK,        
    SPI_FLASH_RESULT_ERR,       
    SPI_FLASH_RESULT_TIMEOUT    
} SpiFlashOpResult;

typedef struct{
    uint32  deviceId;
    uint32  chip_size;    // chip size in byte
    uint32  block_size;
    uint32  sector_size;
    uint32  page_size;
    uint32  status_mask;
} SpiFlashChip;

#define SPI_FLASH_SEC_SIZE  4096    
uint32 spi_flash_get_id(void);

SpiFlashOpResult spi_flash_read_status(uint32 *status);

SpiFlashOpResult spi_flash_write_status(uint32 status_value);

SpiFlashOpResult spi_flash_erase_sector(uint16 sec);

SpiFlashOpResult spi_flash_write(uint32 des_addr, uint32 *src_addr, uint32 size);

SpiFlashOpResult spi_flash_read(uint32 src_addr, uint32 *des_addr, uint32 size);

typedef SpiFlashOpResult (* user_spi_flash_read)(
        SpiFlashChip *spi,
        uint32 src_addr,
        uint32 *des_addr,
        uint32 size);

void spi_flash_set_read_func(user_spi_flash_read read);

#ifdef __cplusplus
}
#endif

#endif