eeprom7.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 EEPROM7_H
#define EEPROM7_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 EEPROM7_OPCODE_STATUS_RDSR                  0x05
#define EEPROM7_OPCODE_STATUS_WRBP                  0x08
#define EEPROM7_OPCODE_STATUS_WREN                  0x06
#define EEPROM7_OPCODE_STATUS_WRDI                  0x04
#define EEPROM7_OPCODE_STATUS_WRSR                  0x01
 
#define EEPROM7_OPCODE_EEPROM_SECURITY_READ         0x03
#define EEPROM7_OPCODE_EEPROM_SECURITY_WRITE        0x02
#define EEPROM7_OPCODE_EEPROM_SECURITY_RDEX         0x83
#define EEPROM7_OPCODE_EEPROM_SECURITY_WREX         0x82
#define EEPROM7_OPCODE_EEPROM_SECURITY_LOCK         0x82
#define EEPROM7_OPCODE_EEPROM_SECURITY_CHLK         0x83
 
#define EEPROM7_OPCODE_MP_REG_RMPR                  0x31
#define EEPROM7_OPCODE_MP_REG_PRWE                  0x07
#define EEPROM7_OPCODE_MP_REG_PRWD                  0x0A
#define EEPROM7_OPCODE_MP_REG_WMPR                  0x32
#define EEPROM7_OPCODE_MP_REG_PPAB                  0x34
#define EEPROM7_OPCODE_MP_REG_FRZR                  0x37
 
#define EEPROM7_OPCODE_MP_REG_SPID                  0x9F
 
#define EEPROM7_OPCODE_SW_RESET_SRST                0x7C
 
#define EEPROM7_SEC_WRITE_DISABLE                   0x00
#define EEPROM7_SEC_WRITE_ENABLE                    0x01
 
#define EEPROM7_PIN_WRITE_PROTECT_DISABLE           0x00
#define EEPROM7_PIN_WRITE_PROTECT_ENABLE            0x01
#define EEPROM7_PIN_HOLD_PROTECT_DISABLE            0x00
#define EEPROM7_PIN_HOLD_PROTECT_ENABLE             0x01
 
#define EEPROM7_STATUS_ERROR                        0x00
#define EEPROM7_STATUS_SUCCESS                      0x01
#define EEPROM7_DUMMY                               0x00
#define EEPROM7_ENABLE_WRITE_DISABLE                0x00
#define EEPROM7_ENABLE_WRITE_ENABLE                 0x01
#define EEPROM7_DEVICE_NOT_READY                    0x00
#define EEPROM7_DEVICE_IS_READY                     0x01
 
 // eeprom7_reg
 
#define EEPROM7_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 )
 
 // eeprom7_map
 // eeprom7
 
typedef struct
{
    // Output pins
    digital_out_t  wp;     
    digital_out_t  hld;     
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
} eeprom7_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;      
} eeprom7_cfg_t;
 
typedef enum
{
   EEPROM7_OK = 0,
   EEPROM7_ERROR = -1
 
} eeprom7_return_value_t;
 
void eeprom7_cfg_setup ( eeprom7_cfg_t *cfg );
 
err_t eeprom7_init ( eeprom7_t *ctx, eeprom7_cfg_t *cfg );
 
err_t eeprom7_default_cfg ( eeprom7_t *ctx );
 
err_t eeprom7_generic_write ( eeprom7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t eeprom7_generic_read ( eeprom7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t eeprom7_generic_write_then_read ( eeprom7_t *ctx, uint8_t *data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out );
 
void eeprom7_enable_write_protect ( eeprom7_t *ctx, uint8_t en_write_protect );
 
void eeprom7_enable_hold_operation ( eeprom7_t *ctx, uint8_t en_hold );
 
void eeprom7_enable_write ( eeprom7_t *ctx, uint8_t en_write );
 
uint16_t eeprom7_read_status ( eeprom7_t *ctx );
 
uint8_t eeprom7_is_device_ready ( eeprom7_t *ctx );
 
err_t eeprom7_send_cmd ( eeprom7_t *ctx, uint8_t cmd );
 
void eeprom7_sw_reset ( eeprom7_t *ctx );
 
void eeprom7_set_status ( eeprom7_t *ctx, uint8_t status );
 
uint8_t eeprom7_get_status ( eeprom7_t *ctx );
 
void eeprom7_write_memory ( eeprom7_t *ctx, uint32_t addr, uint8_t *p_tx_data, uint8_t n_bytes );
 
void eeprom7_read_memory ( eeprom7_t *ctx, uint32_t addr, uint8_t *p_rx_data, uint8_t n_bytes);
err_t eeprom7_check_status ( eeprom7_t *ctx, uint8_t check_bit );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM7_H
 
 // eeprom7
 
// ------------------------------------------------------------------------ END