llci2c  2.0.0.0
llci2c.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 LLCI2C_H
36 #define LLCI2C_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 LLCI2C_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
61 #define LLCI2C_RETVAL uint8_t
62 
63 #define LLCI2C_OK 0x00
64 #define LLCI2C_INIT_ERROR 0xFF
65 
71 #define I2CLLC_END_MODE_RESTART 0
72 #define I2CLLC_END_MODE_STOP 1
73  // End group macro
76 // --------------------------------------------------------------- PUBLIC TYPES
85 typedef struct
86 {
87  // Modules
88 
89  i2c_master_t i2c;
90 
91  // ctx variable
92 
93  uint8_t slave_address;
94 
95 } llci2c_t;
96 
100 typedef struct
101 {
102  // Communication gpio pins
103 
104  pin_name_t scl;
105  pin_name_t sda;
106 
107  // static variable
108 
109  uint32_t i2c_speed;
110  uint8_t i2c_address;
111 
112 } llci2c_cfg_t;
113  // End types group
115 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
116 
122 #ifdef __cplusplus
123 extern "C"{
124 #endif
125 
135 
145 
156 void llci2c_generic_write ( llci2c_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
157 
168 void llci2c_generic_read ( llci2c_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
169 
170 #ifdef __cplusplus
171 }
172 #endif
173 #endif // _LLCI2C_H_
174  // End public_function group
177 
178 // ------------------------------------------------------------------------- END
llci2c_cfg_setup
void llci2c_cfg_setup(llci2c_cfg_t *cfg)
Config Object Initialization function.
llci2c_cfg_t::i2c_address
uint8_t i2c_address
Definition: llci2c.h:110
LLCI2C_RETVAL
#define LLCI2C_RETVAL
Definition: llci2c.h:61
llci2c_cfg_t::sda
pin_name_t sda
Definition: llci2c.h:105
llci2c_t::slave_address
uint8_t slave_address
Definition: llci2c.h:93
llci2c_t::i2c
i2c_master_t i2c
Definition: llci2c.h:89
llci2c_cfg_t
Click configuration structure definition.
Definition: llci2c.h:101
llci2c_init
LLCI2C_RETVAL llci2c_init(llci2c_t *ctx, llci2c_cfg_t *cfg)
Initialization function.
llci2c_generic_read
void llci2c_generic_read(llci2c_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
llci2c_t
Click ctx object definition.
Definition: llci2c.h:86
llci2c_cfg_t::scl
pin_name_t scl
Definition: llci2c.h:104
llci2c_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: llci2c.h:109
llci2c_generic_write
void llci2c_generic_write(llci2c_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.