flash11.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 FLASH11_H
#define FLASH11_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 FLASH11_CMD_ENABLE_RESET            0x66
#define FLASH11_CMD_RESET_DEVICE            0x99
#define FLASH11_CMD_DEEP_POWER_DOWN         0xB9
#define FLASH11_CMD_RESUME_FROM_DPD         0xAB
 
#define FLASH11_CMD_READ_ARRAY              0x03
#define FLASH11_CMD_FAST_READ_ARRAY         0x0B
 
#define FLASH11_CMD_WRITE_ENABLE            0x06
#define FLASH11_CMD_VOLATILE_SR_WR_EN       0x50
#define FLASH11_CMD_WRITE_DISABLE           0x04
 
#define FLASH11_CMD_BYTE_PAGE_PROGRAM       0x02
 
#define FLASH11_CMD_BLOCK_ERASE_4KB         0x20
#define FLASH11_CMD_BLOCK_ERASE_32KB        0x52
#define FLASH11_CMD_BLOCK_ERASE_64KB        0xD8
#define FLASH11_CMD_CHIP_ERASE              0x60
 
#define FLASH11_CMD_ERASE_PROGRAM_SUSPEND   0x75
#define FLASH11_CMD_ERASE_PROGRAM_RESUME    0x7A
 
#define FLASH11_CMD_READ_STATUS_1           0x05
#define FLASH11_CMD_READ_STATUS_2           0x35
#define FLASH11_CMD_READ_STATUS_3           0x15
#define FLASH11_CMD_WRITE_STATUS_1          0x01
#define FLASH11_CMD_WRITE_STATUS_2          0x31
#define FLASH11_CMD_WRITE_STATUS_3          0x11
 
#define FLASH11_CMD_MANUFACTURER_ID         0x90
#define FLASH11_CMD_READ_JEDEC_ID           0x9F
#define FLASH11_CMD_READ_SERIAL_FLASH_DP    0x5A
 
#define FLASH11_CMD_ERASE_SECURITY_REG      0x44
#define FLASH11_CMD_PROGRAM_SECURITY_REG    0x42
#define FLASH11_CMD_READ_SECURITY_REG       0x48
#define FLASH11_CMD_READ_UNIQUE_ID_NUM      0x4B
 
 // flash11_opcode
 
#define FLASH11_STATUS1_SRP0_BIT_MASK       0x80
#define FLASH11_STATUS1_BP4_BIT_MASK        0x40
#define FLASH11_STATUS1_BP3_BIT_MASK        0x20
#define FLASH11_STATUS1_BP2_BIT_MASK        0x10
#define FLASH11_STATUS1_BP1_BIT_MASK        0x08
#define FLASH11_STATUS1_BP0_BIT_MASK        0x04
#define FLASH11_STATUS1_WEL_EN              0x02
#define FLASH11_STATUS1_WEL_DIS             0x00
#define FLASH11_STATUS1_BSY                 0x01
#define FLASH11_STATUS1_RDY                 0x00
 
#define FLASH11_MANUFACTURER_ID             0x1F
#define FLASH11_DEVICE_ID_0                 0x87
#define FLASH11_DEVICE_ID_1                 0x01
 
#define FLASH11_MIN_ADDRESS                 0x000000
#define FLASH11_MAX_ADDRESS                 0x3FFFFFul
#define FLASH11_PAGE_SIZE                   256
 
#define FLASH11_WRITE_PROTECT_ENABLE         0
#define FLASH11_WRITE_PROTECT_DISABLE        1
 
#define FLASH11_HOLD_ENABLE                  0
#define FLASH11_HOLD_DISABLE                 1
 
#define FLASH11_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define FLASH11_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // flash11_set
 
#define FLASH11_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.wp = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.hld = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // flash11_map
 // flash11
 
typedef struct
{
    // Output pins
    digital_out_t wp;     
    digital_out_t hld;    
    // Modules
    spi_master_t spi;            
    pin_name_t   chip_select;    
} flash11_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 wp;     
    pin_name_t hld;    
    // static variable
    uint32_t                          spi_speed;      
    spi_master_mode_t                 spi_mode;       
    spi_master_chip_select_polarity_t cs_polarity;    
} flash11_cfg_t;
 
typedef enum
{
    FLASH11_OK = 0,
    FLASH11_ERROR = -1
 
} flash11_return_value_t;
 
void flash11_cfg_setup ( flash11_cfg_t *cfg );
 
err_t flash11_init ( flash11_t *ctx, flash11_cfg_t *cfg );
 
err_t flash11_default_cfg ( flash11_t *ctx );
 
err_t flash11_generic_write ( flash11_t *ctx, uint8_t opcode, uint8_t *data_in, uint8_t len );
 
err_t flash11_generic_read ( flash11_t *ctx, uint8_t opcode, uint8_t *data_out, uint8_t len );
 
err_t flash11_set_cmd ( flash11_t *ctx, uint8_t opcode );
 
err_t flash11_write_cmd_addr_data ( flash11_t *ctx, uint8_t opcode, uint32_t mem_addr, uint8_t *data_in, uint32_t len );
 
err_t flash11_read_cmd_addr_data ( flash11_t *ctx, uint8_t opcode, uint32_t mem_addr, uint8_t *data_out, uint32_t len );
 
err_t flash11_sw_reset ( flash11_t *ctx );
 
err_t flash11_memory_write ( flash11_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint32_t len );
 
err_t flash11_memory_read ( flash11_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint32_t len );
 
err_t flash11_write_enable ( flash11_t *ctx );
 
err_t flash11_write_disable ( flash11_t *ctx );
 
err_t flash11_block_erase ( flash11_t *ctx, uint8_t cmd_block_erase, uint32_t mem_addr );
 
err_t flash11_chip_erase ( flash11_t *ctx );
 
err_t flash11_set_status ( flash11_t *ctx, uint8_t status_reg, uint8_t status );
 
err_t flash11_get_status ( flash11_t *ctx, uint8_t status_reg, uint8_t *status );
 
err_t flash11_get_device_id ( flash11_t *ctx, uint8_t *device_id );
 
void flash11_hw_write_protect ( flash11_t *ctx, uint8_t en_wp );
 
void flash11_en_hold ( flash11_t *ctx, uint8_t en_hold );
 
#ifdef __cplusplus
}
#endif
#endif // FLASH11_H
 
 // flash11
 
// ------------------------------------------------------------------------ END