ice_flash.h

/*
 * MIT License
 * 
 * Copyright (c) 2023 tinyVision.ai
 * 
 * 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.
 */
 
#pragma once
#include <stdint.h>
#include <stddef.h>
 
#include "ice_fpga_data.h"
 
#define ICE_FLASH_PAGE_SIZE         256
#define ICE_FLASH_SECTOR_SIZE       4096
#define ICE_FLASH_BLOCK_SIZE        65536
 
#ifdef __cplusplus
extern "C" {
#endif
 
int ice_flash_init(const ice_spibus spibus, int baudrate);
 
int ice_flash_read(const ice_spibus spibus, uint32_t addr, uint8_t *buf, size_t sz);
 
int ice_flash_erase_sector(const ice_spibus spibus, uint32_t addr);
 
int ice_flash_program_page(const ice_spibus spibus, uint32_t addr, uint8_t const page[ICE_FLASH_PAGE_SIZE]);
 
int ice_flash_erase_block(const ice_spibus spibus, uint32_t addr);
 
int ice_flash_erase_chip(const ice_spibus spibus);
 
int ice_flash_wakeup(const ice_spibus spibus);
 
int ice_flash_sleep(const ice_spibus spibus);
 
int ice_flash_deinit(const ice_spibus spibus);
 
#ifdef __cplusplus
}
#endif