flash7.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 FLASH7_H
#define FLASH7_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 FLASH7_STAT_REG_LSB_SRP0                                  0x80
#define FLASH7_STAT_REG_LSB_BP4                                   0x40
#define FLASH7_STAT_REG_LSB_BP3                                   0x20
#define FLASH7_STAT_REG_LSB_BP2                                   0x10
#define FLASH7_STAT_REG_LSB_BP1                                   0x08
#define FLASH7_STAT_REG_LSB_BP0                                   0x04
#define FLASH7_STAT_REG_LSB_WEL                                   0x02
#define FLASH7_STAT_REG_LSB_WIP                                   0x01
 
#define FLASH7_STAT_REG_MSB_SUS1                                  0x80
#define FLASH7_STAT_REG_MSB_CMP                                   0x40
#define FLASH7_STAT_REG_MSB_LB3                                   0x20
#define FLASH7_STAT_REG_MSB_LB2                                   0x10
#define FLASH7_STAT_REG_MSB_LB1                                   0x08
#define FLASH7_STAT_REG_MSB_SUS2                                  0x04
#define FLASH7_STAT_REG_MSB_QE                                    0x02
#define FLASH7_STAT_REG_MSB_SRP1                                  0x01
 
#define FLASH7_MEMORY_ADDR_START                            0x00000000
#define FLASH7_MEMORY_ADDR_END                              0x00FFFFFF
#define FLASH7_MEM_SECTOR_LEN                               0x00001000
#define FLASH7_MEMORY_BLOCK_SIZE                            0x00008000
 
 // flash7_reg
 
#define FLASH7_CMD_WRSR                                           0x01
#define FLASH7_CMD_WRITE                                          0x02
#define FLASH7_CMD_READ                                           0x03
#define FLASH7_CMD_WRDI                                           0x04
#define FLASH7_CMD_RDSR_LSB                                       0x05
#define FLASH7_CMD_RDSR_MSB                                       0x35
#define FLASH7_CMD_WREN                                           0x06
#define FLASH7_CMD_FREAD                                          0x0B
#define FLASH7_CMD_WEVSR                                          0x50
#define FLASH7_CMD_SE                                             0x20
#define FLASH7_CMD_BE_32KB                                        0x52
#define FLASH7_CMD_BE_64KB                                        0xD8
#define FLASH7_CMD_CE                                             0x60
#define FLASH7_CMD_SLEEP                                          0xB9
#define FLASH7_CMD_WAKE                                           0xAB
#define FLASH7_CMD_REMS                                           0x90
#define FLASH7_CMD_RDID                                           0x9F
#define FLASH7_CMD_ID                                             0x4B
#define FLASH7_CMD_ENRES                                          0x66
#define FLASH7_CMD_RES                                            0x99
 
#define FLASH7_WRITE_PROTECT_DISABLE                              0x00
#define FLASH7_WRITE_PROTECT_ENABLE                               0x01
 
#define FLASH7_HOLD_DISABLE                                       0x00
#define FLASH7_HOLD_ENABLE                                        0x01
 
#define FLASH7_DUMMY                                              0x00
 
 // flash7_set
 
#define FLASH7_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.io2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.io3 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // flash7_map
 // flash7
 
typedef struct
{
    // Output pins
    digital_out_t  io2;     
    digital_out_t  io3;     
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
} flash7_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  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;      
} flash7_cfg_t;
 
typedef enum
{
   FLASH7_OK = 0,
   FLASH7_ERROR = -1
 
} flash7_return_value_t;
 
void flash7_cfg_setup ( flash7_cfg_t *cfg );
 
err_t flash7_init ( flash7_t *ctx, flash7_cfg_t *cfg );
 
err_t flash7_default_cfg ( flash7_t *ctx );
 
err_t flash7_generic_write ( flash7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t flash7_generic_read ( flash7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void flash7_write_protect ( flash7_t *ctx, uint8_t en_write_protect );
 
void flash7_hold ( flash7_t *ctx, uint8_t en_hold );
 
void flash7_send_command ( flash7_t *ctx, uint8_t cmd );
 
void flash7_write_enable ( flash7_t *ctx );
 
void flash7_write_disable ( flash7_t *ctx );
 
void flash7_chip_erase ( flash7_t *ctx );
 
uint8_t flash7_read_status_register ( flash7_t *ctx, uint8_t status_byte );
 
void flash7_write_status_register ( flash7_t *ctx, uint16_t status_data );
 
uint8_t flash7_page_program ( flash7_t *ctx, uint32_t mem_addr, uint8_t *p_tx_data, uint16_t n_bytes );
 
void flash7_read_memory ( flash7_t *ctx, uint32_t mem_addr, uint8_t *p_rx_data, uint16_t n_bytes );
 
void flash7_fast_read_memory ( flash7_t *ctx, uint32_t mem_addr, uint8_t *p_rx_data, uint16_t n_bytes );
 
uint8_t flash7_sector_erase ( flash7_t *ctx, uint16_t mem_sector );
 
uint8_t flash7_block_erase ( flash7_t *ctx, uint8_t mem_block, uint8_t mem_block_len );
 
void flash7_go_to_sleep ( flash7_t *ctx );
 
uint8_t flash7_wake_up ( flash7_t *ctx );
 
void flash7_read_id ( flash7_t *ctx, uint8_t *manufacturer_id, uint8_t *device_id );
 
void flash7_get_identification ( flash7_t *ctx, uint8_t *manufacturer_id, uint8_t *memory_type_id, uint8_t *capacity_id );
 
void flash7_sw_reset ( flash7_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // FLASH7_H
 
 // flash7
 
// ------------------------------------------------------------------------ END