sqiflash  2.0.0.0
sqiflash.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 SQIFLASH_H
29 #define SQIFLASH_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_spi_master.h"
48 #include "spi_specifics.h"
49 
70 #define SQIFLASH_STATUS_WEL 0x02
71 #define SQIFLASH_STATUS_WSE 0x04
72 #define SQIFLASH_STATUS_WSP 0x08
73 #define SQIFLASH_STATUS_WPLD 0x10
74 #define SQIFLASH_STATUS_SEC 0x20
75 #define SQIFLASH_STATUS_RES 0x40
76 #define SQIFLASH_STATUS_BUSY 0x80
77 #define SQIFLASH_CFG_RES 0x01
78 #define SQIFLASH_CFG_IOC 0x02
79 #define SQIFLASH_CFG_BPNV 0x08
80 #define SQIFLASH_CFG_WPEN 0x80
81 
86 #define SQIFLASH_INSTR_NOP 0x00
87 #define SQIFLASH_INSTR_RSTEN 0x66
88 #define SQIFLASH_INSTR_RST 0x99
89 #define SQIFLASH_INSTR_EQIO 0x38
90 #define SQIFLASH_INSTR_RSTQIO 0xFF
91 #define SQIFLASH_INSTR_RDSR 0x05
92 #define SQIFLASH_INSTR_WRSR 0x01
93 #define SQIFLASH_INSTR_RDCR 0x35
94 #define SQIFLASH_INSTR_READ 0x03
95 #define SQIFLASH_INSTR_HS_READ 0x0B
96 #define SQIFLASH_INSTR_SQOR 0x6B
97 #define SQIFLASH_INSTR_SQIOR 0xEB
98 #define SQIFLASH_INSTR_SDOR 0x3B
99 #define SQIFLASH_INSTR_SDIOR 0xBB
100 #define SQIFLASH_INSTR_SB 0xC0
101 #define SQIFLASH_INSTR_RBSQI 0x0C
102 #define SQIFLASH_INSTR_RBSPI 0xEC
103 #define SQIFLASH_INSTR_JEDECID 0x9F
104 #define SQIFLASH_INSTR_QUAD_JID 0xAF
105 #define SQIFLASH_INSTR_SFDP 0x5A
106 #define SQIFLASH_INSTR_WREN 0x06
107 #define SQIFLASH_INSTR_WRDI 0x04
108 #define SQIFLASH_INSTR_SE 0x20
109 #define SQIFLASH_INSTR_BE 0xD8
110 #define SQIFLASH_INSTR_CE 0xC7
111 #define SQIFLASH_INSTR_PP 0x02
112 #define SQIFLASH_INSTR_SPI_QUAD 0x32
113 #define SQIFLASH_INSTR_WRSU 0xB0
114 #define SQIFLASH_INSTR_WRRE 0x30
115 #define SQIFLASH_INSTR_RBPR 0x72
116 #define SQIFLASH_INSTR_WBPR 0x42
117 #define SQIFLASH_INSTR_LBPR 0x8D
118 #define SQIFLASH_INSTR_NVWLDR 0xE8
119 #define SQIFLASH_INSTR_ULBPR 0x98
120 #define SQIFLASH_INSTR_RSID 0x88
121 #define SQIFLASH_INSTR_PSID 0xA5
122 #define SQIFLASH_INSTR_LSID 0x85
123 #define SQIFLASH_START_PAGE_ADDRESS 0x010000ul
124 #define SQIFLASH_END_PAGE_ADDRESS 0x7FFFFFul
125 #define SQIFLASH_FLASH_PAGE_SIZE 256
126 
135 #define SQIFLASH_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
136 #define SQIFLASH_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
137  // sqiflash_set
139 
154 #define SQIFLASH_MAP_MIKROBUS( cfg, mikrobus ) \
155  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
156  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
157  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
158  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
159  cfg.sq3 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
160  cfg.sq2 = MIKROBUS( mikrobus, MIKROBUS_PWM )
161  // sqiflash_map // sqiflash
164 
169 typedef struct
170 {
171  // Output pins
172  digital_out_t sq3;
173  digital_out_t sq2;
175  // Modules
176  spi_master_t spi;
178  pin_name_t chip_select;
180 } sqiflash_t;
181 
186 typedef struct
187 {
188  // Communication gpio pins
189  pin_name_t miso;
190  pin_name_t mosi;
191  pin_name_t sck;
192  pin_name_t cs;
194  // Additional gpio pins
195  pin_name_t sq3;
196  pin_name_t sq2;
198  // static variable
199  uint32_t spi_speed;
200  spi_master_mode_t spi_mode;
201  spi_master_chip_select_polarity_t cs_polarity;
204 
209 typedef enum
210 {
212  SQIFLASH_ERROR = -1
213 
215 
232 
246 
260 err_t sqiflash_generic_write ( sqiflash_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
261 
275 err_t sqiflash_generic_read ( sqiflash_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
276 
286 uint8_t sqiflash_busy ( sqiflash_t *ctx );
287 
297 
306 
316 
326 
336 
347 
357 
366 
375 
383 
392 
416 
417 
441 
451 void sqiflash_spi_get_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
452 
462 void sqiflash_sqi_get_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
463 
478 void sqiflash_set_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
479 
490 
502 void sqiflash_spi_get_bpr ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
503 
515 void sqiflash_sqi_get_bpr ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
516 
526 void sqiflash_set_bpr ( sqiflash_t *ctx, uint8_t *buffer );
527 
540 
551 void sqiflash_nonvolatile_write_lock ( sqiflash_t *ctx, uint8_t *buffer );
552 
564 
585 void sqiflash_read_generic ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
586 
601 void sqiflash_highspeed_r_read ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
602 
620 void sqiflash_quad_write ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
621 
637 void sqiflash_write_generic ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
638 
652 
667 void sqiflash_quad_out_read ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
668 
684 void sqiflash_quad_io_read ( sqiflash_t *ctx, uint32_t address, uint8_t mode,
685  uint8_t *buffer, uint32_t data_count );
686 
705 
722 void sqiflash_set_burst ( sqiflash_t *ctx, uint8_t length );
723 
749 void sqiflash_read_sqi_burst_wrap ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
750 
776 void sqiflash_read_spi_burst_wrap ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
777 
790 void sqiflash_read_dual_output ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
791 
827 void sqiflash_read_dual_io ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
828 
839 void sqiflash_sector_erase ( sqiflash_t *ctx, uint32_t address );
840 
853 void sqiflash_block_erase ( sqiflash_t *ctx, uint32_t address );
854 
865 
880 void sqiflash_get_sfdp_params ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
881 
892 
903 
914 
925 
936 
947 
959 
969 void sqiflash_write_status_reg ( sqiflash_t *ctx, uint8_t s_reg );
970 
980 
991 
992 #ifdef __cplusplus
993 }
994 #endif
995 #endif // SQIFLASH_H
996  // sqiflash
998 
999 // ------------------------------------------------------------------------ END
sqiflash_quad_enable
void sqiflash_quad_enable(sqiflash_t *ctx)
SQI FLASH Quad Enable.
sqiflash_program_status
uint8_t sqiflash_program_status(sqiflash_t *ctx)
SQI FLASH Program Status.
sqiflash_read_dual_output
void sqiflash_read_dual_output(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH Read Dual Output.
sqiflash_cfg_t::sck
pin_name_t sck
Definition: sqiflash.h:191
sqiflash_get_sfdp_params
void sqiflash_get_sfdp_params(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH get Serial Flash Discoverable.
sqiflash_erase_status
uint8_t sqiflash_erase_status(sqiflash_t *ctx)
SQI FLASH Erase Status.
sqiflash_security_status
uint8_t sqiflash_security_status(sqiflash_t *ctx)
SQI FLASH Security Status.
sqiflash_cfg_t::mosi
pin_name_t mosi
Definition: sqiflash.h:190
sqiflash_lock_security_id
void sqiflash_lock_security_id(sqiflash_t *ctx)
SQI FLASH Lock Security Status.
sqiflash_write_resume
void sqiflash_write_resume(sqiflash_t *ctx)
SQI FLASH Write Resume.
sqiflash_device_type
uint8_t sqiflash_device_type(sqiflash_t *ctx)
SQI FLASH Device Type.
sqiflash_write_status_reg
void sqiflash_write_status_reg(sqiflash_t *ctx, uint8_t s_reg)
SQI FLASH Write Status Register.
sqiflash_quad_out_read
void sqiflash_quad_out_read(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH Quad Output Read.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
sqiflash_block_erase
void sqiflash_block_erase(sqiflash_t *ctx, uint32_t address)
SQI FLASH Block Erase.
sqiflash_quad_device_id
uint8_t sqiflash_quad_device_id(sqiflash_t *ctx)
SQI FLASH Quad Device ID.
sqiflash_cfg_t::miso
pin_name_t miso
Definition: sqiflash.h:189
sqiflash_set_burst
void sqiflash_set_burst(sqiflash_t *ctx, uint8_t length)
SQI FLASH Set Burst.
sqiflash_chip_erase
void sqiflash_chip_erase(sqiflash_t *ctx)
SQI FLASH Chip Erase.
sqiflash_write_enable
void sqiflash_write_enable(sqiflash_t *ctx)
SQI FLASH Write Enable.
sqiflash_write_status
uint8_t sqiflash_write_status(sqiflash_t *ctx)
SQI FLASH Write Status.
sqiflash_hold_disable
void sqiflash_hold_disable(sqiflash_t *ctx)
SQI FLASH Hold Disable.
sqiflash_t
SQI FLASH Click context object.
Definition: sqiflash.h:170
sqiflash_init
err_t sqiflash_init(sqiflash_t *ctx, sqiflash_cfg_t *cfg)
SQI FLASH initialization function.
sqiflash_read_spi_burst_wrap
void sqiflash_read_spi_burst_wrap(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH Read Burst with Wrap through SPI.
sqiflash_t::sq3
digital_out_t sq3
Definition: sqiflash.h:172
sqiflash_set_security_id
void sqiflash_set_security_id(sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count)
SQI FLASH Set Security ID.
sqiflash_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: sqiflash.h:201
sqiflash_global_block_unlock
void sqiflash_global_block_unlock(sqiflash_t *ctx)
SQI FLASH Global Block Unlock.
sqiflash_cfg_t
SQI FLASH Click configuration object.
Definition: sqiflash.h:187
sqiflash_write_generic
void sqiflash_write_generic(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH Write.
sqiflash_generic_read
err_t sqiflash_generic_read(sqiflash_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
SQI FLASH data reading function.
SQIFLASH_OK
@ SQIFLASH_OK
Definition: sqiflash.h:211
sqiflash_write_protect_enable
void sqiflash_write_protect_enable(sqiflash_t *ctx)
SQI FLASH Write Protect Enable .
sqiflash_cfg_setup
void sqiflash_cfg_setup(sqiflash_cfg_t *cfg)
SQI FLASH configuration object setup function.
sqiflash_device_manufac
uint8_t sqiflash_device_manufac(sqiflash_t *ctx)
SQI FLASH Device Manufacturer.
sqiflash_sqi_get_bpr
void sqiflash_sqi_get_bpr(sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count)
SQI FLASH Get Block Protection Register SQI.
sqiflash_sqi_get_security_id
void sqiflash_sqi_get_security_id(sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count)
SQI FLASH Get Security ID SQI.
sqiflash_read_sqi_burst_wrap
void sqiflash_read_sqi_burst_wrap(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH Read Burst with Wrap through SQI.
sqiflash_hold_enable
void sqiflash_hold_enable(sqiflash_t *ctx)
SQI FLASH Hold Enable.
sqiflash_cfg_t::sq3
pin_name_t sq3
Definition: sqiflash.h:195
sqiflash_write_disable
void sqiflash_write_disable(sqiflash_t *ctx)
SQI FLASH Write Disable.
sqiflash_quad_reset
void sqiflash_quad_reset(sqiflash_t *ctx)
SQI FLASH Quad Reset.
sqiflash_read_generic
void sqiflash_read_generic(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH Read.
sqiflash_quad_device_type
uint8_t sqiflash_quad_device_type(sqiflash_t *ctx)
SQI FLASH Quad Device Type.
sqiflash_sector_erase
void sqiflash_sector_erase(sqiflash_t *ctx, uint32_t address)
SQI FLASH Sector Erase.
sqiflash_t::sq2
digital_out_t sq2
Definition: sqiflash.h:173
sqiflash_device_id
uint8_t sqiflash_device_id(sqiflash_t *ctx)
SQI FLASH Device ID.
sqiflash_quad_io_read
void sqiflash_quad_io_read(sqiflash_t *ctx, uint32_t address, uint8_t mode, uint8_t *buffer, uint32_t data_count)
SQI FLASH Quad I/O Read.
sqiflash_get_config_reg
uint8_t sqiflash_get_config_reg(sqiflash_t *ctx)
SQI FLASH Get Config Register.
sqiflash_generic_write
err_t sqiflash_generic_write(sqiflash_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
SQI FLASH data writing function.
SQIFLASH_ERROR
@ SQIFLASH_ERROR
Definition: sqiflash.h:212
address
uint32_t address
Definition: main.c:35
sqiflash_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: sqiflash.h:200
sqiflash_write_suspend
void sqiflash_write_suspend(sqiflash_t *ctx)
SQI FLASH Write Suspend.
sqiflash_t::chip_select
pin_name_t chip_select
Definition: sqiflash.h:178
sqiflash_get_status_reg
uint8_t sqiflash_get_status_reg(sqiflash_t *ctx)
SQI FLASH Get Status Register.
sqiflash_lock_bpr
void sqiflash_lock_bpr(sqiflash_t *ctx)
SQI FLASH Lock Block Protection Register.
sqiflash_cfg_t::sq2
pin_name_t sq2
Definition: sqiflash.h:196
sqiflash_cfg_t::cs
pin_name_t cs
Definition: sqiflash.h:192
sqiflash_spi_get_security_id
void sqiflash_spi_get_security_id(sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count)
SQI FLASH Get Security ID SPI.
sqiflash_protect_status
uint8_t sqiflash_protect_status(sqiflash_t *ctx)
SQI FLASH Protect Status.
sqiflash_quad_write
void sqiflash_quad_write(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH Quad Write.
sqiflash_write_protect_disable
void sqiflash_write_protect_disable(sqiflash_t *ctx)
SQI FLASH Write Protect Disable.
sqiflash_cfg_t::spi_speed
uint32_t spi_speed
Definition: sqiflash.h:199
sqiflash_quad_device_manufac
uint8_t sqiflash_quad_device_manufac(sqiflash_t *ctx)
SQI FLASH Quad Device Manufacturer.
sqiflash_highspeed_r_read
void sqiflash_highspeed_r_read(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH High Speed Read.
sqiflash_t::spi
spi_master_t spi
Definition: sqiflash.h:176
sqiflash_busy
uint8_t sqiflash_busy(sqiflash_t *ctx)
SQI FLASH Busy.
sqiflash_return_value_t
sqiflash_return_value_t
SQI FLASH Click return value data.
Definition: sqiflash.h:210
sqiflash_set_bpr
void sqiflash_set_bpr(sqiflash_t *ctx, uint8_t *buffer)
SQI FLASH Set Block Protection Register.
sqiflash_spi_get_bpr
void sqiflash_spi_get_bpr(sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count)
SQI FLASH Get Block Protection Register SPI.
sqiflash_read_dual_io
void sqiflash_read_dual_io(sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
SQI FLASH Read Dual I/O.
sqiflash_nonvolatile_write_lock
void sqiflash_nonvolatile_write_lock(sqiflash_t *ctx, uint8_t *buffer)
SQI FLASH Non-Volatile Write-Lock.
sqiflash_reset
void sqiflash_reset(sqiflash_t *ctx)
SQI FLASH Reset.