eeram3  2.0.0.0
eeram3.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 EERAM3_H
29 #define EERAM3_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define EERAM3_OPCODE_WREN 0x06
61 #define EERAM3_OPCODE_WRDI 0x04
62 #define EERAM3_OPCODE_WRITE 0x02
63 #define EERAM3_OPCODE_READ 0x03
64 #define EERAM3_OPCODE_RDLSWA 0x0A
65 #define EERAM3_OPCODE_SECURE_WRITE 0x12
66 #define EERAM3_OPCODE_SECURE_READ 0x13
67 #define EERAM3_OPCODE_WRSR 0x01
68 #define EERAM3_OPCODE_RDSR 0x05
69 #define EERAM3_OPCODE_STORE 0x08
70 #define EERAM3_OPCODE_RECALL 0x09
71 #define EERAM3_OPCODE_WRNUR 0xC2
72 #define EERAM3_OPCODE_RDNUR 0xC3
73 #define EERAM3_OPCODE_HIBERNATE 0xB9
74  // eeram3_reg
76 
91 #define EERAM3_RDY_BIT_MASK 0x01
92 #define EERAM3_WEL_BIT_MASK 0x02
93 #define EERAM3_BLOCK_PROTECT_BITS_MASK 0x0C
94 #define EERAM3_BLOCK_PROTECT_NONE 0x00
95 #define EERAM3_BLOCK_PROTECT_UPPER_QUARTER 0x04
96 #define EERAM3_BLOCK_PROTECT_UPPER_HALF 0x08
97 #define EERAM3_BLOCK_PROTECT_ALL 0x0C
98 #define EERAM3_SWM_BIT_MASK 0x10
99 #define EERAM3_PRO_BIT_MASK 0x20
100 #define EERAM3_ASE_BIT_MASK 0x40
101 
106 #define EERAM3_MIN_ADDRESS 0x0000
107 #define EERAM3_MAX_ADDRESS 0x7FFF
108 #define EERAM3_MAX_PAGE_ADDRESS 0x3F
109 
118 #define EERAM3_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
119 #define EERAM3_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
120  // eeram3_set
122 
137 #define EERAM3_MAP_MIKROBUS( cfg, mikrobus ) \
138  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
139  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
140  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
141  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
142  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_INT )
143  // eeram3_map // eeram3
146 
151 typedef struct
152 {
153  // Output pins
154  digital_out_t hld;
156  // Modules
157  spi_master_t spi;
159  pin_name_t chip_select;
161 } eeram3_t;
162 
167 typedef struct
168 {
169  // Communication gpio pins
170  pin_name_t miso;
171  pin_name_t mosi;
172  pin_name_t sck;
173  pin_name_t cs;
175  // Additional gpio pins
176  pin_name_t hld;
178  // static variable
179  uint32_t spi_speed;
180  spi_master_mode_t spi_mode;
181  spi_master_chip_select_polarity_t cs_polarity;
183 } eeram3_cfg_t;
184 
189 typedef enum
190 {
192  EERAM3_ERROR = -1
193 
195 
212 
227 err_t eeram3_init ( eeram3_t *ctx, eeram3_cfg_t *cfg );
228 
240 
253 err_t eeram3_write_opcode ( eeram3_t *ctx, uint8_t opcode );
254 
270 err_t eeram3_read_opcode ( eeram3_t *ctx, uint8_t opcode, uint8_t *data_out, uint16_t len );
271 
281 void eeram3_set_hld_pin ( eeram3_t *ctx, uint8_t state );
282 
295 
308 
324 err_t eeram3_set_block_protection ( eeram3_t *ctx, uint8_t block_protect );
325 
338 err_t eeram3_write_status ( eeram3_t *ctx, uint8_t status );
339 
352 err_t eeram3_read_status ( eeram3_t *ctx, uint8_t *status );
353 
366 
376 
392 err_t eeram3_memory_write ( eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint16_t len );
393 
409 err_t eeram3_memory_read ( eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );
410 
426 err_t eeram3_memory_secure_write ( eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len );
427 
443 err_t eeram3_memory_secure_read ( eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len );
444 
457 err_t eeram3_read_last_written_address ( eeram3_t *ctx, uint16_t *address );
458 
472 err_t eeram3_nv_user_space_write ( eeram3_t *ctx, uint16_t data_in );
473 
487 err_t eeram3_nv_user_space_read ( eeram3_t *ctx, uint16_t *data_out );
488 
501 
514 
527 
540 
541 #ifdef __cplusplus
542 }
543 #endif
544 #endif // EERAM3_H
545  // eeram3
547 
548 // ------------------------------------------------------------------------ END
eeram3_cfg_t::mosi
pin_name_t mosi
Definition: eeram3.h:171
eeram3_autostore_enable
err_t eeram3_autostore_enable(eeram3_t *ctx)
EERAM 3 autostore enable function.
eeram3_nv_user_space_read
err_t eeram3_nv_user_space_read(eeram3_t *ctx, uint16_t *data_out)
EERAM 3 nv user space read function.
eeram3_autostore_disable
err_t eeram3_autostore_disable(eeram3_t *ctx)
EERAM 3 autostore disable function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
eeram3_set_hld_pin
void eeram3_set_hld_pin(eeram3_t *ctx, uint8_t state)
EERAM 3 set HLD pin function.
eeram3_enter_hibernate_mode
err_t eeram3_enter_hibernate_mode(eeram3_t *ctx)
EERAM 3 enter hibernate mode function.
eeram3_cfg_t::sck
pin_name_t sck
Definition: eeram3.h:172
eeram3_cfg_t::hld
pin_name_t hld
Definition: eeram3.h:176
EERAM3_OK
@ EERAM3_OK
Definition: eeram3.h:191
eeram3_init
err_t eeram3_init(eeram3_t *ctx, eeram3_cfg_t *cfg)
EERAM 3 initialization function.
eeram3_t
EERAM 3 Click context object.
Definition: eeram3.h:152
eeram3_memory_secure_read
err_t eeram3_memory_secure_read(eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len)
EERAM 3 memory secure read function.
eeram3_memory_write
err_t eeram3_memory_write(eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint16_t len)
EERAM 3 memory write function.
EERAM3_ERROR
@ EERAM3_ERROR
Definition: eeram3.h:192
eeram3_enable_write
err_t eeram3_enable_write(eeram3_t *ctx)
EERAM 3 enable write function.
eeram3_memory_read
err_t eeram3_memory_read(eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len)
EERAM 3 memory read function.
eeram3_cfg_t
EERAM 3 Click configuration object.
Definition: eeram3.h:168
eeram3_cfg_setup
void eeram3_cfg_setup(eeram3_cfg_t *cfg)
EERAM 3 configuration object setup function.
eeram3_recall_data
err_t eeram3_recall_data(eeram3_t *ctx)
EERAM 3 recall data function.
eeram3_wakeup_from_hibernate
void eeram3_wakeup_from_hibernate(eeram3_t *ctx)
EERAM 3 wake up from hibernate function.
eeram3_write_status
err_t eeram3_write_status(eeram3_t *ctx, uint8_t status)
EERAM 3 write status function.
eeram3_disable_write
err_t eeram3_disable_write(eeram3_t *ctx)
EERAM 3 disable write function.
eeram3_default_cfg
void eeram3_default_cfg(eeram3_t *ctx)
EERAM 3 default configuration function.
eeram3_t::spi
spi_master_t spi
Definition: eeram3.h:157
eeram3_cfg_t::miso
pin_name_t miso
Definition: eeram3.h:170
eeram3_memory_secure_write
err_t eeram3_memory_secure_write(eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len)
EERAM 3 memory write function.
eeram3_read_last_written_address
err_t eeram3_read_last_written_address(eeram3_t *ctx, uint16_t *address)
EERAM 3 read last written address function.
eeram3_write_opcode
err_t eeram3_write_opcode(eeram3_t *ctx, uint8_t opcode)
EERAM 3 write opcode function.
eeram3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eeram3.h:181
eeram3_set_block_protection
err_t eeram3_set_block_protection(eeram3_t *ctx, uint8_t block_protect)
EERAM 3 set block protection function.
eeram3_t::hld
digital_out_t hld
Definition: eeram3.h:154
eeram3_read_opcode
err_t eeram3_read_opcode(eeram3_t *ctx, uint8_t opcode, uint8_t *data_out, uint16_t len)
EERAM 3 read opcode function.
eeram3_read_status
err_t eeram3_read_status(eeram3_t *ctx, uint8_t *status)
EERAM 3 read status function.
eeram3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eeram3.h:180
eeram3_t::chip_select
pin_name_t chip_select
Definition: eeram3.h:159
eeram3_return_value_t
eeram3_return_value_t
EERAM 3 Click return value data.
Definition: eeram3.h:190
eeram3_nv_user_space_write
err_t eeram3_nv_user_space_write(eeram3_t *ctx, uint16_t data_in)
EERAM 3 nv user space write function.
eeram3_cfg_t::spi_speed
uint32_t spi_speed
Definition: eeram3.h:179
eeram3_store_data
err_t eeram3_store_data(eeram3_t *ctx)
EERAM 3 store data function.
eeram3_cfg_t::cs
pin_name_t cs
Definition: eeram3.h:173