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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define DUALEE_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
61 #define DUALEE_RETVAL uint8_t
62 
63 #define DUALEE_OK 0x00
64 #define DUALEE_INIT_ERROR 0xFF
65 
71 #define DUALEE_SLAVEADDRESS_1 0x50
72 #define DUALEE_SLAVEADDRESS_2 0x54
73 
79 #define DUALEE_ADDRESS_START 0x00000000
80 #define DUALEE_ADDRESS_END 0x0007FFFE
81 
87 #define DUALEE_PAGE_START_OF_FIRST 0x00000000
88 #define DUALEE_PAGE_END_OF_FIRST 0x0003FFFF
89 #define DUALEE_PAGE_START_OF_SECOND 0x00040000
90 #define DUALEE_PAGE_END_OF_SECOND 0x0007FFFE
91 
97 #define DUALEE_MAXIMUM_DATA 251
98 
104 #define DUALEE_ERROR_RW 0
105 #define DUALEE_SUCCESSFUL_RW 1
106  // End group macro
109 // --------------------------------------------------------------- PUBLIC TYPES
118 typedef struct
119 {
120  // Modules
121 
122  i2c_master_t i2c;
123 
124  // ctx variable
125 
126  uint8_t slave_address;
129 
130 } dualee_t;
131 
135 typedef struct
136 {
137  // Communication gpio pins
138 
139  pin_name_t scl;
140  pin_name_t sda;
141 
142  // static variable
143 
144  uint32_t i2c_speed;
145  uint8_t i2c_address;
146  uint8_t i2c_address_1;
147  uint8_t i2c_address_2;
148 
149 } dualee_cfg_t;
150  // End types group
152 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
153 
159 #ifdef __cplusplus
160 extern "C"{
161 #endif
162 
172 
182 
193 void dualee_generic_write ( dualee_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len );
194 
205 void dualee_generic_read ( dualee_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len );
206 
217 uint8_t dualee_write ( dualee_t *ctx, uint32_t reg_address, uint8_t *data_buff, uint8_t n_bytes);
218 
229 uint8_t dualee_read ( dualee_t *ctx, uint32_t reg_address, uint8_t *data_buff, uint8_t n_bytes );
230 
231 
232 #ifdef __cplusplus
233 }
234 #endif
235 #endif // _DUALEE_H_
236  // End public_function group
239 
240 // ------------------------------------------------------------------------- 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:136
dualee_cfg_t::i2c_address_2
uint8_t i2c_address_2
Definition: dualee.h:147
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:128
dualee_t::slave_address_1
uint8_t slave_address_1
Definition: dualee.h:127
DUALEE_RETVAL
#define DUALEE_RETVAL
Definition: dualee.h:61
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:144
dualee_t::slave_address
uint8_t slave_address
Definition: dualee.h:126
dualee_cfg_t::scl
pin_name_t scl
Definition: dualee.h:139
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:122
dualee_t
Click ctx object definition.
Definition: dualee.h:119
dualee_cfg_t::i2c_address
uint8_t i2c_address
Definition: dualee.h:145
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:146
dualee_cfg_t::sda
pin_name_t sda
Definition: dualee.h:140