flash8.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 FLASH8_H
#define FLASH8_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"
 
 
#define FLASH8_CMD_READ_CELL_ARRAY                   0x13
#define FLASH8_CMD_READ_BUFFER                       0x03
#define FLASH8_CMD_READ_BUFFER_1                     0x0B
#define FLASH8_CMD_PROGRAM_LOAD                      0x02
#define FLASH8_CMD_PROGRAM_EXECUTE                   0x10
#define FLASH8_CMD_PROTECT_EXECUTE                   0x2A
#define FLASH8_CMD_PROGRAM_LOAD_RANDOM_DATA          0x84
#define FLASH8_CMD_BLOCK_ERASE                       0xD8
#define FLASH8_CMD_RESET                             0xFF
#define FLASH8_CMD_RESET_1                           0xFE
#define FLASH8_CMD_WRITE_ENABLE                      0x06
#define FLASH8_CMD_WRITE_DISABLE                     0x04
#define FLASH8_CMD_GET_FEATURE                       0x0F
#define FLASH8_CMD_SET_FEATURE                       0x1F
#define FLASH8_CMD_READ_ID                           0x9F
#define FLASH8_FEATURE_A0                            0xA0
#define FLASH8_FEATURE_B0                            0xB0
#define FLASH8_FEATURE_C0                            0xC0
#define FLASH8_FEATURE_10                            0x10
#define FLASH8_FEATURE_20                            0x20
#define FLASH8_FEATURE_30                            0x30
#define FLASH8_FEATURE_40                            0x40
#define FLASH8_FEATURE_50                            0x50
#define FLASH8_FEATURE_60                            0x60
#define FLASH8_FEATURE_70                            0x70
 
 // flash8_cmd
 
#define FLASH8_SET_BRWD_ENABLE                       0x00
#define FLASH8_SET_BRWD_DISABLE                      0x01
#define FLASH8_SET_BL_ALL_UNLOCKED                   0x00
#define FLASH8_SET_BL_UPPER_1_64_LOCKED              0x01
#define FLASH8_SET_BL_UPPER_1_32_LOCKED              0x02
#define FLASH8_SET_BL_UPPER_1_16_LOCKED              0x03
#define FLASH8_SET_BL_UPPER_1_8_LOCKED               0x04
#define FLASH8_SET_BL_UPPER_1_4_LOCKED               0x05
#define FLASH8_SET_BL_UPPER_1_2_LOCKED               0x06
#define FLASH8_SET_BL_ALLLOCKED                      0x07
 
#define FLASH8_SET_IDR_E_NORMAL_OPERATION            0x00
#define FLASH8_SET_IDR_E_PARAMETER_PAGE_READ         0x01
#define FLASH8_SET_ECC_E_INTERNAL_ECC_DISABLE        0x00
#define FLASH8_SET_ECC_E_INTERNAL_ECC_ENABLE         0x01
#define FLASH8_SET_PRT_E_NORMAL_OPERATION            0x00
#define FLASH8_SET_PRT_EBLOCK_PROTECTION_ENABLE      0x01
#define FLASH8_SET_HSE_HIGH_SPEED_MODE_DISABLE       0x00
#define FLASH8_SET_HSE_HIGH_SPEED_MODE_ENABLE        0x01
#define FLASH8_SET_HOLD_D_HOLD_IS_ENABLED            0x00
#define FLASH8_SET_HOLD_D_HOLD_IS_DISABLED           0x01
 
#define FLASH8_SET_WEL_WRITE_DISABLE                 0x00
#define FLASH8_SET_WEL_WRITE_ENABLE                  0x01
 
 
 // flash8_set
 
#define FLASH8_GET_ECCS_NO_BIT_FLIPS_WERE_DETECT     0x00
#define FLASH8_GET_ECCS_BIT_FLIPS_DETECT_CORRECT     0x10
#define FLASH8_GET_ECCS_MULTI_BIT_FLIPS_NOT_CORRECT  0x20
#define FLASH8_GET_ECCS_BIT_FLIPS_DETECT_CORRECTED   0x30
#define FLASH8_GET_PRG_F_PROGRAM_PASS                0x00
#define FLASH8_GET_PRG_F_PROGRAM_FAIL                0x08
#define FLASH8_GET_PRG_F_PROGRAM_PASS                0x00
#define FLASH8_GET_ERS_F_ERASE_FAIL                  0x04
#define FLASH8_GET_WEL_WRITE_DISABLE                 0x00
#define FLASH8_GET_WEL_WRITE_ENABLE                  0x02
#define FLASH8_GET_OIP_READY_STATE                   0x00
#define FLASH8_GET_OIP_BUSY_STATE                    0x01
 
 
 // flash8_get
 
