reram  2.0.0.0
reram.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * 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 reram_spi_data_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  // Control pins.
153  digital_out_t wp;
154  digital_out_t ho;
155 
156  // Module.
157  spi_master_t spi;
158 
159 } reram_t;
160 
164 typedef struct
165 {
166  // Used mikrobus pins.
167  pin_name_t ho;
168  pin_name_t cs;
169  pin_name_t sck;
170  pin_name_t sdo;
171  pin_name_t sdi;
172  pin_name_t wp;
173 
174 } reram_cfg_t;
175  // End types group
177 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
183 #ifdef __cplusplus
184 extern "C"{
185 #endif
186 
194 void
196 
209 reram_init( reram_t *ctx, reram_cfg_t *cfg );
210 
218 void
219 reram_default_cfg( reram_t *ctx );
220 
233 reram_send_cmd( reram_t *ctx, reram_spi_data_t cmd_code );
234 
245 reram_read_status( reram_t *ctx );
246 
255 void
257 
272 reram_read_memory( reram_t *ctx, uint32_t mem_addr,
273  reram_spi_data_t *data_out, uint16_t n_bytes );
274 
289 reram_write_memory( reram_t *ctx, uint32_t mem_addr,
290  reram_spi_data_t *data_in, uint16_t n_bytes );
291 
301 uint32_t
302 reram_read_id( reram_t *ctx );
303 
312 void
314 
323 void
325 
333 void
334 reram_wake_up( reram_t *ctx );
335 
336 #ifdef __cplusplus
337 }
338 #endif
339 #endif // _RERAM_H_
340  // End public_function group
343 
344 // ------------------------------------------------------------------------ END
reram_cfg_t::sdi
pin_name_t sdi
Definition: reram.h:171
RERAM_ERR_DRV_INIT
Definition: reram.h:130
reram_read_memory
reram_err_t reram_read_memory(reram_t *ctx, uint32_t mem_addr, reram_spi_data_t *data_out, uint16_t n_bytes)
Memory Read function.
reram_send_cmd
reram_err_t reram_send_cmd(reram_t *ctx, reram_spi_data_t cmd_code)
Command Send function.
RERAM_PIN_STATE_HIGH
Definition: reram.h:143
RERAM_ERR_MEM_ADDR
Definition: reram.h:132
reram_cfg_t::sck
pin_name_t sck
Definition: reram.h:169
reram_t
Click context object definition.
Definition: reram.h:150
reram_read_id
uint32_t reram_read_id(reram_t *ctx)
ID Read function.
reram_t::ho
digital_out_t ho
Definition: reram.h:154
reram_t::spi
spi_master_t spi
Definition: reram.h:157
reram_err_t
reram_err_t
Click error code.
Definition: reram.h:127
reram_write_status
void reram_write_status(reram_t *ctx, reram_spi_data_t data_in)
Status Write function.
reram_cfg_setup
void reram_cfg_setup(reram_cfg_t *cfg)
Configuration Object Setup function.
RERAM_OK
Definition: reram.h:129
reram_set_write_protect_pin
void reram_set_write_protect_pin(reram_t *ctx, reram_pin_state_t state)
Write Protect Pin Set function.
RERAM_ERR_NBYTES
Definition: reram.h:133
RERAM_ERR_CMD
Definition: reram.h:131
reram_cfg_t::sdo
pin_name_t sdo
Definition: reram.h:170
reram_cfg_t::cs
pin_name_t cs
Definition: reram.h:168
reram_wake_up
void reram_wake_up(reram_t *ctx)
Wake Up function.
reram_cfg_t
Click configuration structure definition.
Definition: reram.h:164
RERAM_PIN_STATE_LOW
Definition: reram.h:142
reram_t::wp
digital_out_t wp
Definition: reram.h:153
reram_set_hold_pin
void reram_set_hold_pin(reram_t *ctx, reram_pin_state_t state)
Hold Pin Set function.
reram_init
reram_err_t reram_init(reram_t *ctx, reram_cfg_t *cfg)
Click Initialization function.
reram_cfg_t::wp
pin_name_t wp
Definition: reram.h:172
reram_read_status
reram_spi_data_t reram_read_status(reram_t *ctx)
Status Read function.
reram_write_memory
reram_err_t reram_write_memory(reram_t *ctx, uint32_t mem_addr, reram_spi_data_t *data_in, uint16_t n_bytes)
Memory Write function.
reram_pin_state_t
reram_pin_state_t
Click pin state.
Definition: reram.h:140
reram_default_cfg
void reram_default_cfg(reram_t *ctx)
Click Default Configuration function.
reram_spi_data_t
spi_master_data_t reram_spi_data_t
Definition: reram.h:122
reram_cfg_t::ho
pin_name_t ho
Definition: reram.h:167