eeprom4 2.0.0.0
eeprom4.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
33// ----------------------------------------------------------------------------
34
35#ifndef EEPROM4_H
36#define EEPROM4_H
37
38#include "drv_digital_out.h"
39#include "drv_spi_master.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
42
53#define EEPROM4_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58 cfg.wp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
59 cfg.hld = MIKROBUS( mikrobus, MIKROBUS_PWM )
66#define EEPROM4_RETVAL uint8_t
68#define EEPROM4_OK 0x00
69#define EEPROM4_INIT_ERROR 0xFF
76#define EEPROM4_LOGIC_HIGH 1
77#define EEPROM4_LOGIC_LOW 0
84#define EEPROM4_READY_BIT 0x01
85#define EEPROM4_WRITE_ENABLE_LATCH_BIT 0x02
86#define EEPROM4_WRITE_PROTECT_ENABLE_BIT 0x80
93#define EEPROM4_LOW_POWER_WRITE_POLL_COMMAND 0x08
94#define EEPROM4_SET_WRITE_ENABLE_LATCH_COMMAND 0x06
95#define EEPROM4_RESET_WRITE_ENABLE_LATCH_COMMAND 0x04
102#define EEPROM4_FIRST_MEMORY_LOCATION 0x00000000
103#define EEPROM4_ONE_QUARTER_MEMORY_LOCATION 0x0000FFFF
104#define EEPROM4_HALF_MEMORY_LOCATION 0x0001FFFF
105#define EEPROM4_TWO_QUARTER_MEMORY_LOCATION 0x0002FFFF
106#define EEPROM4_LAST_MEMORY_LOCATION 0x0003FFFF
113#define EEPROM4_NONE_PROTECTED_MEMORY_LOCATION 0x00
114#define EEPROM4_ONE_QUARTER_PROTECTED_MEMORY_LOCATION 0x04
115#define EEPROM4_HALF_PROTECTED_MEMORY_LOCATION 0x08
116#define EEPROM4_ALL_PROTECTED_MEMORY_LOCATION 0x0C // End group macro
120// --------------------------------------------------------------- PUBLIC TYPES
129typedef struct
130{
131 // Output pins
132
133 digital_out_t cs;
134 digital_out_t wp;
135 digital_out_t hld;
136
137 // Modules
138
139 spi_master_t spi;
140 pin_name_t chip_select;
141
142} eeprom4_t;
143
147typedef struct
148{
149 // Communication gpio pins
150
151 pin_name_t miso;
152 pin_name_t mosi;
153 pin_name_t sck;
154 pin_name_t cs;
155
156 // Additional gpio pins
157
158 pin_name_t wp;
159 pin_name_t hld;
160
161 // static variable
162
163 uint32_t spi_speed;
164 spi_master_mode_t spi_mode;
165 spi_master_chip_select_polarity_t cs_polarity;
166
168 // End types group
170// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
171
176#ifdef __cplusplus
177extern "C"{
178#endif
179
189
199
208
220void eeprom4_generic_transfer ( eeprom4_t *ctx, uint8_t *wr_buf,
221 uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
222
234uint8_t eeprom4_send_command ( eeprom4_t *ctx, uint8_t command_byte );
235
245void eeprom4_write_status_reg ( eeprom4_t *ctx, uint8_t data_value );
246
255
267void eeprom4_write_memory ( eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_input, uint8_t n_bytes );
268
280void eeprom4_read_memory ( eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_output, uint8_t n_bytes );
281
292void eeprom4_enable_write_protect ( eeprom4_t *ctx, uint8_t state );
293
303void eeprom4_enable_hold_operation ( eeprom4_t *ctx, uint8_t state );
304
313uint8_t eeprom4_check_status_reg ( eeprom4_t *ctx, uint8_t check_bit );
314
315
316#ifdef __cplusplus
317}
318#endif
319#endif // _EEPROM4_H_
320 // End public_function group
323
324// ------------------------------------------------------------------------- END
#define EEPROM4_RETVAL
Definition: eeprom4.h:66
void eeprom4_enable_write_protect(eeprom4_t *ctx, uint8_t state)
Write Protect enable function.
void eeprom4_read_memory(eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_output, uint8_t n_bytes)
Memory array read function.
void eeprom4_default_cfg(eeprom4_t *ctx)
Click Default Configuration function.
void eeprom4_write_status_reg(eeprom4_t *ctx, uint8_t data_value)
Status register write function.
void eeprom4_generic_transfer(eeprom4_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
uint8_t eeprom4_check_status_reg(eeprom4_t *ctx, uint8_t check_bit)
Status register bits check function.
void eeprom4_cfg_setup(eeprom4_cfg_t *cfg)
Config Object Initialization function.
void eeprom4_write_memory(eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_input, uint8_t n_bytes)
Memory array write function.
uint8_t eeprom4_read_status_reg(eeprom4_t *ctx)
Status register read function.
uint8_t eeprom4_send_command(eeprom4_t *ctx, uint8_t command_byte)
Command send function.
EEPROM4_RETVAL eeprom4_init(eeprom4_t *ctx, eeprom4_cfg_t *cfg)
Initialization function.
void eeprom4_enable_hold_operation(eeprom4_t *ctx, uint8_t state)
Hold operation enable function.
Click configuration structure definition.
Definition: eeprom4.h:148
pin_name_t hld
Definition: eeprom4.h:159
spi_master_chip_select_polarity_t cs_polarity
Definition: eeprom4.h:165
pin_name_t sck
Definition: eeprom4.h:153
spi_master_mode_t spi_mode
Definition: eeprom4.h:164
pin_name_t mosi
Definition: eeprom4.h:152
uint32_t spi_speed
Definition: eeprom4.h:163
pin_name_t wp
Definition: eeprom4.h:158
pin_name_t miso
Definition: eeprom4.h:151
pin_name_t cs
Definition: eeprom4.h:154
Click ctx object definition.
Definition: eeprom4.h:130
digital_out_t cs
Definition: eeprom4.h:133
digital_out_t hld
Definition: eeprom4.h:135
spi_master_t spi
Definition: eeprom4.h:139
pin_name_t chip_select
Definition: eeprom4.h:140
digital_out_t wp
Definition: eeprom4.h:134