#define FLASH8_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_RST );    \
    cfg.hld = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define FLASH8_MAP_MIKROBUS( cfg, mikrobus )        \ …
 
 // flash8_map
 // flash8
 
typedef struct
{
    // Output pins
    digital_out_t  wp;          
    digital_out_t  hld;         
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} flash8_t;
typedef struct {…};
 
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;      
} flash8_cfg_t;
typedef struct {…};
 
typedef struct
{
    uint8_t brwd;
    uint8_t bl;
    uint8_t idr_e;
    uint8_t ecc_e;
    uint8_t prt_e;
    uint8_t hse;
    uint8_t hold_d;
    uint8_t eccs;
    uint8_t prg_f;
    uint8_t ers_f;
    uint8_t wel;
    uint8_t oip;
 
} feature_cfg_t;
typedef struct {…};
 
typedef enum
{
    FLASH8_OK = 0,
    FLASH8_ERROR = -1
 
} flash8_return_value_t;
typedef enum {…};
 
void flash8_cfg_setup ( flash8_cfg_t *cfg );
 
err_t flash8_init ( flash8_t *ctx, flash8_cfg_t *cfg );
 
void flash8_default_cfg ( flash8_t *ctx );
 
err_t flash8_generic_write ( flash8_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t flash8_generic_read ( flash8_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void flash8_hold_enable ( flash8_t *ctx );
 
void flash8_hold_disable ( flash8_t *ctx );
 
void flash8_write_protect_enable ( flash8_t *ctx );
 
void flash8_write_protect_disable ( flash8_t *ctx );
 
err_t flash8_read_cell_array ( flash8_t *ctx, uint32_t row_address, uint16_t column_address, uint8_t *feature_status_out );
 
err_t flash8_read_buffer ( flash8_t *ctx, uint16_t column_address, uint8_t *read_data );
 
err_t flash8_program_load ( flash8_t *ctx, uint16_t column_address, uint8_t *data_in, uint16_t len );
 
err_t flash8_program_execute ( flash8_t *ctx, uint32_t row_address );
 
err_t flash8_program_load_random ( flash8_t *ctx, uint16_t column_address, uint8_t *data_in, uint8_t len );
 
err_t flash8_block_erase ( flash8_t *ctx, uint32_t row_address, uint8_t *feat_data );
 
err_t flash8_sw_reset ( flash8_t *ctx, uint8_t *feat_data );
 
err_t flash8_write_enable ( flash8_t *ctx );
 
err_t flash8_write_disable ( flash8_t *ctx );
 
err_t flash8_set_feature ( flash8_t *ctx, uint8_t feature_addr, uint8_t feature_data );
 
err_t flash8_set_config_feature ( flash8_t *ctx, feature_cfg_t feature_data );
 
err_t flash8_get_feature ( flash8_t *ctx, uint8_t feature_addr, uint8_t *feature_data );
 
err_t flash8_get_config_feature ( flash8_t *ctx, feature_cfg_t *feature_data );
 
err_t flash8_protected_area_all_unlocked ( flash8_t *ctx );
 
err_t flash8_protect_execute ( flash8_t *ctx, uint32_t row_address, uint8_t *feature_status_out );
 
err_t flash8_read_id ( flash8_t *ctx, uint8_t *manufacture_id, uint8_t *device_id, uint8_t *organization_id );
 
err_t flash8_write_memory ( flash8_t *ctx, uint32_t row_address, uint16_t column_address, 
                            uint8_t *data_in, uint16_t len, uint8_t *feature_status_out );
 
err_t flash8_read_memory ( flash8_t *ctx, uint32_t row_address, uint16_t column_address, 
                           uint8_t *data_out, uint16_t len, uint8_t *feature_status_out );
 
#ifdef __cplusplus
}
#endif
#endif // FLASH8_H
 
 // flash8
 
// ------------------------------------------------------------------------ END