eeprom3  2.0.0.0
eeprom3.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 EEPROM3_H
36 #define EEPROM3_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 EEPROM3_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
65 
72 #define EEPROM3_OK 0
73 #define EEPROM3_ERROR -1
74  // End group macro
77 // --------------------------------------------------------------- PUBLIC TYPES
86 typedef struct
87 {
88  // Modules
89  i2c_master_t i2c;
90 
91  // ctx variable
92  uint8_t slave_address;
93 
94 } eeprom3_t;
95 
99 typedef struct
100 {
101  // Communication gpio pins
102  pin_name_t scl;
103  pin_name_t sda;
104 
105  // static variable
106  uint32_t i2c_speed;
107  uint8_t i2c_address;
108 
109 } eeprom3_cfg_t;
110  // End types group
112 
113 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
114 
120 #ifdef __cplusplus
121 extern "C"{
122 #endif
123 
133 
142 err_t eeprom3_init ( eeprom3_t *ctx, eeprom3_cfg_t *cfg );
143 
153 void eeprom3_write_byte ( eeprom3_t *ctx, uint16_t reg_address, uint8_t data_in );
154 
164 void eeprom3_write_page( eeprom3_t *ctx, uint16_t reg_address, uint8_t* data_in, uint8_t count );
165 
176 void eeprom3_read ( eeprom3_t *ctx, uint16_t reg_address, uint8_t *data_out, uint16_t count );
177 
178 #ifdef __cplusplus
179 }
180 #endif
181 #endif // _EEPROM3_H_
182  // End public_function group
185 
186 // ------------------------------------------------------------------------- END
eeprom3_read
void eeprom3_read(eeprom3_t *ctx, uint16_t reg_address, uint8_t *data_out, uint16_t count)
Generic read function.
eeprom3_write_byte
void eeprom3_write_byte(eeprom3_t *ctx, uint16_t reg_address, uint8_t data_in)
Generic write function.
eeprom3_write_page
void eeprom3_write_page(eeprom3_t *ctx, uint16_t reg_address, uint8_t *data_in, uint8_t count)
Generic write page function.
eeprom3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: eeprom3.h:106
eeprom3_t::slave_address
uint8_t slave_address
Definition: eeprom3.h:92
eeprom3_cfg_setup
void eeprom3_cfg_setup(eeprom3_cfg_t *cfg)
Config Object Initialization function.
eeprom3_init
err_t eeprom3_init(eeprom3_t *ctx, eeprom3_cfg_t *cfg)
Initialization function.
eeprom3_cfg_t::scl
pin_name_t scl
Definition: eeprom3.h:102
eeprom3_cfg_t::sda
pin_name_t sda
Definition: eeprom3.h:103
eeprom3_cfg_t::i2c_address
uint8_t i2c_address
Definition: eeprom3.h:107
eeprom3_cfg_t
Click configuration structure definition.
Definition: eeprom3.h:100
eeprom3_t
Click ctx object definition.
Definition: eeprom3.h:87
eeprom3_t::i2c
i2c_master_t i2c
Definition: eeprom3.h:89