flash4.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 FLASH4_H
#define FLASH4_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 FLASH4_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.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.io2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
   cfg.io3 = MIKROBUS( mikrobus, MIKROBUS_INT )
#define FLASH4_RETVAL  uint8_t
 
#define FLASH4_OK           0x00
#define FLASH4_INIT_ERROR   0xFF
#define FLASH4_MANUFACTURER_ID  0x01
#define FLASH4_DEVICE_ID        0x19
#define FLASH4_CMD_READ_ID                       0x90
#define FLASH4_CMD_READ_IDENTIFICATION           0x9F
#define FLASH4_CMD_READ_ELECTRONIC_SIGNATURE     0xAB
#define FLASH4_CMD_READ_SERIAL_FLASH_PARAMETERS  0x5A
#define FLASH4_CMD_READ_STATUS_REG_1             0x05
#define FLASH4_CMD_READ_STATUS_REG_2             0x07
#define FLASH4_CMD_READ_CONFIGURATION_REG        0x35
#define FLASH4_CMD_READ_BANK_REG                 0x16
#define FLASH4_CMD_WRITE_BANK_REG                0x17
#define FLASH4_CMD_ACCESS_BANK_REG               0xB9
#define FLASH4_CMD_WRITE_REGISTER_WRR            0x01
#define FLASH4_CMD_WRITE_ENABLE_WREN             0x06
#define FLASH4_CMD_WRITE_DISABLE_WRDI            0x04
#define FLASH4_CMD_CLEAR_STATUS_REG              0x30
#define FLASH4_CMD_READ_ECC_STATUS_REG           0x18
#define FLASH4_CMD_READ_AUTO_BOOT_REG            0x14
#define FLASH4_CMD_WRITE_AUTO_BOOT_REG           0x15
#define FLASH4_CMD_PROGRAM_NVDLR                 0x43
#define FLASH4_CMD_WRITE_VDLR                    0x4A
#define FLASH4_CMD_READ_DATA_LEARNING_PATTERN    0x41
#define FLASH4_CMD_READ_FLASH                    0x03
#define FLASH4_CMD_4READ_FLASH                   0x13
#define FLASH4_CMD_FAST_READ_FLASH               0x0B
#define FLASH4_CMD_FAST_4READ_FLASH              0x0C
#define FLASH4_CMD_FAST_READ_DDR                 0x0D
#define FLASH4_CMD_FAST_4READ_DDR                0x0E
#define FLASH4_CMD_PAGE_PROGRAM                  0x02
#define FLASH4_CMD_PAGE_4PROGRAM                 0x12
#define FLASH4_CMD_PROGRAM_SUSPEND               0x85
#define FLASH4_CMD_PROGRAM_RESUME                0x8A
#define FLASH4_CMD_SECTOR_ERASE                  0xD8
#define FLASH4_CMD_SECTOR_4ERASE                 0xDC
#define FLASH4_CMD_BULK_ERASE                    0xC7
#define FLASH4_CMD_ERASE_SUSPEND                 0x75
#define FLASH4_CMD_ERASE_RESUME                  0x7A
#define FLASH4_CMD_WRITE_OTP_PROGRAM             0x42
#define FLASH4_CMD_READ_OTP                      0x4B
#define FLASH4_CMD_READ_ASP                      0x2B
#define FLASH4_CMD_WRITE_ASP_PROGRAM             0x2F
#define FLASH4_CMD_READ_DYB                      0xE0
#define FLASH4_CMD_WRITE_DYB                     0xE1
#define FLASH4_CMD_READ_PPB                      0xE2
#define FLASH4_CMD_WRITE_PPB                     0xE3
#define FLASH4_CMD_ERASE_PPB                     0xE4
#define FLASH4_CMD_READ_PPB_LOCK_BIT             0xA7
#define FLASH4_CMD_WRITE_PPB_LOCK_BIT            0xA6
#define FLASH4_CMD_SOFTWARE_RESET                0xF0
#define FLASH4_CMD_MODE_BIT_RESET                0xFF
 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t cs;
    digital_out_t rst;
    digital_out_t io3;
    digital_out_t io2;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} flash4_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 rst;
    pin_name_t io2;
    pin_name_t io3;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} flash4_cfg_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void flash4_cfg_setup ( flash4_cfg_t *cfg );
 
FLASH4_RETVAL flash4_init ( flash4_t *ctx, flash4_cfg_t *cfg );
 
void flash4_generic_transfer ( flash4_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
 
void flash4_read_manufacturer_id ( flash4_t *ctx, uint8_t *device_id );
 
void flash4_read_identification ( flash4_t *ctx, uint8_t *out_data, uint8_t n_data );
 
 
uint8_t flash4_read_electronic_id ( flash4_t *ctx );
 
void flash4_read_serial_flash_parameters ( flash4_t *ctx, uint8_t *out_params, uint8_t c );
 
uint8_t flash4_read_byte ( flash4_t *ctx, uint8_t reg );
 
void flash4_write_byte ( flash4_t *ctx, uint8_t reg, uint8_t data_buff );
 
void flash4_write_command ( flash4_t *ctx, uint8_t cmd );
 
void flash4_write_reg ( flash4_t *ctx, uint8_t status, uint8_t config );
 
void flash4_read_ecc ( flash4_t *ctx, uint8_t *out_ecc, uint8_t n_dummy);
 
void flash4_read_auto_boot ( flash4_t *ctx, uint8_t *out_ab );
 
void flash4_read_flash( flash4_t *ctx, uint8_t *out_data, uint32_t addr, uint8_t n_data);
 
void flash4_read_flash_4 ( flash4_t *ctx, uint8_t *out_data, uint32_t addr, uint8_t n_data );
 
void flash4_fast_read_flash ( flash4_t *ctx, uint8_t *out_data, uint32_t addr, uint8_t n_data_dummy);
 
void flash4_fast_read_flash_4 ( flash4_t *ctx, uint8_t *out_data,uint8_t addr, uint8_t n_data );
 
void flash4_page_program_4 ( flash4_t *ctx, uint8_t *in_data, uint32_t addr, uint8_t n_data );
 
void flash4_sector_erase ( flash4_t *ctx, uint32_t addr );
 
void flash4_sector_erase_4( flash4_t *ctx, uint32_t addr );
 
uint8_t flash4_check_wip ( flash4_t *ctx );
 
uint8_t flash4_check_wel ( flash4_t *ctx );
 
uint8_t flash4_check_ps ( flash4_t *ctx );
 
uint8_t flash4_check_es ( flash4_t *ctx );
 
void flash4_reset ( flash4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _FLASH4_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END