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 "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define MRAM2_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
59  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
60 
66 #define MRAM2_RETVAL uint8_t
67 
68 #define MRAM2_OK 0x00
69 #define MRAM2_INIT_ERROR 0xFF
70 
76 #define MRAM2_CMD_RDSR 0x05
77 #define MRAM2_CMD_WREN 0x06
78 #define MRAM2_CMD_WRDI 0x04
79 #define MRAM2_CMD_WRSR 0x01
80 #define MRAM2_CMD_READ 0x03
81 #define MRAM2_CMD_FREAD 0x0B
82 #define MRAM2_CMD_WRITE 0x02
83 #define MRAM2_CMD_SLEEP 0xB9
84 #define MRAM2_CMD_WAKE 0xAB
85 #define MRAM2_CMD_TDET 0x17
86 #define MRAM2_CMD_TDETX 0x07
87 #define MRAM2_CMD_RDID 0x4B
88 
94 #define MRAM2_STAT_REG_SRWD 0x80
95 #define MRAM2_STAT_REG_QPI 0x40
96 #define MRAM2_STAT_REG_BP1 0x08
97 #define MRAM2_STAT_REG_BP0 0x04
98 #define MRAM2_STAT_REG_WEL 0x02
99 
105 #define MRAM2_XIP_SET_CONT 0xEF
106 #define MRAM2_XIP_RST_STOP 0xFF
107 
113 #define MRAM2_WP_ENABLE 0x01
114 #define MRAM2_WP_DISABLE 0x00
115 #define MRAM2_HLD_ENABLE 0x01
116 #define MRAM2_HLD_DISABLE 0x00
117 #define MRAM2_PIN_LOW 0x00
118 #define MRAM2_PIN_HIGH 0x01
119  // End group macro
122 // --------------------------------------------------------------- PUBLIC TYPES
131 typedef struct
132 {
133  digital_out_t cs;
134  // Output pins
135 
136  digital_out_t rst;
137  digital_out_t int_pin;
138 
139  // Modules
140 
141  spi_master_t spi;
142  pin_name_t chip_select;
143 
144 } mram2_t;
145 
149 typedef struct
150 {
151  // Communication gpio pins
152 
153  pin_name_t miso;
154  pin_name_t mosi;
155  pin_name_t sck;
156  pin_name_t cs;
157 
158  // Additional gpio pins
159 
160  pin_name_t rst;
161  pin_name_t int_pin;
162 
163  // static variable
164 
165  uint32_t spi_speed;
166  spi_master_mode_t spi_mode;
167  spi_master_chip_select_polarity_t cs_polarity;
168 
169 } mram2_cfg_t;
170  // End types group
172 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
173 
178 #ifdef __cplusplus
179 extern "C"{
180 #endif
181 
190 void mram2_cfg_setup ( mram2_cfg_t *cfg );
191 
200 
210 uint8_t mram2_rdsr ( mram2_t *ctx );
211 
219 void mram2_wren ( mram2_t *ctx );
220 
228 void mram2_wrdi ( mram2_t *ctx );
229 
242 void mram2_wrsr ( mram2_t *ctx, uint8_t stat_reg );
243 
255 void mram2_read ( mram2_t *ctx, uint32_t mem_adr, uint8_t *rd_data, uint8_t n_bytes );
256 
269 void mram2_fread ( mram2_t *ctx, uint32_t mem_adr, uint8_t mode, uint8_t *rd_data, uint8_t n_bytes );
270 
283 void mram2_write ( mram2_t *ctx, uint32_t mem_adr, uint8_t *wr_data, uint8_t n_bytes );
284 
292 void mram2_sleep ( mram2_t *ctx );
293 
301 void mram2_wake ( mram2_t *ctx );
302 
317 uint32_t mram2_tdet ( mram2_t *ctx );
318 
328 void mram2_tdetx ( mram2_t *ctx );
329 
338 void mram2_rdid ( mram2_t *ctx, uint8_t *rd_id );
339 
348 void mram2_write_protect ( mram2_t *ctx, uint8_t state );
349 
358 void mram2_hold ( mram2_t *ctx, uint8_t state );
359 
360 #ifdef __cplusplus
361 }
362 #endif
363 #endif // _MRAM2_H_
364  // End public_function group
367 
368 // ------------------------------------------------------------------------- END
mram2_t::rst
digital_out_t rst
Definition: mram2.h:136
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:154
mram2_t::cs
digital_out_t cs
Definition: mram2.h:133
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:167
mram2_t::chip_select
pin_name_t chip_select
Definition: mram2.h:142
mram2_cfg_t::sck
pin_name_t sck
Definition: mram2.h:155
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:149
mram2_t
Click ctx object definition.
Definition: mram2.h:131
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:166
mram2_sleep
void mram2_sleep(mram2_t *ctx)
Enter Sleep Mode function.
mram2_cfg_t::miso
pin_name_t miso
Definition: mram2.h:153
mram2_hold
void mram2_hold(mram2_t *ctx, uint8_t state)
Hold function.
mram2_cfg_t::rst
pin_name_t rst
Definition: mram2.h:160
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:141
mram2_cfg_t::int_pin
pin_name_t int_pin
Definition: mram2.h:161
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:137
mram2_cfg_t::spi_speed
uint32_t spi_speed
Definition: mram2.h:165
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_init
MRAM2_RETVAL mram2_init(mram2_t *ctx, mram2_cfg_t *cfg)
Initialization function.
MRAM2_RETVAL
#define MRAM2_RETVAL
Definition: mram2.h:66
mram2_cfg_t::cs
pin_name_t cs
Definition: mram2.h:156
mram2_rdsr
uint8_t mram2_rdsr(mram2_t *ctx)
Read Status Register function.