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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_spi_master.h"
38
59#define EEPROM7_OPCODE_STATUS_RDSR 0x05
60#define EEPROM7_OPCODE_STATUS_WRBP 0x08
61#define EEPROM7_OPCODE_STATUS_WREN 0x06
62#define EEPROM7_OPCODE_STATUS_WRDI 0x04
63#define EEPROM7_OPCODE_STATUS_WRSR 0x01
64
69#define EEPROM7_OPCODE_EEPROM_SECURITY_READ 0x03
70#define EEPROM7_OPCODE_EEPROM_SECURITY_WRITE 0x02
71#define EEPROM7_OPCODE_EEPROM_SECURITY_RDEX 0x83
72#define EEPROM7_OPCODE_EEPROM_SECURITY_WREX 0x82
73#define EEPROM7_OPCODE_EEPROM_SECURITY_LOCK 0x82
74#define EEPROM7_OPCODE_EEPROM_SECURITY_CHLK 0x83
75
80#define EEPROM7_OPCODE_MP_REG_RMPR 0x31
81#define EEPROM7_OPCODE_MP_REG_PRWE 0x07
82#define EEPROM7_OPCODE_MP_REG_PRWD 0x0A
83#define EEPROM7_OPCODE_MP_REG_WMPR 0x32
84#define EEPROM7_OPCODE_MP_REG_PPAB 0x34
85#define EEPROM7_OPCODE_MP_REG_FRZR 0x37
86
91#define EEPROM7_OPCODE_MP_REG_SPID 0x9F
92
97#define EEPROM7_OPCODE_SW_RESET_SRST 0x7C
98
103#define EEPROM7_SEC_WRITE_DISABLE 0x00
104#define EEPROM7_SEC_WRITE_ENABLE 0x01
105
110#define EEPROM7_PIN_WRITE_PROTECT_DISABLE 0x00
111#define EEPROM7_PIN_WRITE_PROTECT_ENABLE 0x01
112#define EEPROM7_PIN_HOLD_PROTECT_DISABLE 0x00
113#define EEPROM7_PIN_HOLD_PROTECT_ENABLE 0x01
114
119#define EEPROM7_STATUS_ERROR 0x00
120#define EEPROM7_STATUS_SUCCESS 0x01
121#define EEPROM7_DUMMY 0x00
122#define EEPROM7_ENABLE_WRITE_DISABLE 0x00
123#define EEPROM7_ENABLE_WRITE_ENABLE 0x01
124#define EEPROM7_DEVICE_NOT_READY 0x00
125#define EEPROM7_DEVICE_IS_READY 0x01
126 // eeprom7_reg
128
143#define EEPROM7_MAP_MIKROBUS( cfg, mikrobus ) \
144 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
145 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
146 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
147 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
148 cfg.wp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
149 cfg.hld = MIKROBUS( mikrobus, MIKROBUS_PWM )
150 // eeprom7_map // eeprom7
153
158typedef struct
159{
160 // Output pins
161 digital_out_t wp;
162 digital_out_t hld;
164 // Modules
165 spi_master_t spi;
167 pin_name_t chip_select;
169} eeprom7_t;
170
175typedef struct
176{
177 // Communication gpio pins
178 pin_name_t miso;
179 pin_name_t mosi;
180 pin_name_t sck;
181 pin_name_t cs;
183 // Additional gpio pins
184 pin_name_t wp;
185 pin_name_t hld;
187 // static variable
188 uint32_t spi_speed;
189 spi_master_mode_t spi_mode;
190 spi_master_chip_select_polarity_t cs_polarity;
193
198typedef enum
199{
201 EEPROM7_ERROR = -1
202
204
221
237
252
268err_t eeprom7_generic_write ( eeprom7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
269
285err_t eeprom7_generic_read ( eeprom7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
286
302err_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 );
303
315void eeprom7_enable_write_protect ( eeprom7_t *ctx, uint8_t en_write_protect );
316
327void eeprom7_enable_hold_operation ( eeprom7_t *ctx, uint8_t en_hold );
328
339void eeprom7_enable_write ( eeprom7_t *ctx, uint8_t en_write );
340
351
364
379err_t eeprom7_send_cmd ( eeprom7_t *ctx, uint8_t cmd );
380
392
404void eeprom7_set_status ( eeprom7_t *ctx, uint8_t status );
405
417
431void eeprom7_write_memory ( eeprom7_t *ctx, uint32_t addr, uint8_t *p_tx_data, uint8_t n_bytes );
432
446void eeprom7_read_memory ( eeprom7_t *ctx, uint32_t addr, uint8_t *p_rx_data, uint8_t n_bytes);
462err_t eeprom7_check_status ( eeprom7_t *ctx, uint8_t check_bit );
463
464#ifdef __cplusplus
465}
466#endif
467#endif // EEPROM7_H
468 // eeprom7
470
471// ------------------------------------------------------------------------ END
eeprom7_return_value_t
EEPROM 7 Click return value data.
Definition: eeprom7.h:199
@ EEPROM7_ERROR
Definition: eeprom7.h:201
@ EEPROM7_OK
Definition: eeprom7.h:200
uint16_t eeprom7_read_status(eeprom7_t *ctx)
Read status function.
void eeprom7_write_memory(eeprom7_t *ctx, uint32_t addr, uint8_t *p_tx_data, uint8_t n_bytes)
Write EEPROM memory function.
void eeprom7_set_status(eeprom7_t *ctx, uint8_t status)
Set status function.
void eeprom7_sw_reset(eeprom7_t *ctx)
Software device reset function.
uint8_t eeprom7_get_status(eeprom7_t *ctx)
Get status function.
err_t eeprom7_init(eeprom7_t *ctx, eeprom7_cfg_t *cfg)
EEPROM 7 initialization function.
void eeprom7_enable_write_protect(eeprom7_t *ctx, uint8_t en_write_protect)
Enable write protect function.
err_t eeprom7_send_cmd(eeprom7_t *ctx, uint8_t cmd)
Send command function.
uint8_t eeprom7_is_device_ready(eeprom7_t *ctx)
Check the device is ready function.
err_t eeprom7_generic_read(eeprom7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
EEPROM 7 data reading function.
void eeprom7_enable_hold_operation(eeprom7_t *ctx, uint8_t en_hold)
Enable hold operation function.
void eeprom7_enable_write(eeprom7_t *ctx, uint8_t en_write)
Enable write function.
err_t eeprom7_default_cfg(eeprom7_t *ctx)
EEPROM 7 default configuration function.
err_t eeprom7_check_status(eeprom7_t *ctx, uint8_t check_bit)
Status register bits check function.
void eeprom7_cfg_setup(eeprom7_cfg_t *cfg)
EEPROM 7 configuration object setup function.
void eeprom7_read_memory(eeprom7_t *ctx, uint32_t addr, uint8_t *p_rx_data, uint8_t n_bytes)
Read EEPROM memory function.
err_t eeprom7_generic_write(eeprom7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
EEPROM 7 data writing function.
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.
EEPROM 7 Click configuration object.
Definition: eeprom7.h:176
pin_name_t hld
Definition: eeprom7.h:185
spi_master_chip_select_polarity_t cs_polarity
Definition: eeprom7.h:190
pin_name_t sck
Definition: eeprom7.h:180
spi_master_mode_t spi_mode
Definition: eeprom7.h:189
pin_name_t mosi
Definition: eeprom7.h:179
uint32_t spi_speed
Definition: eeprom7.h:188
pin_name_t wp
Definition: eeprom7.h:184
pin_name_t miso
Definition: eeprom7.h:178
pin_name_t cs
Definition: eeprom7.h:181
EEPROM 7 Click context object.
Definition: eeprom7.h:159
digital_out_t hld
Definition: eeprom7.h:162
spi_master_t spi
Definition: eeprom7.h:165
pin_name_t chip_select
Definition: eeprom7.h:167
digital_out_t wp
Definition: eeprom7.h:161