flash.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 _FLASH_H_
#define _FLASH_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_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS
#define FLASH_MEM_ADDR_FIRST_PAGE_START    0x0
#define FLASH_MEM_ADDR_FIRST_PAGE_END      0xFF
#define FLASH_MEM_ADDR_SECOND_PAGE_START   0x100
#define FLASH_MEM_ADDR_SECOND_PAGE_END     0x1FF
#define FLASH_MEM_ADDR_LAST_PAGE_START     0xFFF00
#define FLASH_MEM_ADDR_LAST_PAGE_END       0xFFFFF
#define FLASH_MEM_ADDR_FIRST_SECTOR_START  0x0
#define FLASH_MEM_ADDR_FIRST_SECTOR_END    0xFFF
#define FLASH_MEM_ADDR_LAST_SECTOR_START   0xFF000
#define FLASH_MEM_ADDR_LAST_SECTOR_END     0xFFFFF
#define FLASH_MEM_ADDR_FIRST_BLOCK_START   0x0
#define FLASH_MEM_ADDR_FIRST_BLOCK_END     0xFFFF
#define FLASH_MEM_ADDR_LAST_BLOCK_START    0xF0000
#define FLASH_MEM_ADDR_LAST_BLOCK_END      0xFFFFF
#define FLASH_NDATA_TRANSFER_MIN  1
#define FLASH_NDATA_TRANSFER_MAX  256
#define FLASH_STATUS_MASK_WRITE_BUSY      0x1
#define FLASH_STATUS_MASK_WRITE_EN        0x2
#define FLASH_STATUS_MASK_BLOCK_PROTECT   0x3C
#define FLASH_STATUS_MASK_WP_DIS          0x40
#define FLASH_STATUS_MASK_OTP_LOCK        0x80
#define FLASH_STATUS_SET_BLOCK_PROT_BIT0  0x4
#define FLASH_STATUS_SET_BLOCK_PROT_BIT1  0x8
#define FLASH_STATUS_SET_BLOCK_PROT_BIT2  0x10
#define FLASH_STATUS_SET_BLOCK_PROT_BIT3  0x20
#define FLASH_STATUS_SET_WP_DIS           0x40
#define FLASH_STATUS_SET_OTP_LOCK         0x80
 //  End status group
 
#define FLASH_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.sdo = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.sdi = 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  )
 //  End macros group
// --------------------------------------------------------------- PUBLIC TYPES
typedef enum
{
    FLASH_OK = 0x0,
    FLASH_ERR_INIT_DRV = 0xFD,
    FLASH_ERR_MEM_ADDR,
    FLASH_ERR_NDATA
 
} flash_err_t;
 
typedef enum
{
    FLASH_PIN_STATE_LOW = 0,
    FLASH_PIN_STATE_HIGH
 
} flash_pin_state_t;
 
typedef struct
{
    // Output pins
    digital_out_t cs;
 
    //  Control pins.
    digital_out_t  hld;
    digital_out_t  wp;
 
    //  Module.
    spi_master_t spi;
    pin_name_t chip_select;
 
} flash_t;
 
typedef struct
{
    //  Communication gpio pins.
    pin_name_t  sdo;
    pin_name_t  sdi;
    pin_name_t  sck;
    pin_name_t  cs;
 
    //  Additional gpio pins.
    pin_name_t  hld;
    pin_name_t  wp;
 
    //  SPI configuration.
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} flash_cfg_t;
 
 //  End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void flash_cfg_setup( flash_cfg_t *cfg );
 
flash_err_t flash_init( flash_t *ctx, flash_cfg_t *cfg );
 
void flash_default_cfg( flash_t *ctx );
 
void flash_reset( flash_t *ctx );
 
void flash_write_enable( flash_t *ctx );
 
void flash_write_disable( flash_t *ctx );
 
void flash_write_status( flash_t *ctx, uint8_t data_tx );
 
uint8_t flash_read_status( flash_t *ctx );
 
void flash_read_id( flash_t *ctx, uint8_t *manufact_id, uint16_t *dev_id );
 
flash_err_t flash_write_byte( flash_t *ctx, uint32_t mem_addr, uint8_t data_tx );
 
flash_err_t flash_read_byte( flash_t *ctx, uint32_t mem_addr, uint8_t *data_rx );
 
flash_err_t flash_write_page( flash_t *ctx, uint32_t mem_addr, uint8_t *data_tx,
                  uint16_t n_data );
 
flash_err_t flash_read_page( flash_t *ctx, uint32_t mem_addr, uint8_t *data_rx,
                 uint16_t n_data );
 
void flash_erase_chip( flash_t *ctx );
 
flash_err_t flash_erase_block( flash_t *ctx, uint32_t mem_addr );
 
flash_err_t flash_erase_half_block( flash_t *ctx, uint32_t mem_addr );
 
flash_err_t flash_erase_sector( flash_t *ctx, uint32_t mem_addr );
 
void flash_set_write_protect_pin( flash_t *ctx, flash_pin_state_t state );
 
void flash_set_hold_pin( flash_t *ctx, flash_pin_state_t state );
 
#ifdef __cplusplus
}
#endif
#endif  //  _FLASH_H_
 
 //  End public_function group
 
// ------------------------------------------------------------------------ END