eeprom5  2.0.0.0
eeprom5.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 EEPROM5_H
29 #define EEPROM5_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 
59 #define EEPROM5_CMD_WREN 0x06
60 #define EEPROM5_CMD_WRDI 0x04
61 #define EEPROM5_CMD_RDSR 0x05
62 #define EEPROM5_CMD_WRSR 0x01
63 #define EEPROM5_CMD_READ 0x03
64 #define EEPROM5_CMD_WRITE 0x02
65 #define EEPROM5_CMD_READ_ID 0x83
66 #define EEPROM5_CMD_WRITE_ID 0x82
67 #define EEPROM5_CMD_READ_LOCK_STATUS 0x83
68 #define EEPROM5_CMD_LOCK_ID 0x82
69 
74 #define EEPROM5_WRITE_MEMORY_DISABLE 0x00
75 #define EEPROM5_WRITE_MEMORY_ENABLE 0x01
76 
81 #define EEPROM5_IDENT_PAGE_ADDR_START 0x0000
82 #define EEPROM5_IDENT_PAGE_ADDR_END 0x01FF
83 
88 #define EEPROM5_SIGNIFICANT_ADDR_BIT_0 0xFB
89 #define EEPROM5_SIGNIFICANT_ADDR_BIT_1 0x04
90 
95 #define EEPROM5_MEMORY_ADDR_START 0x00000000ul
96 #define EEPROM5_MEMORY_ADDR_END 0x0007FFFFul
97 
102 #define EEPROM5_HOLD_DISABLE 0x00
103 #define EEPROM5_HOLD_ENABLE 0x01
104 
109 #define EEPROM5_WRITE_PROTECT_DISABLE 0x00
110 #define EEPROM5_WRITE_PROTECT_ENABLE 0x01
111 
116 #define EEPROM5_DUMMY 0xFF
117  // eeprom5_set
119 
134 #define EEPROM5_MAP_MIKROBUS( cfg, mikrobus ) \
135  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
136  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
137  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
138  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
139  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_RST ); \
140  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
141  // eeprom5_map // eeprom5
144 
149 typedef struct
150 {
151  // Output pins
152  digital_out_t hld;
153  digital_out_t wp;
155  // Modules
156  spi_master_t spi;
158  pin_name_t chip_select;
160 } eeprom5_t;
161 
166 typedef struct
167 {
168  // Communication gpio pins
169  pin_name_t miso;
170  pin_name_t mosi;
171  pin_name_t sck;
172  pin_name_t cs;
174  // Additional gpio pins
175  pin_name_t hld;
176  pin_name_t wp;
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 } eeprom5_cfg_t;
184 
189 typedef struct
190 {
193  uint8_t block_protect;
194  uint8_t write_protect;
195 
196 } status_data_t;
197 
202 typedef enum
203 {
205  EEPROM5_ERROR = -1
206 
208 
225 
239 err_t eeprom5_init ( eeprom5_t *ctx, eeprom5_cfg_t *cfg );
240 
256 void eeprom5_generic_write ( eeprom5_t *ctx, uint32_t addr, uint8_t tx_data );
257 
273 uint8_t eeprom5_generic_read ( eeprom5_t *ctx, uint32_t addr );
274 
286 void eeprom5_set_hold ( eeprom5_t *ctx, uint8_t en_hold );
287 
299 void eeprom5_set_write_protect ( eeprom5_t *ctx, uint8_t en_wr_prot );
300 
312 void eeprom5_send_cmd ( eeprom5_t *ctx, uint8_t cmd );
313 
325 void eeprom5_enable_memory_write ( eeprom5_t *ctx, uint8_t en_wr_mem );
326 
338 void eeprom5_get_status ( eeprom5_t *ctx, status_data_t *stat_data );
339 
351 void eeprom5_set_status ( eeprom5_t *ctx, status_data_t stat_data );
352 
367 void eeprom5_read_memory ( eeprom5_t *ctx, uint32_t addr, uint8_t *p_rx_data, uint8_t n_bytes );
368 
383 void eeprom5_write_memory ( eeprom5_t *ctx, uint32_t addr, uint8_t *p_tx_data, uint8_t n_bytes );
384 
397 uint8_t eeprom5_read_ident_page ( eeprom5_t *ctx, uint16_t addr );
398 
411 void eeprom5_write_ident_page ( eeprom5_t *ctx, uint16_t addr, uint8_t ident_data );
412 
424 
437 void eeprom5_lock_id ( eeprom5_t *ctx, uint8_t lock_id );
438 
439 #ifdef __cplusplus
440 }
441 #endif
442 #endif // EEPROM5_H
443  // eeprom5
445 
446 // ------------------------------------------------------------------------ END
eeprom5_cfg_t::miso
pin_name_t miso
Definition: eeprom5.h:169
eeprom5_cfg_t::wp
pin_name_t wp
Definition: eeprom5.h:176
status_data_t::block_protect
uint8_t block_protect
Definition: eeprom5.h:193
EEPROM5_ERROR
@ EEPROM5_ERROR
Definition: eeprom5.h:205
eeprom5_t
EEPROM 5 Click context object.
Definition: eeprom5.h:150
eeprom5_cfg_setup
void eeprom5_cfg_setup(eeprom5_cfg_t *cfg)
EEPROM 5 configuration object setup function.
eeprom5_write_ident_page
void eeprom5_write_ident_page(eeprom5_t *ctx, uint16_t addr, uint8_t ident_data)
Write dentification page function.
eeprom5_init
err_t eeprom5_init(eeprom5_t *ctx, eeprom5_cfg_t *cfg)
EEPROM 5 initialization function.
eeprom5_cfg_t::hld
pin_name_t hld
Definition: eeprom5.h:175
eeprom5_send_cmd
void eeprom5_send_cmd(eeprom5_t *ctx, uint8_t cmd)
Send command function.
eeprom5_read_ident_page
uint8_t eeprom5_read_ident_page(eeprom5_t *ctx, uint16_t addr)
Read identification page function.
eeprom5_lock_id
void eeprom5_lock_id(eeprom5_t *ctx, uint8_t lock_id)
Lock ID function.
eeprom5_generic_read
uint8_t eeprom5_generic_read(eeprom5_t *ctx, uint32_t addr)
EEPROM 5 data reading function.
eeprom5_return_value_t
eeprom5_return_value_t
EEPROM 5 Click return value data.
Definition: eeprom5.h:203
eeprom5_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: eeprom5.h:181
eeprom5_t::chip_select
pin_name_t chip_select
Definition: eeprom5.h:158
eeprom5_set_write_protect
void eeprom5_set_write_protect(eeprom5_t *ctx, uint8_t en_wr_prot)
Enable write protect function.
eeprom5_write_memory
void eeprom5_write_memory(eeprom5_t *ctx, uint32_t addr, uint8_t *p_tx_data, uint8_t n_bytes)
Write EEPROM memory function.
EEPROM5_OK
@ EEPROM5_OK
Definition: eeprom5.h:204
eeprom5_set_status
void eeprom5_set_status(eeprom5_t *ctx, status_data_t stat_data)
Set status function.
eeprom5_cfg_t::mosi
pin_name_t mosi
Definition: eeprom5.h:170
status_data_t::write_enable_latch
uint8_t write_enable_latch
Definition: eeprom5.h:192
eeprom5_t::hld
digital_out_t hld
Definition: eeprom5.h:152
eeprom5_cfg_t::spi_speed
uint32_t spi_speed
Definition: eeprom5.h:179
eeprom5_t::spi
spi_master_t spi
Definition: eeprom5.h:156
eeprom5_cfg_t::sck
pin_name_t sck
Definition: eeprom5.h:171
status_data_t
EEPROM 5 Click status data object.
Definition: eeprom5.h:190
eeprom5_cfg_t
EEPROM 5 Click configuration object.
Definition: eeprom5.h:167
eeprom5_cfg_t::cs
pin_name_t cs
Definition: eeprom5.h:172
status_data_t::write_protect
uint8_t write_protect
Definition: eeprom5.h:194
eeprom5_t::wp
digital_out_t wp
Definition: eeprom5.h:153
eeprom5_get_status
void eeprom5_get_status(eeprom5_t *ctx, status_data_t *stat_data)
Get status function.
eeprom5_read_lock_status
uint8_t eeprom5_read_lock_status(eeprom5_t *ctx)
Reads the identification page lock status function.
eeprom5_set_hold
void eeprom5_set_hold(eeprom5_t *ctx, uint8_t en_hold)
Enable hold operation function.
eeprom5_generic_write
void eeprom5_generic_write(eeprom5_t *ctx, uint32_t addr, uint8_t tx_data)
EEPROM 5 data writing function.
status_data_t::write_in_progress
uint8_t write_in_progress
Definition: eeprom5.h:191
eeprom5_read_memory
void eeprom5_read_memory(eeprom5_t *ctx, uint32_t addr, uint8_t *p_rx_data, uint8_t n_bytes)
Read EEPROM memory function.
eeprom5_enable_memory_write
void eeprom5_enable_memory_write(eeprom5_t *ctx, uint8_t en_wr_mem)
Enable memory write function.
eeprom5_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: eeprom5.h:180