eeram5v  2.0.0.0
eeram5v.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
27 // ----------------------------------------------------------------------------
28 
29 #ifndef EERAM5V_H
30 #define EERAM5V_H
31 
32 #ifdef __cplusplus
33 extern "C"{
34 #endif
35 
36 #include "mikrosdk_version.h"
37 
38 #ifdef __GNUC__
39 #if mikroSDK_GET_VERSION < 20800ul
40 #include "rcu_delays.h"
41 #else
42 #include "delays.h"
43 #endif
44 #endif
45 
46 #include "drv_digital_out.h"
47 #include "drv_digital_in.h"
48 #include "drv_i2c_master.h"
49 
70 #define EERAM5V_ADDRESS_SRAM 0x50
71 #define EERAM5V_ADDRESS_CONTROL 0x18
72 #define EERAM5V_CMD_STORE 0x33
73 #define EERAM5V_CMD_RECALL 0xDD
74  // eeram5v_const
76 
91 #define EERAM5V_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
93  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
94  cfg.hs = MIKROBUS( mikrobus, MIKROBUS_INT )
95  // eeram5v_map // eeram5v
98 
103 typedef struct
104 {
105 
106  digital_out_t hs;
108  // Modules
109 
110  i2c_master_t i2c;
112  // I2C slave address
113 
114  uint8_t slave_address;
116 } eeram5v_t;
117 
122 typedef struct
123 {
124  pin_name_t scl;
125  pin_name_t sda;
127  pin_name_t hs;
129  uint32_t i2c_speed;
130  uint8_t i2c_address;
132 } eeram5v_cfg_t;
133 
138 typedef enum
139 {
141  EERAM5V_ERROR = -1
142 
144 
162 
178 err_t eeram5v_init ( eeram5v_t *ctx, eeram5v_cfg_t *cfg );
179 
196 void eeram5v_generic_write ( eeram5v_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
197 
214 void eeram5v_generic_read ( eeram5v_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
215 
226 void eeram5v_status_write ( eeram5v_t *ctx, uint8_t command );
227 
237 
250 void eeram5v_read ( eeram5v_t *ctx, uint16_t address, uint8_t *data_out, uint8_t count_out );
251 
263  void eeram5v_write ( eeram5v_t *ctx, uint16_t address, uint8_t * data_in, uint8_t count_in );
264 
265 #ifdef __cplusplus
266 }
267 #endif
268 #endif // EERAM5V_H
269  // eeram5v
271 
272 // ------------------------------------------------------------------------ END
eeram5v_cfg_t::hs
pin_name_t hs
Definition: eeram5v.h:127
eeram5v_cfg_t
EERAM 5V Click configuration object.
Definition: eeram5v.h:123
eeram5v_t
EERAM 5V Click context object.
Definition: eeram5v.h:104
eeram5v_cfg_t::scl
pin_name_t scl
Definition: eeram5v.h:124
eeram5v_generic_write
void eeram5v_generic_write(eeram5v_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
EERAM 5V I2C writing function.
eeram5v_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: eeram5v.h:129
eeram5v_t::hs
digital_out_t hs
Definition: eeram5v.h:106
eeram5v_return_value_t
eeram5v_return_value_t
EERAM 5V Click return value data.
Definition: eeram5v.h:139
eeram5v_t::i2c
i2c_master_t i2c
Definition: eeram5v.h:110
eeram5v_status_read
uint8_t eeram5v_status_read(eeram5v_t *ctx)
EERAM 5V Click Status Read.
eeram5v_init
err_t eeram5v_init(eeram5v_t *ctx, eeram5v_cfg_t *cfg)
EERAM 5V initialization function.
EERAM5V_ERROR
@ EERAM5V_ERROR
Definition: eeram5v.h:141
eeram5v_status_write
void eeram5v_status_write(eeram5v_t *ctx, uint8_t command)
EERAM 5V Click Status Write.
eeram5v_cfg_setup
void eeram5v_cfg_setup(eeram5v_cfg_t *cfg)
EERAM 5V configuration object setup function.
eeram5v_generic_read
void eeram5v_generic_read(eeram5v_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
EERAM 5V I2C reading function.
EERAM5V_OK
@ EERAM5V_OK
Definition: eeram5v.h:140
eeram5v_read
void eeram5v_read(eeram5v_t *ctx, uint16_t address, uint8_t *data_out, uint8_t count_out)
EERAM 5V Click SRAM Read.
eeram5v_cfg_t::i2c_address
uint8_t i2c_address
Definition: eeram5v.h:130
eeram5v_t::slave_address
uint8_t slave_address
Definition: eeram5v.h:114
eeram5v_cfg_t::sda
pin_name_t sda
Definition: eeram5v.h:125
eeram5v_write
void eeram5v_write(eeram5v_t *ctx, uint16_t address, uint8_t *data_in, uint8_t count_in)
EERAM 5V Click SRAM Write.