mram2  2.0.0.0
mram2.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 MRAM2_H
36 #define MRAM2_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define MRAM2_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
70 
76 #define MRAM2_OK 0
77 #define MRAM2_ERROR -1
78 
84 #define MRAM2_CMD_RDSR 0x05
85 #define MRAM2_CMD_WREN 0x06
86 #define MRAM2_CMD_WRDI 0x04
87 #define MRAM2_CMD_WRSR 0x01
88 #define MRAM2_CMD_READ 0x03
89 #define MRAM2_CMD_FREAD 0x0B
90 #define MRAM2_CMD_WRITE 0x02
91 #define MRAM2_CMD_SLEEP 0xB9
92 #define MRAM2_CMD_WAKE 0xAB
93 #define MRAM2_CMD_TDET 0x17
94 #define MRAM2_CMD_TDETX 0x07
95 #define MRAM2_CMD_RDID 0x4B
96 
102 #define MRAM2_STAT_REG_SRWD 0x80
103 #define MRAM2_STAT_REG_QPI 0x40
104 #define MRAM2_STAT_REG_BP1 0x08
105 #define MRAM2_STAT_REG_BP0 0x04
106 #define MRAM2_STAT_REG_WEL 0x02
107 
113 #define MRAM2_XIP_SET_CONT 0xEF
114 #define MRAM2_XIP_RST_STOP 0xFF
115 
121 #define MRAM2_WP_ENABLE 0x01
122 #define MRAM2_WP_DISABLE 0x00
123 #define MRAM2_HLD_ENABLE 0x01
124 #define MRAM2_HLD_DISABLE 0x00
125 #define MRAM2_PIN_LOW 0x00
126 #define MRAM2_PIN_HIGH 0x01
127  // End group macro
130 // --------------------------------------------------------------- PUBLIC TYPES
139 typedef struct
140 {
141  digital_out_t cs;
142  // Output pins
143 
144  digital_out_t rst;
145  digital_out_t int_pin;
146 
147  // Modules
148 
149  spi_master_t spi;
150  pin_name_t chip_select;
151 
152 } mram2_t;
153 
157 typedef struct
158 {
159  // Communication gpio pins
160 
161  pin_name_t miso;
162  pin_name_t mosi;
163  pin_name_t sck;
164  pin_name_t cs;
165 
166  // Additional gpio pins
167 
168  pin_name_t rst;
169  pin_name_t int_pin;
170 
171  // static variable
172 
173  uint32_t spi_speed;
174  spi_master_mode_t spi_mode;
175  spi_master_chip_select_polarity_t cs_polarity;
176 
177 } mram2_cfg_t;
178  // End types group
180 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
181 
186 #ifdef __cplusplus
187 extern "C"{
188 #endif
189 
199 
207 err_t mram2_init ( mram2_t *ctx, mram2_cfg_t *cfg );
208 
218 uint8_t mram2_rdsr ( mram2_t *ctx );
219 
227 void mram2_wren ( mram2_t *ctx );
228 
236 void mram2_wrdi ( mram2_t *ctx );
237 
250 void mram2_wrsr ( mram2_t *ctx, uint8_t stat_reg );
251 
263 void mram2_read ( mram2_t *ctx, uint32_t mem_adr, uint8_t *rd_data, uint8_t n_bytes );
264 
277 void mram2_fread ( mram2_t *ctx, uint32_t mem_adr, uint8_t mode, uint8_t *rd_data, uint8_t n_bytes );
278 
291 void mram2_write ( mram2_t *ctx, uint32_t mem_adr, uint8_t *wr_data, uint8_t n_bytes );
292 
300 void mram2_sleep ( mram2_t *ctx );
301 
309 void mram2_wake ( mram2_t *ctx );
310 
325 uint32_t mram2_tdet ( mram2_t *ctx );
326 
336 void mram2_tdetx ( mram2_t *ctx );
337 
346 void mram2_rdid ( mram2_t *ctx, uint8_t *rd_id );
347 
356 void mram2_write_protect ( mram2_t *ctx, uint8_t state );
357 
366 void mram2_hold ( mram2_t *ctx, uint8_t state );
367 
368 #ifdef __cplusplus
369 }
370 #endif
371 #endif // _MRAM2_H_
372  // End public_function group
375 
376 // ------------------------------------------------------------------------- END
mram2_t::rst
digital_out_t rst
Definition: mram2.h:144
mram2_tdet
uint32_t mram2_tdet(mram2_t *ctx)
Tamper Detect (TDET) function.
mram2_read
void mram2_read(mram2_t *ctx, uint32_t mem_adr, uint8_t *rd_data, uint8_t n_bytes)
Read Data Bytes function.
mram2_cfg_t::mosi
pin_name_t mosi
Definition: mram2.h:162
mram2_t::cs
digital_out_t cs
Definition: mram2.h:141
mram2_tdetx
void mram2_tdetx(mram2_t *ctx)
Tamper Detect Exit function.
mram2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: mram2.h:175
mram2_t::chip_select
pin_name_t chip_select
Definition: mram2.h:150
mram2_cfg_t::sck
pin_name_t sck
Definition: mram2.h:163
mram2_fread
void mram2_fread(mram2_t *ctx, uint32_t mem_adr, uint8_t mode, uint8_t *rd_data, uint8_t n_bytes)
Fast Read Data Bytes function.
mram2_cfg_setup
void mram2_cfg_setup(mram2_cfg_t *cfg)
Config Object Initialization function.
mram2_cfg_t
Click configuration structure definition.
Definition: mram2.h:158
mram2_t
Click ctx object definition.
Definition: mram2.h:140
mram2_wrsr
void mram2_wrsr(mram2_t *ctx, uint8_t stat_reg)
Write Status Register function.
mram2_write
void mram2_write(mram2_t *ctx, uint32_t mem_adr, uint8_t *wr_data, uint8_t n_bytes)
Write Data Bytes function.
mram2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: mram2.h:174
mram2_sleep
void mram2_sleep(mram2_t *ctx)
Enter Sleep Mode function.
mram2_cfg_t::miso
pin_name_t miso
Definition: mram2.h:161
mram2_hold
void mram2_hold(mram2_t *ctx, uint8_t state)
Hold function.
mram2_cfg_t::rst
pin_name_t rst
Definition: mram2.h:168
mram2_write_protect
void mram2_write_protect(mram2_t *ctx, uint8_t state)
Write Protect function.
mram2_t::spi
spi_master_t spi
Definition: mram2.h:149
mram2_init
err_t mram2_init(mram2_t *ctx, mram2_cfg_t *cfg)
Initialization function.
mram2_cfg_t::int_pin
pin_name_t int_pin
Definition: mram2.h:169
mram2_wake
void mram2_wake(mram2_t *ctx)
Exit Sleep Mode function.
mram2_wrdi
void mram2_wrdi(mram2_t *ctx)
Write Disable function.
mram2_t::int_pin
digital_out_t int_pin
Definition: mram2.h:145
mram2_cfg_t::spi_speed
uint32_t spi_speed
Definition: mram2.h:173
mram2_rdid
void mram2_rdid(mram2_t *ctx, uint8_t *rd_id)
Read ID function.
mram2_wren
void mram2_wren(mram2_t *ctx)
Write Enable function.
mram2_cfg_t::cs
pin_name_t cs
Definition: mram2.h:164
mram2_rdsr
uint8_t mram2_rdsr(mram2_t *ctx)
Read Status Register function.