swieeprom.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 SWIEEPROM_H
#define SWIEEPROM_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"
 
#define SWIEEPROM_OP_CODE_EEPROM        0xA0
#define SWIEEPROM_OP_CODE_SECURITY      0xB0
#define SWIEEPROM_OP_CODE_LOCK          0x20
#define SWIEEPROM_OP_CODE_ROM           0x70
#define SWIEEPROM_OP_CODE_FREEZE_ROM    0x10
#define SWIEEPROM_OP_CODE_ID            0xC0
#define SWIEEPROM_OP_CODE_STDN_SPEED    0xD0
#define SWIEEPROM_OP_CODE_HIGH_SPEED    0xE0
 
#define SWIEEPROM_DEVICE_ID             0x00D200
 
 // swieeprom_set
 // swieeprom
 
 
typedef err_t ( *drv_reset_t ) ( void );
typedef void ( *drv_set_t ) ( void );
typedef uint8_t ( *drv_get_t ) ( void );
 
typedef struct
{
    uint8_t slave_address;      
    drv_reset_t swi_reset;      
    drv_set_t swi_start_stop;   
    drv_set_t swi_logic_0;      
    drv_set_t swi_logic_1;      
    drv_get_t swi_logic_read;   
} swieeprom_t;
typedef struct {…};
 
typedef enum
{
    SWIEEPROM_OK = 0,
    SWIEEPROM_ERROR = -1
 
} swieeprom_return_value_t;
typedef enum {…};
 
err_t swieeprom_init ( swieeprom_t *ctx );
 
err_t swieeprom_check_communication ( swieeprom_t *ctx );
 
err_t swieeprom_mem_write ( swieeprom_t *ctx, uint8_t start_addr, uint8_t data_in );
 
err_t swieeprom_mem_write_page ( swieeprom_t *ctx, uint8_t start_addr, uint8_t *data_in, uint8_t len );
 
err_t swieeprom_mem_read ( swieeprom_t *ctx, uint8_t start_addr, uint8_t *data_out, uint8_t len );
 
err_t swieeprom_mem_clear ( swieeprom_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SWIEEPROM_H
 
 // swieeprom
 
// ------------------------------------------------------------------------ END