flash10.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 FLASH10_H
#define FLASH10_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 FLASH10_CMD_READ_ARRAY              0x03
#define FLASH10_CMD_FAST_READ_ARRAY         0x0B
 
#define FLASH10_CMD_BLOCK_ERASE_4KB         0x20
#define FLASH10_CMD_BLOCK_ERASE_32KB        0x52
#define FLASH10_CMD_BLOCK_ERASE_64KB        0xD8
#define FLASH10_CMD_CHIP_ERASE              0x60
#define FLASH10_CMD_BYTE_PAGE_PROGRAM       0x02
#define FLASH10_CMD_SEQUENTIAL_PROGRAM      0xAD
#define FLASH10_CMD_ERASE_PROGRAM_SUSPEND   0x75
#define FLASH10_CMD_ERASE_PROGRAM_RESUME    0x7A
 
#define FLASH10_CMD_WRITE_ENABLE            0x06
#define FLASH10_CMD_WRITE_DISABLE           0x04
#define FLASH10_CMD_VOLATILE_STATUS         0x50
#define FLASH10_CMD_INDIVIDUAL_BLOCK_LOCK   0x36
#define FLASH10_CMD_INDIVIDUAL_BLOCK_UNLOCK 0x39
#define FLASH10_CMD_READ_BLOCK_LOCK         0x3C
#define FLASH10_CMD_GLOBAL_BLOCK_LOCK       0x7E
#define FLASH10_CMD_GLOBAL_BLOCK_UNLOCK     0x98
 
#define FLASH10_CMD_PROGRAM_OTP_SECURITY    0x9B
#define FLASH10_CMD_READ_OTP_SECURITY       0x4B
 
#define FLASH10_CMD_READ_STATUS_1           0x05
#define FLASH10_CMD_READ_STATUS_2           0x35
#define FLASH10_CMD_READ_STATUS_3           0x15
#define FLASH10_CMD_READ_STATUS_4           0x65
#define FLASH10_CMD_READ_STATUS_5           0x65
#define FLASH10_CMD_WRITE_STATUS_1          0x01
#define FLASH10_CMD_WRITE_STATUS_2          0x31
#define FLASH10_CMD_WRITE_STATUS_3          0x11
#define FLASH10_CMD_WRITE_STATUS_4          0x71
#define FLASH10_CMD_WRITE_STATUS_5          0x71
#define FLASH10_CMD_READ_STATUS             0x65
#define FLASH10_CMD_WRITE_STATUS            0x71
#define FLASH10_CMD_STATUS_LOCK             0x6F
 
#define FLASH10_CMD_DEEP_POWER_DOWN         0xB9
#define FLASH10_CMD_ULTRA_DEEP_POWER_DOWN   0x79
#define FLASH10_CMD_RESUME_FROM_DPD         0xAB
 
#define FLASH10_CMD_ENABLE_RESET            0x66
#define FLASH10_CMD_RESET_DEVICE            0x99
#define FLASH10_CMD_TERMINATE               0xF0
 
#define FLASH10_CMD_MANUFACTURER_ID         0x90
#define FLASH10_CMD_JEDEC_ID                0x9F
 
#define FLASH10_CMD_READ_SFDP               0x5A
 
 // flash10_reg
 
#define FLASH10_STATUS_REG_1                1
#define FLASH10_STATUS_REG_2                2
#define FLASH10_STATUS_REG_3                3
#define FLASH10_STATUS_REG_4                4
#define FLASH10_STATUS_REG_5                5
 
#define FLASH10_STATUS1_SRP0                0x80
#define FLASH10_STATUS1_BPSIZE              0x40
#define FLASH10_STATUS1_TB                  0x20
#define FLASH10_STATUS1_WEL                 0x02
#define FLASH10_STATUS1_BSY                 0x01
 
#define FLASH10_MIN_ADDRESS                 0x000000
#define FLASH10_MAX_ADDRESS                 0x3FFFFFul
#define FLASH10_PAGE_SIZE                   256
 
#define FLASH10_MANUFACTURER_ID             0x1F
#define FLASH10_DEVICE_ID                   0x47
 
#define FLASH10_SET_DATA_SAMPLE_EDGE        SET_SPI_DATA_SAMPLE_EDGE
#define FLASH10_SET_DATA_SAMPLE_MIDDLE      SET_SPI_DATA_SAMPLE_MIDDLE
 
 // flash10_set
 
#define FLASH10_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.wp = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // flash10_map
 // flash10
 
typedef struct
{
    // Output pins
    digital_out_t rst;              
    digital_out_t wp;               
    // Modules
    spi_master_t  spi;              
    pin_name_t    chip_select;      
} flash10_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 wp;                  
    // static variable
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
} flash10_cfg_t;
 
typedef enum
{
    FLASH10_OK = 0,
    FLASH10_ERROR = -1
 
} flash10_return_value_t;
 
void flash10_cfg_setup ( flash10_cfg_t *cfg );
 
err_t flash10_init ( flash10_t *ctx, flash10_cfg_t *cfg );
 
err_t flash10_write_cmd ( flash10_t *ctx, uint8_t cmd );
 
err_t flash10_write_cmd_data ( flash10_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
 
err_t flash10_read_cmd_data ( flash10_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len );
 
err_t flash10_write_cmd_address_data ( flash10_t *ctx, uint8_t cmd, uint32_t address, uint8_t *data_in, uint32_t len );
 
err_t flash10_read_cmd_address_data ( flash10_t *ctx, uint8_t cmd, uint32_t address, uint8_t *data_out, uint32_t len );
 
err_t flash10_memory_write ( flash10_t *ctx, uint32_t address, uint8_t *data_in, uint32_t len );
 
err_t flash10_memory_read ( flash10_t *ctx, uint32_t address, uint8_t *data_out, uint32_t len );
 
err_t flash10_erase_memory ( flash10_t *ctx, uint8_t erase_cmd, uint32_t address );
 
err_t flash10_check_communication ( flash10_t *ctx );
 
err_t flash10_write_protect ( flash10_t *ctx );
 
err_t flash10_write_enable ( flash10_t *ctx );
 
err_t flash10_soft_reset ( flash10_t *ctx );
 
err_t flash10_write_status ( flash10_t *ctx, uint8_t status_reg_num, uint8_t status );
 
err_t flash10_read_status ( flash10_t *ctx, uint8_t status_reg_num, uint8_t *status );
 
void flash10_set_wp_pin ( flash10_t *ctx, uint8_t state );
 
void flash10_set_rst_pin ( flash10_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // FLASH10_H
 
 // flash10
 
// ------------------------------------------------------------------------ END