// Copyright 2020-2021 Beken // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #pragma once #ifdef __cplusplus extern "C" { #endif /** * @brief Init the QSPI flash * * @return * - BK_OK: succeed * - BK_ERR_QSPI_NOT_INIT: QSPI driver not init * - others: other errors. */ bk_err_t bk_qspi_flash_init(qspi_id_t id); /** * @brief Deinit the QSPI flash * * @return * - BK_OK: succeed * - BK_ERR_QSPI_NOT_INIT: QSPI driver not init * - others: other errors. */ bk_err_t bk_qspi_flash_deinit(qspi_id_t id); /** * @brief QSPI flash read id * * @return * - BK_OK: succeed * - others: other errors. */ uint32_t bk_qspi_flash_read_id(qspi_id_t id); /** * @brief QSPI flash set protect type as none to do erase / write * * @return * - BK_OK: succeed * - others: other errors. */ void bk_qspi_flash_set_protect_none(qspi_id_t id); /** * @brief QSPI flash erase sector * * @return * - BK_OK: succeed * - others: other errors. */ bk_err_t bk_qspi_flash_erase_sector(qspi_id_t id, uint32_t addr); /** * @brief QSPI flash enable quad mode * * @return * - NA. */ void bk_qspi_flash_quad_enable(qspi_id_t id); /** * @brief QSPI flash quad write * * @param addr QSPI write address * @param data QSPI write data * @param size the size of QSPI write data * * @return * - BK_OK: succeed * - others: other errors. */ bk_err_t bk_qspi_flash_quad_page_program(qspi_id_t id, uint32_t addr, const void *data, uint32_t size); /** * @brief QSPI flash single write * * @param addr QSPI write address * @param data QSPI write data * @param size the size of QSPI write data * @return * - BK_OK: succeed * - others: other errors. */ bk_err_t bk_qspi_flash_single_page_program(qspi_id_t id, uint32_t addr, const void *data, uint32_t size); /** * @brief QSPI flash quad read * * @param addr QSPI read address * @param data QSPI read data * @param size the size of QSPI read data * * @return * - BK_OK: succeed * - others: other errors. */ bk_err_t bk_qspi_flash_quad_read(qspi_id_t id, uint32_t addr, void *data, uint32_t size); /** * @brief QSPI flash single read * @param addr QSPI read address * @param data QSPI read data * @param size the size of QSPI read data * * @return * - BK_OK: succeed * - others: other errors. */ bk_err_t bk_qspi_flash_single_read(qspi_id_t id, uint32_t addr, void *data, uint32_t size); /** * @brief QSPI flash write data * * @param base_addr QSPI write address * @param data QSPI write data * @param size the size of QSPI write data * * @return * - BK_OK: succeed * - others: other errors. */ bk_err_t bk_qspi_flash_write(qspi_id_t id, uint32_t base_addr, const void *data, uint32_t size); /** * @brief QSPI flash read data * * @param base_addr QSPI read address * @param data QSPI read data * @param size the size of QSPI read data * * @return * - BK_OK: succeed * - others: other errors. */ bk_err_t bk_qspi_flash_read(qspi_id_t id, uint32_t base_addr, void *data, uint32_t size); #ifdef __cplusplus } #endif