flash2.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 FLASH2_H
#define FLASH2_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define FLASH2_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.hld = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define            FLASH2_STATUS_WEL             0x02 
#define            FLASH2_STATUS_WSE             0x04 
#define            FLASH2_STATUS_WSP             0x08 
#define            FLASH2_STATUS_WPLD            0x10 
#define            FLASH2_STATUS_SEC             0x20 
#define            FLASH2_STATUS_RES             0x40  
#define            FLASH2_STATUS_BUSY            0x80
 
 
#define            FLASH2_CFG_RES                0x01 
#define            FLASH2_CFG_IOC                0x02 
#define            FLASH2_CFG_BPNV               0x08 
#define            FLASH2_CFG_WPEN               0x80 
 
 
#define            FLASH2_INSTR_NOP              0x00 
#define            FLASH2_INSTR_RSTEN            0x66 
#define            FLASH2_INSTR_RST              0x99 
#define            FLASH2_INSTR_EQIO             0x38 
#define            FLASH2_INSTR_RSTQIO           0xFF 
#define            FLASH2_INSTR_RDSR             0x05 
#define            FLASH2_INSTR_WRSR             0x01 
#define            FLASH2_INSTR_RDCR             0x35 
#define            FLASH2_INSTR_READ             0x03 
#define            FLASH2_INSTR_HS_READ          0x0B 
#define            FLASH2_INSTR_SQOR             0x6B 
#define            FLASH2_INSTR_SQIOR            0xEB 
#define            FLASH2_INSTR_SDOR             0x3B 
#define            FLASH2_INSTR_SDIOR            0xBB 
#define            FLASH2_INSTR_SB               0xC0 
#define            FLASH2_INSTR_RBSQI            0x0C 
#define            FLASH2_INSTR_RBSPI            0xEC 
#define            FLASH2_INSTR_JEDECID          0x9F 
#define            FLASH2_INSTR_QUAD_JID         0xAF 
#define            FLASH2_INSTR_SFDP             0x5A 
#define            FLASH2_INSTR_WREN             0x06 
#define            FLASH2_INSTR_WRDI             0x04 
#define            FLASH2_INSTR_SE               0x20 
#define            FLASH2_INSTR_BE               0xD8 
#define            FLASH2_INSTR_CE               0xC7 
#define            FLASH2_INSTR_PP               0x02 
#define            FLASH2_INSTR_SPI_QUAD         0x32 
#define            FLASH2_INSTR_WRSU             0xB0 
#define            FLASH2_INSTR_WRRE             0x30 
#define            FLASH2_INSTR_RBPR             0x72 
#define            FLASH2_INSTR_WBPR             0x42 
#define            FLASH2_INSTR_LBPR             0x8D 
#define            FLASH2_INSTR_NVWLDR           0xE8 
#define            FLASH2_INSTR_ULBPR            0x98 
#define            FLASH2_INSTR_RSID             0x88 
#define            FLASH2_INSTR_PSID             0xA5 
#define            FLASH2_INSTR_LSID             0x85 
#define            FLASH2_START_PAGE_ADDRESS 0x010000
#define            FLASH2_END_PAGE_ADDRESS   0x7FFFFF
#define            FLASH2_FLASH_PAGE_SIZE    256
#define FLASH2_RETVAL  uint8_t
 
#define FLASH2_OK           0x00
#define FLASH2_INIT_ERROR   0xFF
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_out_t cs;
 
    // Output pins 
 
    digital_out_t hld;
    digital_out_t wp;
 
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} flash2_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 hld;
    pin_name_t wp;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} flash2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void flash2_cfg_setup ( flash2_cfg_t *cfg );
 
FLASH2_RETVAL flash2_init ( flash2_t *ctx, flash2_cfg_t *cfg );
 
