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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define SQIFLASH_STATUS_WEL 0x02
61 #define SQIFLASH_STATUS_WSE 0x04
62 #define SQIFLASH_STATUS_WSP 0x08
63 #define SQIFLASH_STATUS_WPLD 0x10
64 #define SQIFLASH_STATUS_SEC 0x20
65 #define SQIFLASH_STATUS_RES 0x40
66 #define SQIFLASH_STATUS_BUSY 0x80
67 #define SQIFLASH_CFG_RES 0x01
68 #define SQIFLASH_CFG_IOC 0x02
69 #define SQIFLASH_CFG_BPNV 0x08
70 #define SQIFLASH_CFG_WPEN 0x80
71 
76 #define SQIFLASH_INSTR_NOP 0x00
77 #define SQIFLASH_INSTR_RSTEN 0x66
78 #define SQIFLASH_INSTR_RST 0x99
79 #define SQIFLASH_INSTR_EQIO 0x38
80 #define SQIFLASH_INSTR_RSTQIO 0xFF
81 #define SQIFLASH_INSTR_RDSR 0x05
82 #define SQIFLASH_INSTR_WRSR 0x01
83 #define SQIFLASH_INSTR_RDCR 0x35
84 #define SQIFLASH_INSTR_READ 0x03
85 #define SQIFLASH_INSTR_HS_READ 0x0B
86 #define SQIFLASH_INSTR_SQOR 0x6B
87 #define SQIFLASH_INSTR_SQIOR 0xEB
88 #define SQIFLASH_INSTR_SDOR 0x3B
89 #define SQIFLASH_INSTR_SDIOR 0xBB
90 #define SQIFLASH_INSTR_SB 0xC0
91 #define SQIFLASH_INSTR_RBSQI 0x0C
92 #define SQIFLASH_INSTR_RBSPI 0xEC
93 #define SQIFLASH_INSTR_JEDECID 0x9F
94 #define SQIFLASH_INSTR_QUAD_JID 0xAF
95 #define SQIFLASH_INSTR_SFDP 0x5A
96 #define SQIFLASH_INSTR_WREN 0x06
97 #define SQIFLASH_INSTR_WRDI 0x04
98 #define SQIFLASH_INSTR_SE 0x20
99 #define SQIFLASH_INSTR_BE 0xD8
100 #define SQIFLASH_INSTR_CE 0xC7
101 #define SQIFLASH_INSTR_PP 0x02
102 #define SQIFLASH_INSTR_SPI_QUAD 0x32
103 #define SQIFLASH_INSTR_WRSU 0xB0
104 #define SQIFLASH_INSTR_WRRE 0x30
105 #define SQIFLASH_INSTR_RBPR 0x72
106 #define SQIFLASH_INSTR_WBPR 0x42
107 #define SQIFLASH_INSTR_LBPR 0x8D
108 #define SQIFLASH_INSTR_NVWLDR 0xE8
109 #define SQIFLASH_INSTR_ULBPR 0x98
110 #define SQIFLASH_INSTR_RSID 0x88
111 #define SQIFLASH_INSTR_PSID 0xA5
112 #define SQIFLASH_INSTR_LSID 0x85
113 #define SQIFLASH_START_PAGE_ADDRESS 0x010000ul
114 #define SQIFLASH_END_PAGE_ADDRESS 0x7FFFFFul
115 #define SQIFLASH_FLASH_PAGE_SIZE 256
116 
125 #define SQIFLASH_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
126 #define SQIFLASH_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
127  // sqiflash_set
129 
144 #define SQIFLASH_MAP_MIKROBUS( cfg, mikrobus ) \
145  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
146  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
147  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
148  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
149  cfg.sq3 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
150  cfg.sq2 = MIKROBUS( mikrobus, MIKROBUS_PWM )
151  // sqiflash_map // sqiflash
154 
159 typedef struct
160 {
161  // Output pins
162  digital_out_t sq3;
163  digital_out_t sq2;
165  // Modules
166  spi_master_t spi;
168  pin_name_t chip_select;
170 } sqiflash_t;
171 
176 typedef struct
177 {
178  // Communication gpio pins
179  pin_name_t miso;
180  pin_name_t mosi;
181  pin_name_t sck;
182  pin_name_t cs;
184  // Additional gpio pins
185  pin_name_t sq3;
186  pin_name_t sq2;
188  // static variable
189  uint32_t spi_speed;
190  spi_master_mode_t spi_mode;
191  spi_master_chip_select_polarity_t cs_polarity;
194 
199 typedef enum
200 {
202  SQIFLASH_ERROR = -1
203 
205 
222 
236 
250 err_t sqiflash_generic_write ( sqiflash_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
251 
265 err_t sqiflash_generic_read ( sqiflash_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
266 
276 uint8_t sqiflash_busy ( sqiflash_t *ctx );
277 
287 
296 
306 
316 
326 
337 
347 
356 
365 
373 
382 
406 
407 
431 
441 void sqiflash_spi_get_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
442 
452 void sqiflash_sqi_get_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
453 
468 void sqiflash_set_security_id ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
469 
480 
492 void sqiflash_spi_get_bpr ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
493 
505 void sqiflash_sqi_get_bpr ( sqiflash_t *ctx, uint8_t *buffer, uint32_t data_count );
506 
516 void sqiflash_set_bpr ( sqiflash_t *ctx, uint8_t *buffer );
517 
530 
541 void sqiflash_nonvolatile_write_lock ( sqiflash_t *ctx, uint8_t *buffer );
542 
554 
575 void sqiflash_read_generic ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
576 
591 void sqiflash_highspeed_r_read ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
592 
610 void sqiflash_quad_write ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
611 
627 void sqiflash_write_generic ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
628 
642 
657 void sqiflash_quad_out_read ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
658 
674 void sqiflash_quad_io_read ( sqiflash_t *ctx, uint32_t address, uint8_t mode,
675  uint8_t *buffer, uint32_t data_count );
676 
695 
712 void sqiflash_set_burst ( sqiflash_t *ctx, uint8_t length );
713 
739 void sqiflash_read_sqi_burst_wrap ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
740 
766 void sqiflash_read_spi_burst_wrap ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
767 
780 void sqiflash_read_dual_output ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
781 
817 void sqiflash_read_dual_io ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
818 
829 void sqiflash_sector_erase ( sqiflash_t *ctx, uint32_t address );
830 
843 void sqiflash_block_erase ( sqiflash_t *ctx, uint32_t address );
844 
855 
870 void sqiflash_get_sfdp_params ( sqiflash_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
871 
882 
893 
904 
915 
926 
937 
949 
959 void sqiflash_write_status_reg ( sqiflash_t *ctx, uint8_t s_reg );
960 
970 
981 
982 #ifdef __cplusplus
983 }
984 #endif
985 #endif // SQIFLASH_H
986  // sqiflash
988 
989 // ------------------------------------------------------------------------ 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:181
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:180
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:179
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:160
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:162
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:191
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:177
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:201
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:185
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:163
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:202
address
uint32_t address
Definition: main.c:35
sqiflash_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: sqiflash.h:190
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:168
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:186
sqiflash_cfg_t::cs
pin_name_t cs
Definition: sqiflash.h:182
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:189
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:166
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:200
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.