| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- /*!
- \file gd25qxx.h
- \brief the header file of SPI flash gd25qxx driver
- \version 2023-06-30, V2.1.6, firmware for GD32F30x
- */
- /*
- Copyright (c) 2023, GigaDevice Semiconductor Inc.
- Redistribution and use in source and binary forms, with or without modification,
- are permitted provided that the following conditions are met:
- 1. Redistributions of source code must retain the above copyright notice, this
- list of conditions and the following disclaimer.
- 2. 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.
- 3. Neither the name of the copyright holder 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 THE COPYRIGHT HOLDER OR 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.
- */
- #ifndef GD25QXX_H
- #define GD25QXX_H
- #include "gd32f30x.h"
- #define SPI_FLASH_PAGE_SIZE 0x100
- #define SPI_FLASH_CS_LOW() gpio_bit_reset(GPIOE, GPIO_PIN_3)
- #define SPI_FLASH_CS_HIGH() gpio_bit_set(GPIOE, GPIO_PIN_3)
- /* initialize SPI0 GPIO and parameter */
- void spi_flash_init(void);
- /* erase the specified flash sector */
- void spi_flash_sector_erase(uint32_t sector_addr);
- /* erase the entire flash */
- void spi_flash_bulk_erase(void);
- /* write more than one byte to the flash */
- void spi_flash_page_write(uint8_t* pbuffer,uint32_t write_addr,uint16_t num_byte_to_write);
- /* write block of data to the flash */
- void spi_flash_buffer_write(uint8_t* pbuffer,uint32_t write_addr,uint16_t num_byte_to_write);
- /* read a block of data from the flash */
- void spi_flash_buffer_read(uint8_t* pbuffer,uint32_t read_addr,uint16_t num_byte_to_read);
- /* read flash identification */
- uint32_t spi_flash_read_id(void);
- /* initiate a read data byte (read) sequence from the flash */
- void spi_flash_start_read_sequence(uint32_t read_addr);
- /* read a byte from the SPI flash */
- uint8_t spi_flash_read_byte(void);
- /* send a byte through the SPI interface and return the byte received from the SPI bus */
- uint8_t spi_flash_send_byte(uint8_t byte);
- /* send a half word through the SPI interface and return the half word received from the SPI bus */
- uint16_t spi_flash_send_halfword(uint16_t half_word);
- /* enable the write access to the flash */
- void spi_flash_write_enable(void);
- /* poll the status of the write in progress (wip) flag in the flash's status register */
- void spi_flash_wait_for_write_end(void);
- void spi_flash_block_erase(uint32_t block_addr);
- #endif /* GD25QXX_H */
|