void flash2_generic_transfer ( flash2_t *ctx, uint8_t *wr_buf, 
                               uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
 
uint8_t flash2_busy( flash2_t *ctx );
 
uint8_t flash2_get_status_reg( flash2_t *ctx );
 
uint8_t flash2_erase_status( flash2_t *ctx );
 
uint8_t flash2_write_status( flash2_t *ctx );
 
uint8_t flash2_program_status( flash2_t *ctx );
 
uint8_t flash2_protect_status( flash2_t *ctx );
 
void flash2_lock_security_id( flash2_t *ctx );
 
uint8_t flash2_security_status( flash2_t *ctx );
 
void flash2_write_protect_enable( flash2_t *ctx );
 
void flash2_write_protect_disable( flash2_t *ctx );
 
void flash2_hold_enable( flash2_t *ctx );
 
void flash2_hold_disable( flash2_t *ctx );
 
void flash2_write_suspend( flash2_t *ctx );
 
 
void flash2_write_resume( flash2_t *ctx );
 
void flash2_spi_get_security_id( flash2_t *ctx, uint8_t *buffer, uint32_t data_count);
 
void flash2_sqi_get_security_id( flash2_t *ctx, uint8_t *buffer, uint32_t data_count);
 
void flash2_set_security_id( flash2_t *ctx, uint8_t *buffer, uint32_t data_count );
 
void flash2_write_disable( flash2_t *ctx );
 
void flash2_spi_get_bpr( flash2_t *ctx, uint8_t *buffer, uint32_t data_count );
 
void flash2_sqi_get_bpr( flash2_t *ctx, uint8_t *buffer, uint32_t data_count  );
 
void flash2_set_bpr( flash2_t *ctx, uint8_t *buffer );
 
void flash2_lockBpr( flash2_t *ctx );
 
void flash2_nonvolatile_write_lock( flash2_t *ctx, uint8_t *buffer);
 
void flash2_global_block_unlock( flash2_t *ctx );
 
void flash2_read_generic( flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void flash2_highspeedRread( flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void flash2_quadWrite( flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void flash2_write_generic( flash2_t *ctx, uint32_t address, uint8_t *buffer,
                        uint32_t data_count );
 
void flash2_quad_enable( flash2_t *ctx );
 
void flash2_quad_out_read( flash2_t *ctx, uint32_t address, uint8_t *buffer,
                            uint32_t data_count);
 
void flash2_quad_io_read( flash2_t *ctx, uint32_t address, uint8_t mode, uint8_t *buffer, uint32_t data_count);
 
void flash2_quad_reset( flash2_t *ctx );
 
void flash2_set_burst( flash2_t *ctx, uint8_t length );
 
void flash2_read_sqi_burst_wrap( flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
 
void flash2_read_spi_burst_wrap( flash2_t *ctx, uint32_t address, uint8_t *buffer,
                              uint32_t data_count );
 
void flash2_read_dual_output( flash2_t *ctx, uint32_t address, uint8_t *buffer,
                                uint32_t data_count );
 
void flash2_read_dual_io ( flash2_t *ctx, uint32_t address, uint8_t *buffer,
                          uint32_t data_count );
 
void flash2_sector_erase( flash2_t *ctx, uint32_t address );
 
void flash2_block_erase( flash2_t *ctx, uint32_t address );
 
void flash2_chip_erase( flash2_t *ctx );
 
void flash2_get_sfdp_params( flash2_t *ctx, uint32_t address, uint8_t *buffer,
                         uint32_t data_count );
 
uint8_t flash2_quad_device_manufac( flash2_t *ctx );
 
uint8_t flash2_quad_device_type( flash2_t *ctx );
 
uint8_t flash2_quad_device_id( flash2_t *ctx  );
 
uint8_t flash2_device_manufac( flash2_t *ctx );
 
uint8_t flash2_device_type( flash2_t *ctx );
 
uint8_t flash2_device_id( flash2_t *ctx );
 
void flash2_reset( flash2_t *ctx );
 
void flash2_write_status_reg( flash2_t *ctx, uint8_t s_reg );
 
uint8_t flash2_get_config_reg( flash2_t *ctx );
 
void flash2_write_enable( flash2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _FLASH2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END