sqiflash.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 SQIFLASH_H
#define SQIFLASH_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define SQIFLASH_STATUS_WEL             0x02 
#define SQIFLASH_STATUS_WSE             0x04 
#define SQIFLASH_STATUS_WSP             0x08 
#define SQIFLASH_STATUS_WPLD            0x10 
#define SQIFLASH_STATUS_SEC             0x20 
#define SQIFLASH_STATUS_RES             0x40  
#define SQIFLASH_STATUS_BUSY            0x80
#define SQIFLASH_CFG_RES                0x01 
#define SQIFLASH_CFG_IOC                0x02 
#define SQIFLASH_CFG_BPNV               0x08 
#define SQIFLASH_CFG_WPEN               0x80 
 
#define SQIFLASH_INSTR_NOP              0x00 
#define SQIFLASH_INSTR_RSTEN            0x66 
#define SQIFLASH_INSTR_RST              0x99 
#define SQIFLASH_INSTR_EQIO             0x38 
#define SQIFLASH_INSTR_RSTQIO           0xFF 
#define SQIFLASH_INSTR_RDSR             0x05 
#define SQIFLASH_INSTR_WRSR             0x01 
#define SQIFLASH_INSTR_RDCR             0x35 
#define SQIFLASH_INSTR_READ             0x03 
#define SQIFLASH_INSTR_HS_READ          0x0B 
#define SQIFLASH_INSTR_SQOR             0x6B 
#define SQIFLASH_INSTR_SQIOR            0xEB 
#define SQIFLASH_INSTR_SDOR             0x3B 
#define SQIFLASH_INSTR_SDIOR            0xBB 
#define SQIFLASH_INSTR_SB               0xC0 
#define SQIFLASH_INSTR_RBSQI            0x0C 
#define SQIFLASH_INSTR_RBSPI            0xEC 
#define SQIFLASH_INSTR_JEDECID          0x9F 
#define SQIFLASH_INSTR_QUAD_JID         0xAF 
#define SQIFLASH_INSTR_SFDP             0x5A 
#define SQIFLASH_INSTR_WREN             0x06 
#define SQIFLASH_INSTR_WRDI             0x04 
#define SQIFLASH_INSTR_SE               0x20 
#define SQIFLASH_INSTR_BE               0xD8 
#define SQIFLASH_INSTR_CE               0xC7 
#define SQIFLASH_INSTR_PP               0x02 
#define SQIFLASH_INSTR_SPI_QUAD         0x32 
#define SQIFLASH_INSTR_WRSU             0xB0 
#define SQIFLASH_INSTR_WRRE             0x30 
#define SQIFLASH_INSTR_RBPR             0x72 
#define SQIFLASH_INSTR_WBPR             0x42 
#define SQIFLASH_INSTR_LBPR             0x8D 
#define SQIFLASH_INSTR_NVWLDR           0xE8 
#define SQIFLASH_INSTR_ULBPR            0x98 
#define SQIFLASH_INSTR_RSID             0x88 
#define SQIFLASH_INSTR_PSID             0xA5 
#define SQIFLASH_INSTR_LSID             0x85 
#define SQIFLASH_START_PAGE_ADDRESS     0x010000ul
#define SQIFLASH_END_PAGE_ADDRESS       0x7FFFFFul
#define SQIFLASH_FLASH_PAGE_SIZE        256
 
#define SQIFLASH_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
#define SQIFLASH_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
 
 // sqiflash_set
 
#define SQIFLASH_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.sq3 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.sq2 = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // sqiflash_map
 // sqiflash
 
typedef struct
{
    // Output pins
    digital_out_t sq3;                                  
    digital_out_t sq2;                                  
    // Modules
    spi_master_t  spi;                                  
    pin_name_t  chip_select;                            
} sqiflash_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                                   
    pin_name_t  mosi;                                   
    pin_name_t  sck;                                    
    pin_name_t  cs;                                     
    // Additional gpio pins
    pin_name_t  sq3;                                    
    pin_name_t  sq2;                                    
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} sqiflash_cfg_t;
 
