eeprom7  2.0.0.0
eeprom7.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 EEPROM7_H
29 #define EEPROM7_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_spi_master.h"
52 
73 #define EEPROM7_OPCODE_STATUS_RDSR 0x05
74 #define EEPROM7_OPCODE_STATUS_WRBP 0x08
75 #define EEPROM7_OPCODE_STATUS_WREN 0x06
76 #define EEPROM7_OPCODE_STATUS_WRDI 0x04
77 #define EEPROM7_OPCODE_STATUS_WRSR 0x01
78 
83 #define EEPROM7_OPCODE_EEPROM_SECURITY_READ 0x03
84 #define EEPROM7_OPCODE_EEPROM_SECURITY_WRITE 0x02
85 #define EEPROM7_OPCODE_EEPROM_SECURITY_RDEX 0x83
86 #define EEPROM7_OPCODE_EEPROM_SECURITY_WREX 0x82
87 #define EEPROM7_OPCODE_EEPROM_SECURITY_LOCK 0x82
88 #define EEPROM7_OPCODE_EEPROM_SECURITY_CHLK 0x83
89 
94 #define EEPROM7_OPCODE_MP_REG_RMPR 0x31
95 #define EEPROM7_OPCODE_MP_REG_PRWE 0x07
96 #define EEPROM7_OPCODE_MP_REG_PRWD 0x0A
97 #define EEPROM7_OPCODE_MP_REG_WMPR 0x32
98 #define EEPROM7_OPCODE_MP_REG_PPAB 0x34
99 #define EEPROM7_OPCODE_MP_REG_FRZR 0x37
100 
105 #define EEPROM7_OPCODE_MP_REG_SPID 0x9F
106 
111 #define EEPROM7_OPCODE_SW_RESET_SRST 0x7C
112 
117 #define EEPROM7_SEC_WRITE_DISABLE 0x00
118 #define EEPROM7_SEC_WRITE_ENABLE 0x01
119 
124 #define EEPROM7_PIN_WRITE_PROTECT_DISABLE 0x00
125 #define EEPROM7_PIN_WRITE_PROTECT_ENABLE 0x01
126 #define EEPROM7_PIN_HOLD_PROTECT_DISABLE 0x00
127 #define EEPROM7_PIN_HOLD_PROTECT_ENABLE 0x01
128 
133 #define EEPROM7_STATUS_ERROR 0x00
134 #define EEPROM7_STATUS_SUCCESS 0x01
135 #define EEPROM7_DUMMY 0x00
136 #define EEPROM7_ENABLE_WRITE_DISABLE 0x00
137 #define EEPROM7_ENABLE_WRITE_ENABLE 0x01
138 #define EEPROM7_DEVICE_NOT_READY 0x00
139 #define EEPROM7_DEVICE_IS_READY 0x01
140  // eeprom7_reg
142 
157 #define EEPROM7_MAP_MIKROBUS( cfg, mikrobus ) \
158  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
159  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
160  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
161  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
162  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
163  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_PWM )
164  // eeprom7_map // eeprom7
167 
172 typedef struct
173 {
174  // Output pins
175  digital_out_t wp;
176  digital_out_t hld;
178  // Modules
179  spi_master_t spi;
181  pin_name_t chip_select;
183 } eeprom7_t;
184 
189 typedef struct
190 {
191  // Communication gpio pins
192  pin_name_t miso;
193  pin_name_t mosi;
194  pin_name_t sck;
195  pin_name_t cs;
197  // Additional gpio pins
198  pin_name_t wp;
199  pin_name_t hld;
201  // static variable
202  uint32_t spi_speed;
203  spi_master_mode_t spi_mode;
204  spi_master_chip_select_polarity_t cs_polarity;
206 } eeprom7_cfg_t;
207 
212 typedef enum
213 {
215  EEPROM7_ERROR = -1
216 
218 
235 
250 err_t eeprom7_init ( eeprom7_t *ctx, eeprom7_cfg_t *cfg );
251 
266 
282 err_t eeprom7_generic_write ( eeprom7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
283 
299 err_t eeprom7_generic_read ( eeprom7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
300 
316 err_t eeprom7_generic_write_then_read ( eeprom7_t *ctx, uint8_t *data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out );
317 
329 void eeprom7_enable_write_protect ( eeprom7_t *ctx, uint8_t en_write_protect );
330 
341 void eeprom7_enable_hold_operation ( eeprom7_t *ctx, uint8_t en_hold );
342 
353 void eeprom7_enable_write ( eeprom7_t *ctx, uint8_t en_write );
354 
364 uint16_t eeprom7_read_status ( eeprom7_t *ctx );
365 
378 
393 err_t eeprom7_send_cmd ( eeprom7_t *ctx, uint8_t cmd );
394 
406 
418 void eeprom7_set_status ( eeprom7_t *ctx, uint8_t status );
419 
430 uint8_t eeprom7_get_status ( eeprom7_t *ctx );
431 
445 void eeprom7_write_memory ( eeprom7_t *ctx, uint32_t addr, uint8_t *p_tx_data, uint8_t n_bytes );
446 
460 void eeprom7_read_memory ( eeprom7_t *ctx, uint32_t addr, uint8_t *p_rx_data, uint8_t n_bytes);
476 err_t eeprom7_check_status ( eeprom7_t *ctx, uint8_t check_bit );
477 
478 #ifdef __cplusplus
479 }
480 #endif
481 #endif // EEPROM7_H
482  // eeprom7
484 
485 // ------------------------------------------------------------------------ END
eeprom7_return_value_t
eeprom7_return_value_t
EEPROM 7 Click return value data.
Definition: eeprom7.h:213
eeprom7_generic_write_then_read
err_t eeprom7_generic_write_then_read(eeprom7_t *ctx, uint8_t *data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out)
EEPROM 7 data writing function.
eeprom7_t
EEPROM 7 Click context object.
Definition: eeprom7.h:173
eeprom7_check_status
err_t eeprom7_check_status(eeprom7_t *ctx, uint8_t check_bit)
Status register bits check function.
eeprom7_cfg_t::spi_speed
uint32_t spi_speed
Definition: eeprom7.h:202
eeprom7_read_status
uint16_t eeprom7_read_status(eeprom7_t *ctx)
Read status function.
eeprom7_write_memory
void eeprom7_write_memory(eeprom7_t *ctx, uint32_t addr, uint8_t *p_tx_data, uint8_t n_bytes)
Write EEPROM memory function.
eeprom7_cfg_t::sck
pin_name_t sck
Definition: eeprom7.h:194
eeprom7_send_cmd
err_t eeprom7_send_cmd(eeprom7_t *ctx, uint8_t cmd)
Send command function.
eeprom7_cfg_t::cs
pin_name_t cs
Definition: eeprom7.h:195
EEPROM7_ERROR
@ EEPROM7_ERROR
Definition: eeprom7.h:215
eeprom7_default_cfg
err_t eeprom7_default_cfg(eeprom7_t *ctx)
EEPROM 7 default configuration function.
eeprom7_sw_reset
void eeprom7_sw_reset(eeprom7_t *ctx)
Software device reset function.
eeprom7_init
err_t eeprom7_init(eeprom7_t *ctx, eeprom7_cfg_t *cfg)
EEPROM 7 initialization function.
eeprom7_enable_hold_operation
void eeprom7_enable_hold_operation(eeprom7_t *ctx, uint8_t en_hold)
Enable hold operation function.
eeprom7_generic_read
err_t eeprom7_generic_read(eeprom7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
EEPROM 7 data reading function.
eeprom7_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eeprom7.h:203
eeprom7_cfg_setup
void eeprom7_cfg_setup(eeprom7_cfg_t *cfg)
EEPROM 7 configuration object setup function.
eeprom7_generic_write
err_t eeprom7_generic_write(eeprom7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
EEPROM 7 data writing function.
eeprom7_enable_write
void eeprom7_enable_write(eeprom7_t *ctx, uint8_t en_write)
Enable write function.
eeprom7_cfg_t::wp
pin_name_t wp
Definition: eeprom7.h:198
eeprom7_t::chip_select
pin_name_t chip_select
Definition: eeprom7.h:181
eeprom7_is_device_ready
uint8_t eeprom7_is_device_ready(eeprom7_t *ctx)
Check the device is ready function.
eeprom7_t::spi
spi_master_t spi
Definition: eeprom7.h:179
eeprom7_get_status
uint8_t eeprom7_get_status(eeprom7_t *ctx)
Get status function.
eeprom7_cfg_t::miso
pin_name_t miso
Definition: eeprom7.h:192
eeprom7_read_memory
void eeprom7_read_memory(eeprom7_t *ctx, uint32_t addr, uint8_t *p_rx_data, uint8_t n_bytes)
Read EEPROM memory function.
eeprom7_cfg_t
EEPROM 7 Click configuration object.
Definition: eeprom7.h:190
eeprom7_t::hld
digital_out_t hld
Definition: eeprom7.h:176
EEPROM7_OK
@ EEPROM7_OK
Definition: eeprom7.h:214
eeprom7_enable_write_protect
void eeprom7_enable_write_protect(eeprom7_t *ctx, uint8_t en_write_protect)
Enable write protect function.
eeprom7_cfg_t::hld
pin_name_t hld
Definition: eeprom7.h:199
eeprom7_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eeprom7.h:204
eeprom7_t::wp
digital_out_t wp
Definition: eeprom7.h:175
eeprom7_cfg_t::mosi
pin_name_t mosi
Definition: eeprom7.h:193
eeprom7_set_status
void eeprom7_set_status(eeprom7_t *ctx, uint8_t status)
Set status function.