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 "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 // -------------------------------------------------------------- PUBLIC MACROS
62 #define LLCI2C_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
65 
71 #define LLCI2C_RETVAL uint8_t
72 
73 #define LLCI2C_OK 0x00
74 #define LLCI2C_INIT_ERROR 0xFF
75 
81 #define I2CLLC_END_MODE_RESTART 0
82 #define I2CLLC_END_MODE_STOP 1
83  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
95 typedef struct
96 {
97  // Modules
98 
99  i2c_master_t i2c;
100 
101  // ctx variable
102 
103  uint8_t slave_address;
104 
105 } llci2c_t;
106 
110 typedef struct
111 {
112  // Communication gpio pins
113 
114  pin_name_t scl;
115  pin_name_t sda;
116 
117  // static variable
118 
119  uint32_t i2c_speed;
120  uint8_t i2c_address;
121 
122 } llci2c_cfg_t;
123  // End types group
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
132 #ifdef __cplusplus
133 extern "C"{
134 #endif
135 
145 
155 
166 void llci2c_generic_write ( llci2c_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
167 
178 void llci2c_generic_read ( llci2c_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
179 
180 #ifdef __cplusplus
181 }
182 #endif
183 #endif // _LLCI2C_H_
184  // End public_function group
187 
188 // ------------------------------------------------------------------------- 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:120
LLCI2C_RETVAL
#define LLCI2C_RETVAL
Definition: llci2c.h:71
llci2c_cfg_t::sda
pin_name_t sda
Definition: llci2c.h:115
llci2c_t::slave_address
uint8_t slave_address
Definition: llci2c.h:103
llci2c_t::i2c
i2c_master_t i2c
Definition: llci2c.h:99
llci2c_cfg_t
Click configuration structure definition.
Definition: llci2c.h:111
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:96
llci2c_cfg_t::scl
pin_name_t scl
Definition: llci2c.h:114
llci2c_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: llci2c.h:119
llci2c_generic_write
void llci2c_generic_write(llci2c_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.