macaddress.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 MACADDRESS_H
#define MACADDRESS_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_i2c_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define MACADDRESS_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ) 
#define MACADDRESS_RETVAL  uint8_t
 
#define MACADDRESS_OK                                              0x00
#define MACADDRESS_INIT_ERROR                                      0xFF
#define MACADDRESS_I2C_ADDRESS_0                                   0x50
#define MACADDRESS_I2C_ADDRESS_1                                   0x51
#define MACADDRESS_I2C_ADDRESS_2                                   0x52
#define MACADDRESS_I2C_ADDRESS_3                                   0x53
#define MACADDRESS_END_ADDR                                        0x80
#define MACADDRESS_MAC_ADDR                                        0xF8
#define MACADDRESS_OK                                              0x00
#define MACADDRESS_PAR_ERR                                         0x01
#define MACADDRESS_COM_ERR                                         0x02
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} macaddress_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} macaddress_cfg_t;
 
 // End types group
 
#ifdef __cplusplus
extern "C"{
#endif
 
MACADDRESS_RETVAL macaddress_init ( macaddress_t *ctx, macaddress_cfg_t *cfg );
 
void macaddress_cfg_setup ( macaddress_cfg_t *cfg );
 
void macaddress_generic_write ( macaddress_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void macaddress_generic_read ( macaddress_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void macaddress_get_mac ( macaddress_t *ctx, uint8_t *read_mac );
 
#ifdef __cplusplus
}
#endif
#endif  // _MACADDRESS_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END