eeprom4.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 EEPROM4_H
#define EEPROM4_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_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
 
#define EEPROM4_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 EEPROM4_RETVAL  uint8_t
#define EEPROM4_OK           0x00
#define EEPROM4_INIT_ERROR   0xFF
#define EEPROM4_LOGIC_HIGH  1
#define EEPROM4_LOGIC_LOW   0
#define EEPROM4_READY_BIT                 0x01 
#define EEPROM4_WRITE_ENABLE_LATCH_BIT    0x02 
#define EEPROM4_WRITE_PROTECT_ENABLE_BIT  0x80 
#define EEPROM4_LOW_POWER_WRITE_POLL_COMMAND      0x08 
#define EEPROM4_SET_WRITE_ENABLE_LATCH_COMMAND    0x06 
#define EEPROM4_RESET_WRITE_ENABLE_LATCH_COMMAND  0x04 
#define EEPROM4_FIRST_MEMORY_LOCATION                0x00000000 
#define EEPROM4_ONE_QUARTER_MEMORY_LOCATION          0x0000FFFF 
#define EEPROM4_HALF_MEMORY_LOCATION                 0x0001FFFF 
#define EEPROM4_TWO_QUARTER_MEMORY_LOCATION          0x0002FFFF 
#define EEPROM4_LAST_MEMORY_LOCATION                 0x0003FFFF 
#define EEPROM4_NONE_PROTECTED_MEMORY_LOCATION         0x00 
#define EEPROM4_ONE_QUARTER_PROTECTED_MEMORY_LOCATION  0x04 
#define EEPROM4_HALF_PROTECTED_MEMORY_LOCATION         0x08 
#define EEPROM4_ALL_PROTECTED_MEMORY_LOCATION          0x0C 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t cs;
    digital_out_t wp;
    digital_out_t hld;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} eeprom4_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;
 
} eeprom4_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void eeprom4_cfg_setup ( eeprom4_cfg_t *cfg );
 
EEPROM4_RETVAL eeprom4_init ( eeprom4_t *ctx, eeprom4_cfg_t *cfg );
 
void eeprom4_default_cfg ( eeprom4_t *ctx );
 
void eeprom4_generic_transfer ( eeprom4_t *ctx, uint8_t *wr_buf, 
                                uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
 
uint8_t eeprom4_send_command ( eeprom4_t *ctx, uint8_t command_byte );
 
void eeprom4_write_status_reg ( eeprom4_t *ctx, uint8_t data_value );
 
uint8_t eeprom4_read_status_reg ( eeprom4_t *ctx );
 
void eeprom4_write_memory ( eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_input, uint8_t n_bytes );
 
void eeprom4_read_memory ( eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_output, uint8_t n_bytes );
 
void eeprom4_enable_write_protect ( eeprom4_t *ctx, uint8_t state );
 
void eeprom4_enable_hold_operation ( eeprom4_t *ctx, uint8_t state );
 
uint8_t eeprom4_check_status_reg ( eeprom4_t *ctx, uint8_t check_bit );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _EEPROM4_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END