flash6.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 FLASH6_H
#define FLASH6_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define FLASH6_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 ); \
 
#define FLASH6_RETVAL  uint8_t
 
#define FLASH6_OK           0x00
#define FLASH6_INIT_ERROR   0xFF
#define FLASH6_CMD_WRITE_ENABLE                     0x06
#define FLASH6_CMD_VOL_SR_WRITE_ENABLE              0x50
#define FLASH6_CMD_WRITE_DISABLE                    0x04
#define FLASH6_CMD_RELEASE_POWER_DOWN_ID            0xAB
#define FLASH6_CMD_MANUFACTURER_DEVICE_ID           0x90
#define FLASH6_CMD_JEDEC_ID                         0x9F
#define FLASH6_CMD_UINQUE_ID                        0x4B
#define FLASH6_CMD_READ_DATA                        0x03
#define FLASH6_CMD_FAST_READ_DATA                   0x0B
#define FLASH6_CMD_PAGE_PROGRAM                     0x02
#define FLASH6_CMD_SECTOR_ERASE_4KB                 0x20
#define FLASH6_CMD_BLOCK_ERASE_32KB                 0x52
#define FLASH6_CMD_BLOCK_ERASE_64KB                 0xD8
#define FLASH6_CMD_CHIP_ERASE                       0xC7 //0x60
#define FLASH6_CMD_READ_STATUS_1                    0x05 
#define FLASH6_CMD_WRITE_STATUS_1                   0x01 
#define FLASH6_CMD_READ_STATUS_2                    0x35 
#define FLASH6_CMD_WRITE_STATUS_2                   0x31 
#define FLASH6_CMD_READ_STATUS_3                    0x15 
#define FLASH6_CMD_WRITE_STATUS_3                   0x11
#define FLASH6_CMD_READ_SFDP_REG                    0x5A
#define FLASH6_CMD_ERASE_SECURITY_REG               0x44
#define FLASH6_CMD_PROGRAM_SECURITY_REG             0x42
#define FLASH6_CMD_READ_SECURITY_REG                0x48
#define FLASH6_CMD_GLOBAL_BLOCK_LOCK                0x7E
#define FLASH6_CMD_GLOBAL_BLOCK_UNLOCK              0x98
#define FLASH6_CMD_READ_BLOCK_LOCK                  0x3D
#define FLASH6_CMD_INDIVIDUAL_BLOCK_LOCK            0x36
#define FLASH6_CMD_INDIVIDUAL_BLOCK_UNLOCK          0x39
#define FLASH6_CMD_ERASE_PROGRAM_SUSPEND            0x75
#define FLASH6_CMD_ERASE_PROGRAM_RESUME             0x7A
#define FLASH6_CMD_POWER_DOWN                       0xB9
#define FLASH6_CMD_ENABLE_RESET                     0x66
#define FLASH6_CMD_RESET_DEVICE                     0x99
#define FLASH6_DEVICE_ID                            0x17
#define FLASH6_MANIFACTURE_ID                       0xEF
#define FLASH6_DEVICE_OK                            0xFF
#define FLASH6_DEVICE_ERROR                         0xAA
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_out_t cs;
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} flash6_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} flash6_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void flash6_cfg_setup ( flash6_cfg_t *cfg );
 
FLASH6_RETVAL flash6_init ( flash6_t *ctx, flash6_cfg_t *cfg );
 
void flash6_generic_transfer
( 
    flash6_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len, 
    uint8_t *rd_buf, 
    uint16_t rd_len 
);
 
void flash6_read_data ( flash6_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint16_t len );
 
void flash6_write_data ( flash6_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint8_t len );
 
void flash6_send_cmd ( flash6_t *ctx, uint8_t cmd_data );
 
uint8_t flash6_get_manufacture_device_id ( flash6_t *ctx, uint8_t *manufacture_id, uint8_t *device_id );
 
void flash6_erase_memory_segment( flash6_t *ctx, uint8_t segment, uint32_t start_addr );
 
uint8_t flash6_read_status_reg ( flash6_t *ctx, uint8_t status_cmd );
 
void flash6_write_status_reg ( flash6_t *ctx, uint8_t status_cmd, uint8_t status_data );
 
void flash6_write_memory_data ( flash6_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size );
 
void flash6_read_memory_data ( flash6_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size );
 
void flash6_software_reset ( flash6_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _FLASH6_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END