eeprom6.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 EEPROM6_H
#define EEPROM6_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_one_wire.h"
    
#define EEPROM6_CMD_WRITE_SCRATCHPAD      0x0F
#define EEPROM6_CMD_READ_SCRATCHPAD       0xAA
#define EEPROM6_CMD_COPY_SCRATCHPAD       0x55
#define EEPROM6_CMD_READ_MEMORY           0xF0  
#define EEPROM6_CMD_EXTENDED_READ_MEMORY  0xA5
 
 // eeprom6_cmd
 
#define EEPROM6_FAMILY_CODE               0x43
 
#define EEPROM6_ADDRESS_0                 0x00
#define EEPROM6_ADDRESS_1                 0x01
#define EEPROM6_ADDRESS_ALL               0xFF
 
 // eeprom6_set
 
#define EEPROM6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_AN ); 
 
 // eeprom6_map
 // eeprom6
 
typedef enum
{
    EEPROM6_GPIO_0,      
    EEPROM6_GPIO_1       
} eeprom6_gpio_sel_t;
 
typedef struct
{
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t address;                    
} eeprom6_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;                     
    pin_name_t gp1;                     
    eeprom6_gpio_sel_t gpio_sel;        
} eeprom6_cfg_t;
 
typedef enum
{
    EEPROM6_OK = 0,
    EEPROM6_ERROR = -1
 
} eeprom6_return_value_t;
 
void eeprom6_cfg_setup ( eeprom6_cfg_t *cfg );
 
void eeprom6_gpio_selection ( eeprom6_cfg_t *cfg, eeprom6_gpio_sel_t gpio_sel );
 
err_t eeprom6_init ( eeprom6_t *ctx, eeprom6_cfg_t *cfg );
 
err_t eeprom6_default_cfg ( eeprom6_t *ctx );
 
err_t eeprom6_check_communication ( eeprom6_t *ctx );
 
err_t eeprom6_select_device ( eeprom6_t *ctx );
 
err_t eeprom6_read_scratchpad ( eeprom6_t *ctx, uint8_t *scratchpad, uint8_t scratchpad_len );
 
err_t eeprom6_write_scratchpad ( eeprom6_t *ctx, uint8_t *scratchpad, uint8_t scratchpad_len );
 
err_t eeprom6_read_mem ( eeprom6_t *ctx, uint16_t reg_adr, uint8_t *data_in, uint16_t n_len );
 
err_t eeprom6_write_mem ( eeprom6_t *ctx, uint16_t reg_adr, uint8_t *data_in, uint16_t n_len );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM6_H
 
 // eeprom6
 
// ------------------------------------------------------------------------ END