typedef enum
{
    SQIFLASH_OK = 0,
    SQIFLASH_ERROR = -1
 
} sqiflash_return_value_t;
 
void sqiflash_cfg_setup ( sqiflash_cfg_t *cfg );
 
err_t sqiflash_init ( sqiflash_t *ctx, sqiflash_cfg_t *cfg );
 
err_t sqiflash_generic_write ( sqiflash_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t sqiflash_generic_read ( sqiflash_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t sqiflash_busy ( sqiflash_t *ctx );
 
uint8_t sqiflash_get_status_reg ( sqiflash_t *ctx );
 
uint8_t sqiflash_erase_status ( sqiflash_t *ctx );
 
uint8_t sqiflash_write_status ( sqiflash_t *ctx );
 
uint8_t sqiflash_program_status ( sqiflash_t *ctx );
 
uint8_t sqiflash_protect_status ( sqiflash_t *ctx );
 
void sqiflash_lock_security_id ( sqiflash_t *ctx );
 
uint8_t sqiflash_security_status ( sqiflash_t *ctx );
 
void sqiflash_write_protect_enable ( sqiflash_t *ctx );
 
void sqiflash_write_protect_disable ( sqiflash_t *ctx );
 
void sqiflash_hold_enable ( sqiflash_t *ctx );
 
void sqiflash_hold_disable ( sqiflash_t *ctx );
 
void sqiflash_write_suspend ( sqiflash_t *ctx );
 
 
void sqiflash_write_resume ( sqiflash_t *ctx );
 
void sqiflash_spi_get_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_sqi_get_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_set_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_write_disable ( sqiflash_t *ctx );
 
void sqiflash_spi_get_bpr ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_sqi_get_bpr ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_set_bpr ( sqiflash_t *ctx, uint8_t *buffer );
 
void sqiflash_lock_bpr ( sqiflash_t *ctx );
 
void sqiflash_nonvolatile_write_lock ( sqiflash_t *ctx, uint8_t *buffer );
 
void sqiflash_global_block_unlock ( sqiflash_t *ctx );
 
void sqiflash_read_generic ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_highspeed_r_read ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_quad_write ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_write_generic ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_quad_enable ( sqiflash_t *ctx );
 
void sqiflash_quad_out_read ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_quad_io_read ( sqiflash_t *ctx, uint32_t address, uint8_t mode, 
                             uint8_t *buffer, uint32_t data_count );
 
void sqiflash_quad_reset ( sqiflash_t *ctx );
 
void sqiflash_set_burst ( sqiflash_t *ctx, uint8_t length );
 
void sqiflash_read_sqi_burst_wrap ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_read_spi_burst_wrap ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_read_dual_output ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_read_dual_io ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void sqiflash_sector_erase ( sqiflash_t *ctx, uint32_t address );
 
void sqiflash_block_erase ( sqiflash_t *ctx, uint32_t address );
 
void sqiflash_chip_erase ( sqiflash_t *ctx );
 
void sqiflash_get_sfdp_params ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
uint8_t sqiflash_quad_device_manufac ( sqiflash_t *ctx );
 
uint8_t sqiflash_quad_device_type ( sqiflash_t *ctx );
 
uint8_t sqiflash_quad_device_id ( sqiflash_t *ctx  );
 
uint8_t sqiflash_device_manufac ( sqiflash_t *ctx );
 
uint8_t sqiflash_device_type ( sqiflash_t *ctx );
 
uint8_t sqiflash_device_id ( sqiflash_t *ctx );
 
void sqiflash_reset ( sqiflash_t *ctx );
 
void sqiflash_write_status_reg ( sqiflash_t *ctx, uint8_t s_reg );
 
uint8_t sqiflash_get_config_reg ( sqiflash_t *ctx );
 
void sqiflash_write_enable ( sqiflash_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SQIFLASH_H
 
 // sqiflash
 
// ------------------------------------------------------------------------ END