reram2  2.0.0.0
reram2.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 
28 #ifndef RERAM2_H
29 #define RERAM2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_spi_master.h"
47 #include "spi_specifics.h"
48 
69 #define RERAM2_CMD_WREN 0x06
70 #define RERAM2_CMD_WRDI 0x04
71 #define RERAM2_CMD_RDSR 0x05
72 #define RERAM2_CMD_WRSR 0x01
73 #define RERAM2_CMD_READ 0x03
74 #define RERAM2_CMD_WRITE 0x02
75 #define RERAM2_CMD_RDID 0x9F
76 #define RERAM2_CMD_RDUID 0x83
77 #define RERAM2_CMD_SLEEP 0xB9
78 #define RERAM2_CMD_PWDN 0xE2
79  // reram2_cmd
81 
96 #define RERAM2_DEVICE_ID 0x047FAA03
97 #define RERAM2_MANUFACTURER_ID 0x04
98 #define RERAM2_CONTINUATION_CODE 0x7F
99 #define RERAM2_PRODUCT_ID 0xAA03
100 
105 #define RERAM2_HOLD_ENABLE 0x00
106 #define RERAM2_HOLD_DISABLE 0x01
107 
112 #define RERAM2_WP_ENABLE 0x00
113 #define RERAM2_WP_DISABLE 0x01
114 
123 #define RERAM2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
124 #define RERAM2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
125  // reram2_set
127 
142 #define RERAM2_MAP_MIKROBUS( cfg, mikrobus ) \
143  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
144  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
145  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
146  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
147  cfg.ho = MIKROBUS( mikrobus, MIKROBUS_RST ); \
148  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
149  // reram2_map // reram2
152 
157 typedef struct
158 {
159  // Output pins
160  digital_out_t ho;
161  digital_out_t wp;
163  // Modules
164  spi_master_t spi;
166  pin_name_t chip_select;
168 } reram2_t;
169 
174 typedef struct
175 {
176  // Communication gpio pins
177  pin_name_t miso;
178  pin_name_t mosi;
179  pin_name_t sck;
180  pin_name_t cs;
182  // Additional gpio pins
183  pin_name_t ho;
184  pin_name_t wp;
186  // static variable
187  uint32_t spi_speed;
188  spi_master_mode_t spi_mode;
189  spi_master_chip_select_polarity_t cs_polarity;
191 } reram2_cfg_t;
192 
197 typedef struct
198 {
199  uint8_t write_protect;
200  uint8_t block_protect;
203 
205 
210 typedef struct
211 {
214  uint16_t product_id;
215  uint8_t lot_id[ 5 ];
216  uint8_t wafer_id;
217  uint16_t chip_id;
218 
220 
225 typedef enum
226 {
228  RERAM2_ERROR = -1
229 
231 
248 
263 err_t reram2_init ( reram2_t *ctx, reram2_cfg_t *cfg );
264 
279 
295 err_t reram2_generic_write ( reram2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
296 
312 err_t reram2_generic_read ( reram2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
313 
328 err_t reram2_set_hold ( reram2_t *ctx, uint8_t en_hold );
329 
344 err_t reram2_set_write_protect ( reram2_t *ctx, uint8_t en_wp );
345 
357 err_t reram2_wake_up ( reram2_t *ctx );
358 
371 err_t reram2_send_command ( reram2_t *ctx, uint8_t cmd );
372 
388 
404 
419 
437 err_t reram2_write_memory ( reram2_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint16_t len );
438 
456 err_t reram2_read_memory ( reram2_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint16_t len );
457 
458 #ifdef __cplusplus
459 }
460 #endif
461 #endif // RERAM2_H
462  // reram2
464 
465 // ------------------------------------------------------------------------ END
reram2_dev_id_t
ReRAM 2 Click status object.
Definition: reram2.h:211
reram2_read_device_id
err_t reram2_read_device_id(reram2_t *ctx, reram2_dev_id_t *dev_id)
ReRAM 2 read device ID function.
reram2_dev_id_t::continuation_code
uint8_t continuation_code
Definition: reram2.h:213
reram2_cfg_t::miso
pin_name_t miso
Definition: reram2.h:177
reram2_cfg_t::mosi
pin_name_t mosi
Definition: reram2.h:178
reram2_send_command
err_t reram2_send_command(reram2_t *ctx, uint8_t cmd)
ReRAM 2 set command function.
reram2_return_value_t
reram2_return_value_t
ReRAM 2 Click return value data.
Definition: reram2.h:226
reram2_cfg_t::spi_speed
uint32_t spi_speed
Definition: reram2.h:187
RERAM2_OK
@ RERAM2_OK
Definition: reram2.h:227
reram2_cfg_t
ReRAM 2 Click configuration object.
Definition: reram2.h:175
reram2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: reram2.h:189
reram2_wake_up
err_t reram2_wake_up(reram2_t *ctx)
ReRAM 2 wake up function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
reram2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: reram2.h:188
reram2_cfg_setup
void reram2_cfg_setup(reram2_cfg_t *cfg)
ReRAM 2 configuration object setup function.
reram2_set_write_protect
err_t reram2_set_write_protect(reram2_t *ctx, uint8_t en_wp)
ReRAM 2 write protection function.
reram2_t::chip_select
pin_name_t chip_select
Definition: reram2.h:166
reram2_cfg_t::cs
pin_name_t cs
Definition: reram2.h:180
reram2_status_t
ReRAM 2 Click status object.
Definition: reram2.h:198
reram2_status_t::write_enable_latch
uint8_t write_enable_latch
Definition: reram2.h:201
reram2_cfg_t::wp
pin_name_t wp
Definition: reram2.h:184
reram2_t::wp
digital_out_t wp
Definition: reram2.h:161
reram2_t::spi
spi_master_t spi
Definition: reram2.h:164
reram2_set_hold
err_t reram2_set_hold(reram2_t *ctx, uint8_t en_hold)
ReRAM 2 set hold function.
reram2_dev_id_t::chip_id
uint16_t chip_id
Definition: reram2.h:217
reram2_get_status
err_t reram2_get_status(reram2_t *ctx, reram2_status_t *status)
ReRAM 2 get status function.
reram2_dev_id_t::manufacturer_id
uint8_t manufacturer_id
Definition: reram2.h:212
RERAM2_ERROR
@ RERAM2_ERROR
Definition: reram2.h:228
reram2_status_t::write_protect
uint8_t write_protect
Definition: reram2.h:199
reram2_dev_id_t::product_id
uint16_t product_id
Definition: reram2.h:214
reram2_cfg_t::ho
pin_name_t ho
Definition: reram2.h:183
reram2_init
err_t reram2_init(reram2_t *ctx, reram2_cfg_t *cfg)
ReRAM 2 initialization function.
reram2_t
ReRAM 2 Click context object.
Definition: reram2.h:158
reram2_status_t::write_in_progress
uint8_t write_in_progress
Definition: reram2.h:202
reram2_cfg_t::sck
pin_name_t sck
Definition: reram2.h:179
reram2_generic_read
err_t reram2_generic_read(reram2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
ReRAM 2 data reading function.
reram2_dev_id_t::wafer_id
uint8_t wafer_id
Definition: reram2.h:216
reram2_t::ho
digital_out_t ho
Definition: reram2.h:160
reram2_generic_write
err_t reram2_generic_write(reram2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
ReRAM 2 data writing function.
reram2_read_memory
err_t reram2_read_memory(reram2_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint16_t len)
ReRAM 2 read memory function.
reram2_write_memory
err_t reram2_write_memory(reram2_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint16_t len)
ReRAM 2 write memory function.
reram2_check_device_id
err_t reram2_check_device_id(reram2_t *ctx)
ReRAM 2 check device ID function.
reram2_default_cfg
err_t reram2_default_cfg(reram2_t *ctx)
ReRAM 2 default configuration function.
reram2_status_t::block_protect
uint8_t block_protect
Definition: reram2.h:200