reram  2.0.0.0
reram.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 _RERAM_H_
36 #define _RERAM_H_
37 
38 #include "drv_digital_out.h"
39 #include "drv_spi_master.h"
40 
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define RERAM_CMD_WREN 0x6
53 #define RERAM_CMD_WRDI 0x4
54 #define RERAM_CMD_SLEEP 0xB9
55 
66 #define RERAM_BLOCK_PROT_NONE 0x0
67 #define RERAM_BLOCK_PROT_UPPER_1_4 0x4
68 #define RERAM_BLOCK_PROT_UPPER_1_2 0x8
69 #define RERAM_BLOCK_PROT_ALL 0xC
70 #define RERAM_BLOCK_PROT_MASK 0xC
71 
77 #define RERAM_WP_STAT_EN 0x80
78 #define RERAM_WP_STAT_DIS 0x0
79 #define RERAM_WP_STAT_MASK 0x80
80  // End write_protect_set group
83 
88 #define RERAM_FLAG_MASK_WEL 0x2
89 #define RERAM_FLAG_MASK_WIP 0x1
90 
96 #define RERAM_MEM_ADDR_START 0x0
97 #define RERAM_MEM_ADDR_END 0x7FFFF
98 #define RERAM_TRANSFER_BYTES_MIN 1
99 #define RERAM_TRANSFER_BYTES_MAX 256
100 
106 #define RERAM_MAP_MIKROBUS( cfg, mikrobus ) \
107  cfg.ho = MIKROBUS( mikrobus, MIKROBUS_RST ); \
108  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
109  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
110  cfg.sdo = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
111  cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
112  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
113  // End macros group
116 // --------------------------------------------------------------- PUBLIC TYPES
122 //typedef spi_master_data_t uint8_t;
123 
127 typedef enum
128 {
129  RERAM_OK = 0,
134 
135 } reram_err_t;
136 
140 typedef enum
141 {
144 
146 
150 typedef struct
151 {
152  digital_out_t cs;
153 
154  // Control pins.
155  digital_out_t wp;
156  digital_out_t ho;
157 
158  // Module.
159  spi_master_t spi;
160  pin_name_t chip_select;
161 
162 } reram_t;
163 
167 typedef struct
168 {
169  // Used mikrobus pins.
170  pin_name_t ho;
171  pin_name_t cs;
172  pin_name_t sck;
173  pin_name_t sdo;
174  pin_name_t sdi;
175  pin_name_t wp;
176 
177  uint32_t spi_speed;
178  uint8_t spi_mode;
179  spi_master_chip_select_polarity_t cs_polarity;
180 
181 } reram_cfg_t;
182  // End types group
184 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
190 #ifdef __cplusplus
191 extern "C"{
192 #endif
193 
201 void
203 
216 reram_init( reram_t *ctx, reram_cfg_t *cfg );
217 
225 void
226 reram_default_cfg( reram_t *ctx );
227 
240 reram_send_cmd( reram_t *ctx, uint8_t cmd_code );
241 
251 uint8_t
252 reram_read_status( reram_t *ctx );
253 
262 void
263 reram_write_status( reram_t *ctx, uint8_t data_in );
264 
279 reram_read_memory( reram_t *ctx, uint32_t mem_addr,
280  uint8_t *data_out, uint16_t n_bytes );
281 
296 reram_write_memory( reram_t *ctx, uint32_t mem_addr,
297  uint8_t *data_in, uint16_t n_bytes );
298 
308 uint32_t
309 reram_read_id( reram_t *ctx );
310 
319 void
321 
330 void
332 
340 void
341 reram_wake_up( reram_t *ctx );
342 
343 #ifdef __cplusplus
344 }
345 #endif
346 #endif // _RERAM_H_
347  // End public_function group
350 
351 // ------------------------------------------------------------------------ END
reram_err_t reram_send_cmd(reram_t *ctx, uint8_t cmd_code)
Command Send function.
void reram_wake_up(reram_t *ctx)
Wake Up function.
pin_name_t sdo
Definition: reram.h:173
Click context object definition.
Definition: reram.h:150
Click configuration structure definition.
Definition: reram.h:167
digital_out_t cs
Definition: reram.h:152
spi_master_chip_select_polarity_t cs_polarity
Definition: reram.h:179
void reram_set_hold_pin(reram_t *ctx, reram_pin_state_t state)
Hold Pin Set function.
uint32_t spi_speed
Definition: reram.h:177
reram_err_t reram_read_memory(reram_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint16_t n_bytes)
Memory Read function.
void reram_cfg_setup(reram_cfg_t *cfg)
Configuration Object Setup function.
pin_name_t wp
Definition: reram.h:175
reram_err_t
Click error code.
Definition: reram.h:127
uint32_t reram_read_id(reram_t *ctx)
ID Read function.
Definition: reram.h:142
digital_out_t wp
Definition: reram.h:155
reram_err_t reram_write_memory(reram_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint16_t n_bytes)
Memory Write function.
void reram_set_write_protect_pin(reram_t *ctx, reram_pin_state_t state)
Write Protect Pin Set function.
Definition: reram.h:129
Definition: reram.h:143
uint8_t reram_read_status(reram_t *ctx)
Status Read function.
pin_name_t ho
Definition: reram.h:170
Definition: reram.h:130
Definition: reram.h:131
pin_name_t sdi
Definition: reram.h:174
pin_name_t cs
Definition: reram.h:171
reram_pin_state_t
Click pin state.
Definition: reram.h:140
uint8_t spi_mode
Definition: reram.h:178
digital_out_t ho
Definition: reram.h:156
reram_err_t reram_init(reram_t *ctx, reram_cfg_t *cfg)
Click Initialization function.
void reram_write_status(reram_t *ctx, uint8_t data_in)
Status Write function.
Definition: reram.h:133
spi_master_t spi
Definition: reram.h:159
void reram_default_cfg(reram_t *ctx)
Click Default Configuration function.
Definition: reram.h:132
pin_name_t chip_select
Definition: reram.h:160
pin_name_t sck
Definition: reram.h:172