65 lines
2.3 KiB
C
65 lines
2.3 KiB
C
|
/**
|
||
|
|
* The MIT License (MIT)
|
||
|
|
*
|
||
|
|
* Copyright (c) 2016 sheinz (https://github.com/sheinz)
|
||
|
|
*
|
||
|
|
* Permission is hereby granted, 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 __ESP_SPIFFS_FLASH_H__
|
||
|
|
#define __ESP_SPIFFS_FLASH_H__
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
#include "common_macros.h"
|
||
|
|
|
||
|
|
#define ESP_SPIFFS_FLASH_OK 0
|
||
|
|
#define ESP_SPIFFS_FLASH_ERROR 1
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Read data from SPI flash.
|
||
|
|
*
|
||
|
|
* @param addr Address to read from. Can be not aligned.
|
||
|
|
* @param buf Buffer to read to. Doesn't have to be aligned.
|
||
|
|
* @param size Size of data to read. Buffer size must be >= than data size.
|
||
|
|
*
|
||
|
|
* @return ESP_SPIFFS_FLASH_OK or ESP_SPIFFS_FLASH_ERROR
|
||
|
|
*/
|
||
|
|
uint32_t IRAM esp_spiffs_flash_read(uint32_t addr, uint8_t *buf, uint32_t size);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Write data to SPI flash.
|
||
|
|
*
|
||
|
|
* @param addr Address to write to. Can be not aligned.
|
||
|
|
* @param buf Buffer of data to write to flash. Doesn't have to be aligned.
|
||
|
|
* @param size Size of data to write. Buffer size must be >= than data size.
|
||
|
|
*
|
||
|
|
* @return ESP_SPIFFS_FLASH_OK or ESP_SPIFFS_FLASH_ERROR
|
||
|
|
*/
|
||
|
|
uint32_t IRAM esp_spiffs_flash_write(uint32_t addr, uint8_t *buf, uint32_t size);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Erase a sector.
|
||
|
|
*
|
||
|
|
* @param addr Address of sector to erase. Must be sector aligned.
|
||
|
|
*
|
||
|
|
* @return ESP_SPIFFS_FLASH_OK or ESP_SPIFFS_FLASH_ERROR
|
||
|
|
*/
|
||
|
|
uint32_t IRAM esp_spiffs_flash_erase_sector(uint32_t addr);
|
||
|
|
|
||
|
|
#endif // __ESP_SPIFFS_FLASH_H__
|