Header file containing functions prototypes of EXFLASH HAL library. More...
Go to the source code of this file.
Classes | |
struct | _exflash_handle |
exFlash handle Structure definition More... | |
struct | _exflash_timing_param |
exFlash AC characteristics More... | |
struct | _hal_exflash_callback |
HAL_EXFLASH Callback function definition. More... | |
Typedefs | |
typedef struct _exflash_handle | exflash_handle_t |
exFlash handle Structure definition More... | |
typedef struct _exflash_timing_param | exflash_timing_param_t |
exFlash AC characteristics More... | |
typedef ll_xqspi_hp_init_t | exflash_hp_init_t |
HP Mode structure definition. More... | |
typedef struct _hal_exflash_callback | hal_exflash_callback_t |
HAL_EXFLASH Callback function definition. More... | |
Enumerations | |
enum | hal_exflash_state_t { HAL_EXFLASH_STATE_RESET = 0x00, HAL_EXFLASH_STATE_READY = 0x01, HAL_EXFLASH_STATE_BUSY = 0x02, HAL_EXFLASH_STATE_BUSY_READ = 0x12, HAL_EXFLASH_STATE_BUSY_WRITE = 0x22, HAL_EXFLASH_STATE_BUSY_ERASE = 0x42, HAL_EXFLASH_STATE_SUSPEND_WRITE = 0x21, HAL_EXFLASH_STATE_SUSPEND_ERASE = 0x41, HAL_EXFLASH_STATE_ERROR = 0x04 } |
HAL exFlash State Enumerations definition. More... | |
enum | hal_exflash_security_t { HAL_EXFLASH_UNENCRYPTED = 0x00, HAL_EXFLASH_ENCRYPTED = 0x01 } |
HAL exFlash Security Enumerations definition. More... | |
Functions | |
hal_status_t | hal_exflash_init (void) |
Initialize the exFlash according to the specified parameters in the exflash_init_t and initialize the associated handle. More... | |
hal_status_t | hal_exflash_deinit (void) |
De-initialize the exFlash peripheral. More... | |
void | hal_exflash_msp_init (void) |
Initialize the exFlash MSP. More... | |
void | hal_exflash_msp_deinit (void) |
De-initialize the exFlash MSP. More... | |
void | hal_exflash_timing_set (exflash_timing_param_t *p_time) |
According to the model of internal flash, configure AC parameters to meet the requirements of flash operation timing. More... | |
hal_status_t | hal_exflash_operation_protection (uint32_t base_priority) |
During Flash erase/write operation, Disable external interrupts with a priority less than or equal to base_priority in the system. More... | |
void | hal_exflash_set_security (hal_exflash_security_t mode) |
Configure the security mode of flash interface. More... | |
hal_exflash_security_t | hal_exflash_get_security (void) |
Read the security mode of flash interface. More... | |
hal_status_t | hal_exflash_page_configure (uint32_t size_type) |
Configure page programming buffer size. More... | |
hal_status_t | hal_exflash_write (uint32_t addr, uint8_t *p_data, uint32_t size) |
Write an amount of data with specified instruction and address to flash. More... | |
hal_status_t | hal_exflash_read (uint32_t addr, uint8_t *p_data, uint32_t size) |
Read an amount of data with specified instruction and address from flash. More... | |
hal_status_t | hal_exflash_erase (uint32_t erase_type, uint32_t addr, uint32_t size) |
Erase flash region. More... | |
hal_status_t | hal_exflash_suspend (void) |
Suspend flash pragram/erase. More... | |
hal_status_t | hal_exflash_resume (void) |
Resume flash pragram/erase. More... | |
hal_status_t | hal_exflash_lock (uint32_t lock_type) |
Lock area of flash to be software protected against Write and Erase operation. More... | |
hal_status_t | hal_exflash_unlock (void) |
Unlock write/erase protected in flash. More... | |
hal_status_t | hal_exflash_deepsleep (void) |
the exFlash will go to the Deep Power-Down Mode. More... | |
hal_status_t | hal_exflash_wakeup (void) |
exFlash will be released from Deep Power-Down Mode. More... | |
hal_status_t | hal_exflash_enable_quad (exflash_hp_init_t *hp_init) |
Enable Quad mode to allow Quad operation. More... | |
hal_status_t | hal_exflash_read_uid (uint8_t *uid) |
This function serves to read UID of flash. More... | |
hal_exflash_state_t | hal_exflash_get_state (void) |
Return the exFlash handle state. More... | |
uint32_t | hal_exflash_get_error (void) |
Return the exFlash error code. More... | |
hal_status_t | hal_exflash_read_status_reg (uint16_t *p_reg_status) |
This function reads the status register of a flash. More... | |
hal_status_t | hal_exflash_write_status_reg (uint16_t reg_status) |
This function writes the status register of a flash. More... | |
Header file containing functions prototypes of EXFLASH HAL library.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Definition in file gr55xx_hal_exflash.h.