flash9.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 FLASH9_H
#define FLASH9_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 FLASH9_CMD_READ_STATUS_REGISTER_1                   0x05
#define FLASH9_CMD_READ_STATUS_REGISTER_2                   0x35
#define FLASH9_CMD_READ_STATUS_REGISTER_3                   0x15
#define FLASH9_CMD_READ_SFDP_REGISTER                       0x5A
#define FLASH9_CMD_ERASE_PROGRAM_SUSPEND                    0x75
#define FLASH9_CMD_ERASE_PROGRAM_RESUME                     0x7A
 
#define FLASH9_CMD_WRITE_ENABLE                             0x06
#define FLASH9_CMD_VOLATILE_SR_WRITE_ENABLE                 0x50
#define FLASH9_CMD_WRITE_DISABLE                            0x04
#define FLASH9_CMD_READ_UNIQUE_ID                           0x4B
#define FLASH9_CMD_RELEASE_POWER_DOWN_ID                    0xAB
#define FLASH9_CMD_MANUFACTURER_DEVICE_ID                   0x90
#define FLASH9_CMD_JEDEC_ID                                 0x9F
#define FLASH9_CMD_CHIP_ERASE                               0xC7
#define FLASH9_CMD_WRITE_STATUS_REGISTER_1                  0x01
#define FLASH9_CMD_WRITE_STATUS_REGISTER_2                  0x31
#define FLASH9_CMD_WRITE_STATUS_REGISTER_3                  0x11
#define FLASH9_CMD_GLOBAL_BLOCK_LOCK                        0x7E
#define FLASH9_CMD_GLOBAL_BLOCK_UNLOCK                      0x98
#define FLASH9_CMD_POWER_DOWN                               0xB9
#define FLASH9_CMD_ENTER_4BYTE_ADDRESS_MODE                 0xB7
#define FLASH9_CMD_EXIT_4BYTE_ADDRESS_MODE                  0xE9
#define FLASH9_CMD_ENABLE_RESET                             0x66
#define FLASH9_CMD_RESET_DEVICE                             0x99
#define FLASH9_CMD_SOFTWARE_DIE_SELECT                      0xC2
 
#define FLASH9_CMD_READ_DATA                                0x03
#define FLASH9_CMD_READ_DATA_WITH_4BYTE_ADDRESS             0x13
#define FLASH9_CMD_FAST_READ                                0x0B
#define FLASH9_CMD_FAST_READ_WITH_4BYTE_ADDRESS             0x0C
#define FLASH9_CMD_PAGE_PROGRAM                             0x02
#define FLASH9_CMD_PAGE_PROGRAM_WITH_4BYTE_ADDRESS          0x12
#define FLASH9_CMD_SECTOR_ERASE                             0x20
#define FLASH9_CMD_SECTOR_ERASE_WITH_4BYTE_ADDRESS          0x21
#define FLASH9_CMD_BLOCK_ERASE_32KB                         0x52
#define FLASH9_CMD_BLOCK_ERASE_64KB                         0xD8
#define FLASH9_CMD_BLOCK_ERASE_64KB_WITH_4BYTE_ADDRESS      0xDC
#define FLASH9_CMD_ERASE_SECURITY_REGISTER                  0x44
#define FLASH9_CMD_PROGRAM_SECURITY_REGISTER                0x42
#define FLASH9_CMD_READ_SECURITY_REGISTER                   0x48
#define FLASH9_CMD_READ_BLOCK_LOCK                          0x3D
#define FLASH9_CMD_INDIVIDUAL_BLOCK_LOCK                    0x36
#define FLASH9_CMD_INDIVIDUAL_BLOCK_UNLOCK                  0x39
 
 // flash9_reg
 
#define FLASH9_JEDEC_MANUFACTURER_ID                        0xEF
#define FLASH9_JEDEC_MEMORY_TYPE                            0x70
#define FLASH9_JEDEC_CAPACITY                               0x22
 
#define FLASH9_MIN_ADDRESS                                  0x00000000
#define FLASH9_MAX_ADDRESS                                  0x0FFFFFFFul
 
#define FLASH9_SET_DATA_SAMPLE_EDGE                         SET_SPI_DATA_SAMPLE_EDGE
#define FLASH9_SET_DATA_SAMPLE_MIDDLE                       SET_SPI_DATA_SAMPLE_MIDDLE
 
 // flash9_set
 
#define FLASH9_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_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.hld = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // flash9_map
 // flash9
 
typedef struct
{
    // Output pins
    digital_out_t  wp;          
    digital_out_t  rst;         
    digital_out_t  hld;         
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} flash9_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  rst;                                    
    pin_name_t  hld;                                    
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} flash9_cfg_t;
 
typedef enum
{
    FLASH9_OK = 0,
    FLASH9_ERROR = -1
 
} flash9_return_value_t;
 
void flash9_cfg_setup ( flash9_cfg_t *cfg );
 
err_t flash9_init ( flash9_t *ctx, flash9_cfg_t *cfg );
 
err_t flash9_default_cfg ( flash9_t *ctx );
 
err_t flash9_generic_write ( flash9_t *ctx, uint8_t *data_in, uint16_t in_len );
 
err_t flash9_generic_read ( flash9_t *ctx, uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint16_t out_len ) ;
 
err_t flash9_write_register ( flash9_t *ctx, uint8_t reg, uint8_t *data_in, uint16_t in_len );
 
err_t flash9_read_register ( flash9_t *ctx, uint8_t reg, uint8_t *data_out, uint16_t out_len );
 
err_t flash9_write_command ( flash9_t *ctx, uint8_t cmd );
 
void flash9_set_wp_pin ( flash9_t *ctx, uint8_t state );
 
void flash9_set_hld_pin ( flash9_t *ctx, uint8_t state );
 
void flash9_set_rst_pin ( flash9_t *ctx, uint8_t state );
 
err_t flash9_check_communication ( flash9_t *ctx );
 
err_t flash9_erase_memory ( flash9_t *ctx, uint8_t erase_cmd, uint32_t address );
 
err_t flash9_read_status ( flash9_t *ctx, uint8_t status_cmd, uint8_t *status );
 
err_t flash9_write_status ( flash9_t *ctx, uint8_t status_cmd, uint8_t status );
 
err_t flash9_memory_write ( flash9_t *ctx, uint32_t address, uint8_t *data_in, uint16_t len );
 
err_t flash9_memory_read ( flash9_t *ctx, uint32_t address, uint8_t *data_out, uint16_t len );
 
err_t flash9_memory_read_fast ( flash9_t *ctx, uint32_t address, uint8_t *data_out, uint16_t len );
 
#ifdef __cplusplus
}
#endif
#endif // FLASH9_H
 
 // flash9
 
// ------------------------------------------------------------------------ END