eeprom2  2.0.0.0
eeprom2.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 EEPROM2_H
36 #define EEPROM2_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_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define EEPROM2_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
68 
74 #define EEPROM2_OK 0
75 #define EEPROM2_ERROR -1
76  // End group macro
79 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90  digital_out_t cs;
91 
92  // Modules
93 
94  spi_master_t spi;
95  pin_name_t chip_select;
96 
97 } eeprom2_t;
98 
102 typedef struct
103 {
104  // Communication gpio pins
105 
106  pin_name_t miso;
107  pin_name_t mosi;
108  pin_name_t sck;
109  pin_name_t cs;
110 
111  // static variable
112 
113  uint32_t spi_speed;
114  spi_master_mode_t spi_mode;
115  spi_master_chip_select_polarity_t cs_polarity;
116 
117 } eeprom2_cfg_t;
118  // End types group
120 
121 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
122 
127 #ifdef __cplusplus
128 extern "C"{
129 #endif
130 
140 
149 err_t eeprom2_init ( eeprom2_t *ctx, eeprom2_cfg_t *cfg );
150 
160 void eeprom2_write ( eeprom2_t *ctx, uint32_t memory_address, uint8_t value );
161 
172 void eeprom2_write_bytes( eeprom2_t *ctx, uint32_t memory_address, uint8_t *value, uint8_t count );
173 
183 uint8_t eeprom2_read( eeprom2_t *ctx, uint32_t memory_address );
184 
195 void eeprom2_read_bytes( eeprom2_t *ctx, uint32_t memory_address, uint8_t *value, uint8_t count );
196 
205 
214 
215 #ifdef __cplusplus
216 }
217 #endif
218 #endif // _EEPROM2_H_
219  // End public_function group
222 
223 // ------------------------------------------------------------------------- END
eeprom2_cfg_t::sck
pin_name_t sck
Definition: eeprom2.h:108
eeprom2_write_bytes
void eeprom2_write_bytes(eeprom2_t *ctx, uint32_t memory_address, uint8_t *value, uint8_t count)
Function to write bytes.
eeprom2_cfg_t::mosi
pin_name_t mosi
Definition: eeprom2.h:107
eeprom2_memory_enable
void eeprom2_memory_enable(eeprom2_t *ctx)
Enable EEPROM memory.
eeprom2_t::cs
digital_out_t cs
Definition: eeprom2.h:90
eeprom2_t
Click ctx object definition.
Definition: eeprom2.h:89
eeprom2_t::chip_select
pin_name_t chip_select
Definition: eeprom2.h:95
eeprom2_cfg_t::miso
pin_name_t miso
Definition: eeprom2.h:106
eeprom2_cfg_t::spi_speed
uint32_t spi_speed
Definition: eeprom2.h:113
eeprom2_memory_disable
void eeprom2_memory_disable(eeprom2_t *ctx)
Disable EEPROM memory.
eeprom2_cfg_t::cs
pin_name_t cs
Definition: eeprom2.h:109
eeprom2_cfg_setup
void eeprom2_cfg_setup(eeprom2_cfg_t *cfg)
Config Object Initialization function.
eeprom2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eeprom2.h:115
eeprom2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eeprom2.h:114
eeprom2_cfg_t
Click configuration structure definition.
Definition: eeprom2.h:103
eeprom2_t::spi
spi_master_t spi
Definition: eeprom2.h:94
eeprom2_init
err_t eeprom2_init(eeprom2_t *ctx, eeprom2_cfg_t *cfg)
Initialization function.
eeprom2_read
uint8_t eeprom2_read(eeprom2_t *ctx, uint32_t memory_address)
Generic read function.
eeprom2_read_bytes
void eeprom2_read_bytes(eeprom2_t *ctx, uint32_t memory_address, uint8_t *value, uint8_t count)
Function to read bytes.
eeprom2_write
void eeprom2_write(eeprom2_t *ctx, uint32_t memory_address, uint8_t value)
Generic write function.