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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define EEPROM3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
62 #define EEPROM3_RETVAL uint8_t
63 
64 #define EEPROM3_OK 0x00
65 #define EEPROM3_INIT_ERROR 0xFF
66  // End group macro
69 // --------------------------------------------------------------- PUBLIC TYPES
78 typedef struct
79 {
80 
81  // Modules
82 
83  i2c_master_t i2c;
84 
85  // ctx variable
86 
87  uint8_t slave_address;
88 
89 } eeprom3_t;
90 
94 typedef struct
95 {
96  // Communication gpio pins
97 
98  pin_name_t scl;
99  pin_name_t sda;
100 
101  // static variable
102 
103  uint32_t i2c_speed;
104  uint8_t i2c_address;
105 
106 } eeprom3_cfg_t;
107  // End types group
109 
110 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
111 
117 #ifdef __cplusplus
118 extern "C"{
119 #endif
120 
129 void eeprom3_cfg_setup ( eeprom3_cfg_t *cfg );
130 
140 
150 void eeprom3_write_byte ( eeprom3_t *ctx, uint16_t reg_address, uint8_t data_in );
151 
161 void eeprom3_write_page( eeprom3_t *ctx, uint16_t reg_address, uint8_t* data_in, uint8_t count );
162 
173 void eeprom3_read ( eeprom3_t *ctx, uint16_t reg_address, uint8_t *data_out, uint16_t count );
174 
175 #ifdef __cplusplus
176 }
177 #endif
178 #endif // _EEPROM3_H_
179  // End public_function group
182 
183 // ------------------------------------------------------------------------- END
pin_name_t scl
Definition: eeprom3.h:98
uint8_t slave_address
Definition: eeprom3.h:87
EEPROM3_RETVAL eeprom3_init(eeprom3_t *ctx, eeprom3_cfg_t *cfg)
Initialization function.
Click ctx object definition.
Definition: eeprom3.h:78
void eeprom3_write_byte(eeprom3_t *ctx, uint16_t reg_address, uint8_t data_in)
Generic write function.
i2c_master_t i2c
Definition: eeprom3.h:83
void eeprom3_cfg_setup(eeprom3_cfg_t *cfg)
Config Object Initialization function.
pin_name_t sda
Definition: eeprom3.h:99
uint32_t i2c_speed
Definition: eeprom3.h:103
uint8_t i2c_address
Definition: eeprom3.h:104
void eeprom3_write_page(eeprom3_t *ctx, uint16_t reg_address, uint8_t *data_in, uint8_t count)
Generic write page function.
Click configuration structure definition.
Definition: eeprom3.h:94
void eeprom3_read(eeprom3_t *ctx, uint16_t reg_address, uint8_t *data_out, uint16_t count)
Generic read function.
#define EEPROM3_RETVAL
Definition: eeprom3.h:62