semperflash  2.0.0.0
semperflash.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 SEMPERFLASH_H
36 #define SEMPERFLASH_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define SEMPERFLASH_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.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
59  cfg.io2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
60  cfg.io3 = MIKROBUS( mikrobus, MIKROBUS_INT )
61 
67 #define SEMPERFLASH_RETVAL uint8_t
68 
69 #define SEMPERFLASH_OK 0x00
70 #define SEMPERFLASH_INIT_ERROR 0xFF
71 
77 #define SEMPERFLASH_MANUFACTURER_DEVICE_ID 0x9F
78 #define SEMPERFLASH_JEDEC_SERIAL_FLASH_DISCOVER_PARAMS 0x5A
79 #define SEMPERFLASH_DEVICE_ID 0x4C
80 #define SEMPERFLASH_READ_STATUS_REG_1 0x05
81 #define SEMPERFLASH_READ_STATUS_REG_2 0x07
82 #define SEMPERFLASH_READ_CFG_REG_1 0x35
83 #define SEMPERFLASH_READ_ANY_REG 0x65
84 #define SEMPERFLASH_WRITE_ENABLE 0x06
85 #define SEMPERFLASH_WRITE_ENABLE_VOLATILE 0x50
86 #define SEMPERFLASH_WRITE_DISABLE 0x04
87 #define SEMPERFLASH_WRITE_REG 0x01
88 #define SEMPERFLASH_WRITE_ANY_REG 0x71
89 #define SEMPERFLASH_CLEAR_PROGRAM_ERASE_ERROR 0x30
90 #define SEMPERFLASH_ENTER_4_BYTE_ADDR_MODE 0xB7
91 #define SEMPERFLASH_EXIT_4_BYTE_ADDR_MODE 0xB8
92 #define SEMPERFLASH_READ_DATA_LEARN_PATT_REG 0x41
93 #define SEMPERFLASH_PROGRAM_DATA_LEARN_PATT 0x43
94 #define SEMPERFLASH_WRITE_DATA_LEARN_PATT 0x4A
95 #define SEMPERFLASH_AUTOBOOT_REG_WRITE 0x15
96 #define SEMPERFLASH_READ_ECC_STATUS 0x19
97 #define SEMPERFLASH_CLEAR_ECC_STATUS 0x1B
98 #define SEMPERFLASH_DATA_INT_CHECK 0x5B
99 #define SEMPERFLASH_READ_0 0x03
100 #define SEMPERFLASH_READ_1 0x13
101 #define SEMPERFLASH_FAST_READ_0 0x0B
102 #define SEMPERFLASH_FAST_READ_1 0x0C
103 #define SEMPERFLASH_PROGRAM_PAGE_0 0x02
104 #define SEMPERFLASH_PROGRAM_PAGE_1 0x12
105 #define SEMPERFLASH_ERASE_4K_0 0x20
106 #define SEMPERFLASH_ERASE_4K_1 0x21
107 #define SEMPERFLASH_ERASE_256K_1 0xD8
108 #define SEMPERFLASH_ERASE_256K_2 0xDC
109 #define SEMPERFLASH_ERASE_CHIP_1 0x60
110 #define SEMPERFLASH_ERASE_CHIP_2 0xC7
111 #define SEMPERFLASH_ERASE_STATUS 0xD0
112 #define SEMPERFLASH_ERASE_CNT 0x5D
113 #define SEMPERFLASH_SUSPEND_ERASE_PROG_DATA_CHECK 0x75
114 #define SEMPERFLASH_SUSPEND_ERASE_PROG 0x85
115 #define SEMPERFLASH_RESUME_ERASE_PROG_DATA_CHECK 0x7A
116 #define SEMPERFLASH_RESUME_ERASE_PROG 0x8A
117 #define SEMPERFLASH_PROG_SECURE_SILICON_REGION 0x42
118 #define SEMPERFLASH_READ_SECURE_SILICON_REGION 0x4B
119 #define SEMPERFLASH_ASP_PROG 0x2F
120 #define SEMPERFLASH_READ_DYNAMIC_PROTECION_BIT 0xFA
121 #define SEMPERFLASH_WRITE_DYNAMIC_PROTECION_BIT 0xFB
122 #define SEMPERFLASH_READ_PRESISTENT_PROTECTION_BIT 0xFC
123 #define SEMPERFLASH_PROG_PRESISTENT_PROTECTION_BIT 0xFD
124 #define SEMPERFLASH_ERASE_PRESISTENT_PROTECTION_BIT 0xE4
125 #define SEMPERFLASH_WRITE_PPB_PROTECTION_LOCK_BIT 0xA6
126 #define SEMPERFLASH_READ_PROG_PRESISTENT_PROTECION_LOCK_BIT 0xA7
127 #define SEMPERFLASH_PROG_PASSWORD 0xE8
128 #define SEMPERFLASH_PASSWORD_UNLOCK 0xE9
129 #define SEMPERFLASH_SOFT_RESET_ENABLE 0x66
130 #define SEMPERFLASH_SOFT_RESET 0x99
131 #define SEMPERFLASH_LEGACY_SOFT_RESET 0xF0
132 #define SEMPERFLASH_ENTER_DEEP_POWER_DOWN_MODE 0xB9
133 
134 #define SEMPERFLASH_PIN_STATE_HIGH 1
135 #define SEMPERFLASH_PIN_STATE_LOW 0
136 
137 #define SEMPERFLASH_ID_ERROR 0xCC
138 #define SEMPERFLASH_SIZE_ERROR 0xBB
139 #define SEMPERFLASH_SUCCESS 0xAA
140 
141 #define SEMPERFLASH_MANUFACTURER_DEVICE_ID_VALUE 0x34
142 #define SEMPERFLASH_DEVICE_ID_BYTE_SIZE 8
143 
144 #define SEMPERFLASH_STATUS_REG_1_DEFAULT 0x00
145 #define SEMPERFLASH_STATUS_REG_1_PROGRAM_ERASE_REG_WRITE_ENABLE 0x02
146 #define SEMPERFLASH_STATUS_REG_1_DEVICE_BUSY 0x01
147 #define SEMPERFLASH_CFG_1_DEFAULT 0x00
148 #define SEMPERFLASH_CFG_2_DEFAULT 0x00
149 #define SEMPERFLASH_CFG_3_DEFAULT 0x00
150 #define SEMPERFLASH_CFG_4_DEFAULT 0x00
151 
152 #define SEMPERFLASH_MANUFACTURER_DEVICE_ID_VALUE 0x34
153 #define SEMPERFLASH_MEMORY_BUF_MAX_SIZE 512
154  // End group macro
157 // --------------------------------------------------------------- PUBLIC TYPES
166 typedef struct
167 {
168  // Output pins
169 
170  digital_out_t rst;
171  digital_out_t io2;
172  digital_out_t io3;
173  digital_out_t cs;
174 
175  // Modules
176 
177  spi_master_t spi;
178  pin_name_t chip_select;
179 
180 } semperflash_t;
181 
185 typedef struct
186 {
187  // Communication gpio pins
188 
189  pin_name_t miso;
190  pin_name_t mosi;
191  pin_name_t sck;
192  pin_name_t cs;
193 
194  // Additional gpio pins
195 
196  pin_name_t rst;
197  pin_name_t io2;
198  pin_name_t io3;
199 
200  // static variable
201 
202  uint32_t spi_speed;
203  uint8_t spi_mode;
204  spi_master_chip_select_polarity_t cs_polarity;
205 
207 
211 typedef struct
212 {
213  uint8_t status_reg1;
214  uint8_t cfg1;
215  uint8_t cfg2;
216  uint8_t cfg3;
217  uint8_t cfg4;
218 
220 
221  // End types group
223 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
224 
229 #ifdef __cplusplus
230 extern "C"{
231 #endif
232 
242 
251 
260 
269 void semperflash_send_cmd ( semperflash_t *ctx, uint8_t cmd );
270 
283 (
284  semperflash_t *ctx,
285  uint8_t *write_buf,
286  uint16_t wbuf_size,
287  uint8_t *read_buf,
288  uint16_t rbuf_size
289 );
290 
301 (
302  semperflash_t *ctx,
303  uint8_t *write_buf,
304  uint16_t buf_size
305 );
306 
316 
328 (
329  semperflash_t *ctx,
330  uint32_t addr,
331  uint8_t *data_buf,
332  uint16_t buf_size
333 );
334 
346 (
347  semperflash_t *ctx,
348  uint32_t addr,
349  uint8_t *data_buf,
350  uint16_t buf_size
351 );
352 
361 void semperflash_erase_memory ( semperflash_t *ctx, uint32_t addr );
362 
371 uint8_t semperflash_get_device_id ( semperflash_t *ctx, uint8_t *id_buf );
372 
381 
390 
391 #ifdef __cplusplus
392 }
393 #endif
394 #endif // _SEMPERFLASH_H_
395  // End public_function group
398 
399 // ------------------------------------------------------------------------- END
semperflash_send_cmd
void semperflash_send_cmd(semperflash_t *ctx, uint8_t cmd)
Send command function.
semperflash_read_memory
uint8_t semperflash_read_memory(semperflash_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size)
Read memory function.
semperflash_config_t::cfg3
uint8_t cfg3
Definition: semperflash.h:216
semperflash_check_status_reg_1
uint8_t semperflash_check_status_reg_1(semperflash_t *ctx)
Check status register function.
semperflash_get_device_id
uint8_t semperflash_get_device_id(semperflash_t *ctx, uint8_t *id_buf)
Get device ID function.
semperflash_cfg_t::cs
pin_name_t cs
Definition: semperflash.h:192
semperflash_t::spi
spi_master_t spi
Definition: semperflash.h:177
semperflash_write_memory
uint8_t semperflash_write_memory(semperflash_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size)
Write memory function.
semperflash_cfg_setup
void semperflash_cfg_setup(semperflash_cfg_t *cfg)
Config Object Initialization function.
semperflash_erase_memory
void semperflash_erase_memory(semperflash_t *ctx, uint32_t addr)
Erase memory function.
semperflash_init
SEMPERFLASH_RETVAL semperflash_init(semperflash_t *ctx, semperflash_cfg_t *cfg)
Initialization function.
semperflash_cfg_t
Click configuration structure definition.
Definition: semperflash.h:185
semperflash_config_t
Flash configuration structure.
Definition: semperflash.h:211
semperflash_default_cfg
void semperflash_default_cfg(semperflash_t *ctx)
Click Default Configuration function.
semperflash_config_t::cfg2
uint8_t cfg2
Definition: semperflash.h:215
semperflash_cfg_t::io2
pin_name_t io2
Definition: semperflash.h:197
semperflash_cfg_t::rst
pin_name_t rst
Definition: semperflash.h:196
semperflash_t::chip_select
pin_name_t chip_select
Definition: semperflash.h:178
semperflash_t::rst
digital_out_t rst
Definition: semperflash.h:170
SEMPERFLASH_RETVAL
#define SEMPERFLASH_RETVAL
Definition: semperflash.h:67
semperflash_transfer_data
void semperflash_transfer_data(semperflash_t *ctx, uint8_t *write_buf, uint16_t wbuf_size, uint8_t *read_buf, uint16_t rbuf_size)
Transfer data function.
semperflash_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: semperflash.h:204
semperflash_t
Click ctx object definition.
Definition: semperflash.h:166
semperflash_cfg_t::io3
pin_name_t io3
Definition: semperflash.h:198
semperflash_check_manufacturer_id
uint8_t semperflash_check_manufacturer_id(semperflash_t *ctx)
Check manufacturer ID function.
semperflash_t::io3
digital_out_t io3
Definition: semperflash.h:172
semperflash_cfg_t::spi_speed
uint32_t spi_speed
Definition: semperflash.h:202
semperflash_config_t::status_reg1
uint8_t status_reg1
Definition: semperflash.h:213
semperflash_config_t::cfg1
uint8_t cfg1
Definition: semperflash.h:214
semperflash_config_t::cfg4
uint8_t cfg4
Definition: semperflash.h:217
semperflash_cfg_t::spi_mode
uint8_t spi_mode
Definition: semperflash.h:203
semperflash_cfg_t::sck
pin_name_t sck
Definition: semperflash.h:191
semperflash_cfg_t::miso
pin_name_t miso
Definition: semperflash.h:189
semperflash_write_config
void semperflash_write_config(semperflash_t *ctx, semperflash_config_t *cfg_data)
Write configuration function.
semperflash_cfg_t::mosi
pin_name_t mosi
Definition: semperflash.h:190
semperflash_generic_write
void semperflash_generic_write(semperflash_t *ctx, uint8_t *write_buf, uint16_t buf_size)
Writing data function.
semperflash_t::io2
digital_out_t io2
Definition: semperflash.h:171
semperflash_t::cs
digital_out_t cs
Definition: semperflash.h:173