dualee  2.0.0.0
dualee.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 DUALEE_H
36 #define DUALEE_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define DUALEE_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
69 
75 #define DUALEE_RETVAL uint8_t
76 
77 #define DUALEE_OK 0x00
78 #define DUALEE_INIT_ERROR 0xFF
79 
85 #define DUALEE_SLAVEADDRESS_1 0x50
86 #define DUALEE_SLAVEADDRESS_2 0x54
87 
93 #define DUALEE_ADDRESS_START 0x00000000
94 #define DUALEE_ADDRESS_END 0x0007FFFE
95 
101 #define DUALEE_PAGE_START_OF_FIRST 0x00000000
102 #define DUALEE_PAGE_END_OF_FIRST 0x0003FFFF
103 #define DUALEE_PAGE_START_OF_SECOND 0x00040000
104 #define DUALEE_PAGE_END_OF_SECOND 0x0007FFFE
105 
111 #define DUALEE_MAXIMUM_DATA 251
112 
118 #define DUALEE_ERROR_RW 0
119 #define DUALEE_SUCCESSFUL_RW 1
120  // End group macro
123 // --------------------------------------------------------------- PUBLIC TYPES
132 typedef struct
133 {
134  // Modules
135 
136  i2c_master_t i2c;
137 
138  // ctx variable
139 
140  uint8_t slave_address;
143 
144 } dualee_t;
145 
149 typedef struct
150 {
151  // Communication gpio pins
152 
153  pin_name_t scl;
154  pin_name_t sda;
155 
156  // static variable
157 
158  uint32_t i2c_speed;
159  uint8_t i2c_address;
160  uint8_t i2c_address_1;
161  uint8_t i2c_address_2;
162 
163 } dualee_cfg_t;
164  // End types group
166 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
167 
173 #ifdef __cplusplus
174 extern "C"{
175 #endif
176 
186 
196 
207 void dualee_generic_write ( dualee_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len );
208 
219 void dualee_generic_read ( dualee_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len );
220 
231 uint8_t dualee_write ( dualee_t *ctx, uint32_t reg_address, uint8_t *data_buff, uint8_t n_bytes);
232 
243 uint8_t dualee_read ( dualee_t *ctx, uint32_t reg_address, uint8_t *data_buff, uint8_t n_bytes );
244 
245 
246 #ifdef __cplusplus
247 }
248 #endif
249 #endif // _DUALEE_H_
250  // End public_function group
253 
254 // ------------------------------------------------------------------------- END
dualee_write
uint8_t dualee_write(dualee_t *ctx, uint32_t reg_address, uint8_t *data_buff, uint8_t n_bytes)
Generic write data function.
dualee_cfg_t
Click configuration structure definition.
Definition: dualee.h:150
dualee_cfg_t::i2c_address_2
uint8_t i2c_address_2
Definition: dualee.h:161
dualee_read
uint8_t dualee_read(dualee_t *ctx, uint32_t reg_address, uint8_t *data_buff, uint8_t n_bytes)
Generic write data function.
dualee_t::slave_address_2
uint8_t slave_address_2
Definition: dualee.h:142
dualee_t::slave_address_1
uint8_t slave_address_1
Definition: dualee.h:141
DUALEE_RETVAL
#define DUALEE_RETVAL
Definition: dualee.h:75
dualee_generic_write
void dualee_generic_write(dualee_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len)
Generic write function.
dualee_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: dualee.h:158
dualee_t::slave_address
uint8_t slave_address
Definition: dualee.h:140
dualee_cfg_t::scl
pin_name_t scl
Definition: dualee.h:153
dualee_cfg_setup
void dualee_cfg_setup(dualee_cfg_t *cfg)
Config Object Initialization function.
dualee_init
DUALEE_RETVAL dualee_init(dualee_t *ctx, dualee_cfg_t *cfg)
Initialization function.
dualee_t::i2c
i2c_master_t i2c
Definition: dualee.h:136
dualee_t
Click ctx object definition.
Definition: dualee.h:133
dualee_cfg_t::i2c_address
uint8_t i2c_address
Definition: dualee.h:159
dualee_generic_read
void dualee_generic_read(dualee_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len)
Generic read function.
dualee_cfg_t::i2c_address_1
uint8_t i2c_address_1
Definition: dualee.h:160
dualee_cfg_t::sda
pin_name_t sda
Definition: dualee.h:154