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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_spi_master.h"
37#include "spi_specifics.h"
38
59#define RERAM2_CMD_WREN 0x06
60#define RERAM2_CMD_WRDI 0x04
61#define RERAM2_CMD_RDSR 0x05
62#define RERAM2_CMD_WRSR 0x01
63#define RERAM2_CMD_READ 0x03
64#define RERAM2_CMD_WRITE 0x02
65#define RERAM2_CMD_RDID 0x9F
66#define RERAM2_CMD_RDUID 0x83
67#define RERAM2_CMD_SLEEP 0xB9
68#define RERAM2_CMD_PWDN 0xE2
69 // reram2_cmd
71
86#define RERAM2_DEVICE_ID 0x047FAA03
87#define RERAM2_MANUFACTURER_ID 0x04
88#define RERAM2_CONTINUATION_CODE 0x7F
89#define RERAM2_PRODUCT_ID 0xAA03
90
95#define RERAM2_HOLD_ENABLE 0x00
96#define RERAM2_HOLD_DISABLE 0x01
97
102#define RERAM2_WP_ENABLE 0x00
103#define RERAM2_WP_DISABLE 0x01
104
113#define RERAM2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
114#define RERAM2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
115 // reram2_set
117
132#define RERAM2_MAP_MIKROBUS( cfg, mikrobus ) \
133 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
134 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
135 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
136 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
137 cfg.ho = MIKROBUS( mikrobus, MIKROBUS_RST ); \
138 cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
139 // reram2_map // reram2
142
147typedef struct
148{
149 // Output pins
150 digital_out_t ho;
151 digital_out_t wp;
153 // Modules
154 spi_master_t spi;
156 pin_name_t chip_select;
158} reram2_t;
159
164typedef struct
165{
166 // Communication gpio pins
167 pin_name_t miso;
168 pin_name_t mosi;
169 pin_name_t sck;
170 pin_name_t cs;
172 // Additional gpio pins
173 pin_name_t ho;
174 pin_name_t wp;
176 // static variable
177 uint32_t spi_speed;
178 spi_master_mode_t spi_mode;
179 spi_master_chip_select_polarity_t cs_polarity;
182
187typedef struct
188{
193
195
200typedef struct
201{
204 uint16_t product_id;
205 uint8_t lot_id[ 5 ];
206 uint8_t wafer_id;
207 uint16_t chip_id;
208
210
215typedef enum
216{
218 RERAM2_ERROR = -1
219
221
238
253err_t reram2_init ( reram2_t *ctx, reram2_cfg_t *cfg );
254
269
285err_t reram2_generic_write ( reram2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
286
302err_t reram2_generic_read ( reram2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
303
318err_t reram2_set_hold ( reram2_t *ctx, uint8_t en_hold );
319
334err_t reram2_set_write_protect ( reram2_t *ctx, uint8_t en_wp );
335
348
361err_t reram2_send_command ( reram2_t *ctx, uint8_t cmd );
362
378
394
409
427err_t reram2_write_memory ( reram2_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint16_t len );
428
446err_t reram2_read_memory ( reram2_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint16_t len );
447
448#ifdef __cplusplus
449}
450#endif
451#endif // RERAM2_H
452 // reram2
454
455// ------------------------------------------------------------------------ END
err_t reram2_generic_read(reram2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
ReRAM 2 data reading function.
err_t reram2_generic_write(reram2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
ReRAM 2 data writing function.
err_t reram2_wake_up(reram2_t *ctx)
ReRAM 2 wake up function.
err_t reram2_set_hold(reram2_t *ctx, uint8_t en_hold)
ReRAM 2 set hold function.
err_t reram2_set_write_protect(reram2_t *ctx, uint8_t en_wp)
ReRAM 2 write protection function.
err_t reram2_read_device_id(reram2_t *ctx, reram2_dev_id_t *dev_id)
ReRAM 2 read device ID function.
err_t reram2_init(reram2_t *ctx, reram2_cfg_t *cfg)
ReRAM 2 initialization function.
err_t reram2_write_memory(reram2_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint16_t len)
ReRAM 2 write memory function.
err_t reram2_send_command(reram2_t *ctx, uint8_t cmd)
ReRAM 2 set command function.
err_t reram2_check_device_id(reram2_t *ctx)
ReRAM 2 check device ID function.
err_t reram2_read_memory(reram2_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint16_t len)
ReRAM 2 read memory function.
err_t reram2_get_status(reram2_t *ctx, reram2_status_t *status)
ReRAM 2 get status function.
void reram2_cfg_setup(reram2_cfg_t *cfg)
ReRAM 2 configuration object setup function.
err_t reram2_default_cfg(reram2_t *ctx)
ReRAM 2 default configuration function.
reram2_return_value_t
ReRAM 2 Click return value data.
Definition: reram2.h:216
@ RERAM2_OK
Definition: reram2.h:217
@ RERAM2_ERROR
Definition: reram2.h:218
This file contains SPI specific macros, functions, etc.
ReRAM 2 Click configuration object.
Definition: reram2.h:165
pin_name_t ho
Definition: reram2.h:173
spi_master_chip_select_polarity_t cs_polarity
Definition: reram2.h:179
pin_name_t sck
Definition: reram2.h:169
spi_master_mode_t spi_mode
Definition: reram2.h:178
pin_name_t mosi
Definition: reram2.h:168
uint32_t spi_speed
Definition: reram2.h:177
pin_name_t wp
Definition: reram2.h:174
pin_name_t miso
Definition: reram2.h:167
pin_name_t cs
Definition: reram2.h:170
ReRAM 2 Click status object.
Definition: reram2.h:201
uint16_t product_id
Definition: reram2.h:204
uint8_t continuation_code
Definition: reram2.h:203
uint8_t wafer_id
Definition: reram2.h:206
uint8_t manufacturer_id
Definition: reram2.h:202
uint16_t chip_id
Definition: reram2.h:207
ReRAM 2 Click status object.
Definition: reram2.h:188
uint8_t block_protect
Definition: reram2.h:190
uint8_t write_protect
Definition: reram2.h:189
uint8_t write_in_progress
Definition: reram2.h:192
uint8_t write_enable_latch
Definition: reram2.h:191
ReRAM 2 Click context object.
Definition: reram2.h:148
spi_master_t spi
Definition: reram2.h:154
digital_out_t ho
Definition: reram2.h:150
pin_name_t chip_select
Definition: reram2.h:156
digital_out_t wp
Definition: reram2.h:151