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 "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_spi_master.h"
48 #include "spi_specifics.h"
49 
70 #define EERAM3_OPCODE_WREN 0x06
71 #define EERAM3_OPCODE_WRDI 0x04
72 #define EERAM3_OPCODE_WRITE 0x02
73 #define EERAM3_OPCODE_READ 0x03
74 #define EERAM3_OPCODE_RDLSWA 0x0A
75 #define EERAM3_OPCODE_SECURE_WRITE 0x12
76 #define EERAM3_OPCODE_SECURE_READ 0x13
77 #define EERAM3_OPCODE_WRSR 0x01
78 #define EERAM3_OPCODE_RDSR 0x05
79 #define EERAM3_OPCODE_STORE 0x08
80 #define EERAM3_OPCODE_RECALL 0x09
81 #define EERAM3_OPCODE_WRNUR 0xC2
82 #define EERAM3_OPCODE_RDNUR 0xC3
83 #define EERAM3_OPCODE_HIBERNATE 0xB9
84  // eeram3_reg
86 
101 #define EERAM3_RDY_BIT_MASK 0x01
102 #define EERAM3_WEL_BIT_MASK 0x02
103 #define EERAM3_BLOCK_PROTECT_BITS_MASK 0x0C
104 #define EERAM3_BLOCK_PROTECT_NONE 0x00
105 #define EERAM3_BLOCK_PROTECT_UPPER_QUARTER 0x04
106 #define EERAM3_BLOCK_PROTECT_UPPER_HALF 0x08
107 #define EERAM3_BLOCK_PROTECT_ALL 0x0C
108 #define EERAM3_SWM_BIT_MASK 0x10
109 #define EERAM3_PRO_BIT_MASK 0x20
110 #define EERAM3_ASE_BIT_MASK 0x40
111 
116 #define EERAM3_MIN_ADDRESS 0x0000
117 #define EERAM3_MAX_ADDRESS 0x7FFF
118 #define EERAM3_MAX_PAGE_ADDRESS 0x3F
119 
128 #define EERAM3_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
129 #define EERAM3_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
130  // eeram3_set
132 
147 #define EERAM3_MAP_MIKROBUS( cfg, mikrobus ) \
148  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
149  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
150  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
151  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
152  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_INT )
153  // eeram3_map // eeram3
156 
161 typedef struct
162 {
163  // Output pins
164  digital_out_t hld;
166  // Modules
167  spi_master_t spi;
169  pin_name_t chip_select;
171 } eeram3_t;
172 
177 typedef struct
178 {
179  // Communication gpio pins
180  pin_name_t miso;
181  pin_name_t mosi;
182  pin_name_t sck;
183  pin_name_t cs;
185  // Additional gpio pins
186  pin_name_t hld;
188  // static variable
189  uint32_t spi_speed;
190  spi_master_mode_t spi_mode;
191  spi_master_chip_select_polarity_t cs_polarity;
193 } eeram3_cfg_t;
194 
199 typedef enum
200 {
202  EERAM3_ERROR = -1
203 
205 
222 
237 err_t eeram3_init ( eeram3_t *ctx, eeram3_cfg_t *cfg );
238 
250 
263 err_t eeram3_write_opcode ( eeram3_t *ctx, uint8_t opcode );
264 
280 err_t eeram3_read_opcode ( eeram3_t *ctx, uint8_t opcode, uint8_t *data_out, uint8_t len );
281 
291 void eeram3_set_hld_pin ( eeram3_t *ctx, uint8_t state );
292 
305 
318 
334 err_t eeram3_set_block_protection ( eeram3_t *ctx, uint8_t block_protect );
335 
348 err_t eeram3_write_status ( eeram3_t *ctx, uint8_t status );
349 
362 err_t eeram3_read_status ( eeram3_t *ctx, uint8_t *status );
363 
376 
386 
402 err_t eeram3_memory_write ( eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint16_t len );
403 
419 err_t eeram3_memory_read ( eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );
420 
436 err_t eeram3_memory_secure_write ( eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len );
437 
453 err_t eeram3_memory_secure_read ( eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len );
454 
467 err_t eeram3_read_last_written_address ( eeram3_t *ctx, uint16_t *address );
468 
482 err_t eeram3_nv_user_space_write ( eeram3_t *ctx, uint16_t data_in );
483 
497 err_t eeram3_nv_user_space_read ( eeram3_t *ctx, uint16_t *data_out );
498 
511 
524 
537 
550 
551 #ifdef __cplusplus
552 }
553 #endif
554 #endif // EERAM3_H
555  // eeram3
557 
558 // ------------------------------------------------------------------------ END
eeram3_cfg_t::mosi
pin_name_t mosi
Definition: eeram3.h:181
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_read_opcode
err_t eeram3_read_opcode(eeram3_t *ctx, uint8_t opcode, uint8_t *data_out, uint8_t len)
EERAM 3 read opcode function.
eeram3_cfg_t::sck
pin_name_t sck
Definition: eeram3.h:182
eeram3_cfg_t::hld
pin_name_t hld
Definition: eeram3.h:186
EERAM3_OK
@ EERAM3_OK
Definition: eeram3.h:201
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:162
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:202
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:178
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:167
eeram3_cfg_t::miso
pin_name_t miso
Definition: eeram3.h:180
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:191
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:164
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:190
eeram3_t::chip_select
pin_name_t chip_select
Definition: eeram3.h:169
eeram3_return_value_t
eeram3_return_value_t
EERAM 3 Click return value data.
Definition: eeram3.h:200
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:189
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:183