macaddress  2.0.0.0
macaddress.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef MACADDRESS_H
36 #define MACADDRESS_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define MACADDRESS_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
66 
72 #define MACADDRESS_RETVAL uint8_t
73 
74 #define MACADDRESS_OK 0x00
75 #define MACADDRESS_INIT_ERROR 0xFF
76 
82 #define MACADDRESS_I2C_ADDRESS_0 0x50
83 #define MACADDRESS_I2C_ADDRESS_1 0x51
84 #define MACADDRESS_I2C_ADDRESS_2 0x52
85 #define MACADDRESS_I2C_ADDRESS_3 0x53
86 
92 #define MACADDRESS_END_ADDR 0x80
93 #define MACADDRESS_MAC_ADDR 0xF8
94 
100 #define MACADDRESS_OK 0x00
101 #define MACADDRESS_PAR_ERR 0x01
102 #define MACADDRESS_COM_ERR 0x02
103  // End group macro
106 // --------------------------------------------------------------- PUBLIC TYPES
113 typedef struct
114 {
115  // Modules
116 
117  i2c_master_t i2c;
118 
119  // ctx variable
120 
121  uint8_t slave_address;
122 
123 } macaddress_t;
124 
128 typedef struct
129 {
130  // Communication gpio pins
131 
132  pin_name_t scl;
133  pin_name_t sda;
134 
135  uint32_t i2c_speed;
136  uint8_t i2c_address;
137 
139  // End types group
141 
142 #ifdef __cplusplus
143 extern "C"{
144 #endif
145 
154 
164 
175 void macaddress_generic_write ( macaddress_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
176 
188 void macaddress_generic_read ( macaddress_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
189 
200 void macaddress_get_mac ( macaddress_t *ctx, uint8_t *read_mac );
201 
202 #ifdef __cplusplus
203 }
204 #endif
205 #endif // _MACADDRESS_H_
206  // End public_function group
209 
210 // ------------------------------------------------------------------------- END
MACADDRESS_RETVAL
#define MACADDRESS_RETVAL
Definition: macaddress.h:72
macaddress_init
MACADDRESS_RETVAL macaddress_init(macaddress_t *ctx, macaddress_cfg_t *cfg)
Initialization function.
macaddress_cfg_t
Click configuration structure definition.
Definition: macaddress.h:129
macaddress_get_mac
void macaddress_get_mac(macaddress_t *ctx, uint8_t *read_mac)
Generic read mac address function.
macaddress_t::slave_address
uint8_t slave_address
Definition: macaddress.h:121
macaddress_cfg_t::scl
pin_name_t scl
Definition: macaddress.h:132
macaddress_generic_read
void macaddress_generic_read(macaddress_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
macaddress_generic_write
void macaddress_generic_write(macaddress_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
macaddress_cfg_t::i2c_address
uint8_t i2c_address
Definition: macaddress.h:136
macaddress_cfg_t::sda
pin_name_t sda
Definition: macaddress.h:133
macaddress_t::i2c
i2c_master_t i2c
Definition: macaddress.h:117
macaddress_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: macaddress.h:135
macaddress_t
Definition: macaddress.h:114
macaddress_cfg_setup
void macaddress_cfg_setup(macaddress_cfg_t *cfg)
Config Object Initialization function.