flash2  2.0.0.0
flash2.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 FLASH2_H
36 #define FLASH2_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define FLASH2_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
61 
63 #define FLASH2_STATUS_WEL 0x02
64 #define FLASH2_STATUS_WSE 0x04
65 #define FLASH2_STATUS_WSP 0x08
66 #define FLASH2_STATUS_WPLD 0x10
67 #define FLASH2_STATUS_SEC 0x20
68 #define FLASH2_STATUS_RES 0x40
69 #define FLASH2_STATUS_BUSY 0x80
70 
71 
72 #define FLASH2_CFG_RES 0x01
73 #define FLASH2_CFG_IOC 0x02
74 #define FLASH2_CFG_BPNV 0x08
75 #define FLASH2_CFG_WPEN 0x80
76 
77 
78 #define FLASH2_INSTR_NOP 0x00
79 #define FLASH2_INSTR_RSTEN 0x66
80 #define FLASH2_INSTR_RST 0x99
81 #define FLASH2_INSTR_EQIO 0x38
82 #define FLASH2_INSTR_RSTQIO 0xFF
83 #define FLASH2_INSTR_RDSR 0x05
84 #define FLASH2_INSTR_WRSR 0x01
85 #define FLASH2_INSTR_RDCR 0x35
86 #define FLASH2_INSTR_READ 0x03
87 #define FLASH2_INSTR_HS_READ 0x0B
88 #define FLASH2_INSTR_SQOR 0x6B
89 #define FLASH2_INSTR_SQIOR 0xEB
90 #define FLASH2_INSTR_SDOR 0x3B
91 #define FLASH2_INSTR_SDIOR 0xBB
92 #define FLASH2_INSTR_SB 0xC0
93 #define FLASH2_INSTR_RBSQI 0x0C
94 #define FLASH2_INSTR_RBSPI 0xEC
95 #define FLASH2_INSTR_JEDECID 0x9F
96 #define FLASH2_INSTR_QUAD_JID 0xAF
97 #define FLASH2_INSTR_SFDP 0x5A
98 #define FLASH2_INSTR_WREN 0x06
99 #define FLASH2_INSTR_WRDI 0x04
100 #define FLASH2_INSTR_SE 0x20
101 #define FLASH2_INSTR_BE 0xD8
102 #define FLASH2_INSTR_CE 0xC7
103 #define FLASH2_INSTR_PP 0x02
104 #define FLASH2_INSTR_SPI_QUAD 0x32
105 #define FLASH2_INSTR_WRSU 0xB0
106 #define FLASH2_INSTR_WRRE 0x30
107 #define FLASH2_INSTR_RBPR 0x72
108 #define FLASH2_INSTR_WBPR 0x42
109 #define FLASH2_INSTR_LBPR 0x8D
110 #define FLASH2_INSTR_NVWLDR 0xE8
111 #define FLASH2_INSTR_ULBPR 0x98
112 #define FLASH2_INSTR_RSID 0x88
113 #define FLASH2_INSTR_PSID 0xA5
114 #define FLASH2_INSTR_LSID 0x85
117 #define FLASH2_START_PAGE_ADDRESS 0x010000
118 #define FLASH2_END_PAGE_ADDRESS 0x7FFFFF
119 #define FLASH2_FLASH_PAGE_SIZE 256
120 
124 #define FLASH2_RETVAL uint8_t
125 
126 #define FLASH2_OK 0x00
127 #define FLASH2_INIT_ERROR 0xFF
128  // End group macro
131 // --------------------------------------------------------------- PUBLIC TYPES
140 typedef struct
141 {
142  digital_out_t cs;
143 
144  // Output pins
145 
146  digital_out_t hld;
147  digital_out_t wp;
148 
149  // Modules
150 
151  spi_master_t spi;
152  pin_name_t chip_select;
153 
154 } flash2_t;
155 
159 typedef struct
160 {
161  // Communication gpio pins
162 
163  pin_name_t miso;
164  pin_name_t mosi;
165  pin_name_t sck;
166  pin_name_t cs;
167 
168  // Additional gpio pins
169 
170  pin_name_t hld;
171  pin_name_t wp;
172 
173  // static variable
174 
175  uint32_t spi_speed;
176  spi_master_mode_t spi_mode;
177  spi_master_chip_select_polarity_t cs_polarity;
178 
179 } flash2_cfg_t;
180  // End types group
182 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
183 
188 #ifdef __cplusplus
189 extern "C"{
190 #endif
191 
200 void flash2_cfg_setup ( flash2_cfg_t *cfg );
201 
211 
223 void flash2_generic_transfer ( flash2_t *ctx, uint32_t address, uint8_t *buffer,
224  uint32_t data_count );
225 
236 uint8_t flash2_busy( flash2_t *ctx );
237 
248 uint8_t flash2_get_status_reg( flash2_t *ctx );
249 
258 uint8_t flash2_erase_status( flash2_t *ctx );
259 
270 uint8_t flash2_write_status( flash2_t *ctx );
271 
282 uint8_t flash2_program_status( flash2_t *ctx );
283 
294 uint8_t flash2_protect_status( flash2_t *ctx );
295 
305 void flash2_lock_security_id( flash2_t *ctx );
306 
317 uint8_t flash2_security_status( flash2_t *ctx );
318 
328 
338 
347 void flash2_hold_enable( flash2_t *ctx );
348 
357 void flash2_hold_disable( flash2_t *ctx );
358 
382 void flash2_write_suspend( flash2_t *ctx );
383 
384 
407 void flash2_write_resume( flash2_t *ctx );
408 
418 void flash2_spi_get_security_id( flash2_t *ctx, uint8_t *buffer, uint32_t data_count);
419 
430 void flash2_sqi_get_security_id( flash2_t *ctx, uint8_t *buffer, uint32_t data_count);
431 
447 void flash2_set_security_id( flash2_t *ctx, uint8_t *buffer, uint32_t data_count );
448 
458 void flash2_write_disable( flash2_t *ctx );
459 
472 void flash2_spi_get_bpr( flash2_t *ctx, uint8_t *buffer, uint32_t data_count );
473 
486 void flash2_sqi_get_bpr( flash2_t *ctx, uint8_t *buffer, uint32_t data_count );
487 
498 void flash2_set_bpr( flash2_t *ctx, uint8_t *buffer );
499 
512 void flash2_lockBpr( flash2_t *ctx );
513 
525 void flash2_nonvolatile_write_lock( flash2_t *ctx, uint8_t *buffer);
526 
539 
562 void flash2_read_generic( flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
563 
580 void flash2_highspeedRread( flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
581 
600 void flash2_quadWrite( flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
601 
619 void flash2_write_generic( flash2_t *ctx, uint32_t address, uint8_t *buffer,
620  uint32_t data_count );
621 
636 void flash2_quad_enable( flash2_t *ctx );
637 
654 void flash2_quad_out_read( flash2_t *ctx, uint32_t address, uint8_t *buffer,
655  uint32_t data_count);
656 
674 void flash2_quad_io_read( flash2_t *ctx, uint32_t address, uint8_t mode, uint8_t *buffer, uint32_t data_count);
675 
695 void flash2_quad_reset( flash2_t *ctx );
696 
716 void flash2_set_burst( flash2_t *ctx, uint8_t length );
717 
744 void flash2_read_sqi_burst_wrap( flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count );
745 
774 void flash2_read_spi_burst_wrap( flash2_t *ctx, uint32_t address, uint8_t *buffer,
775  uint32_t data_count );
776 
790 void flash2_read_dual_output( flash2_t *ctx, uint32_t address, uint8_t *buffer,
791  uint32_t data_count );
792 
832 void flash2_read_dual_io ( flash2_t *ctx, uint32_t address, uint8_t *buffer,
833  uint32_t data_count );
834 
846 void flash2_sector_erase( flash2_t *ctx, uint32_t address );
847 
862 void flash2_block_erase( flash2_t *ctx, uint32_t address );
863 
875 void flash2_chip_erase( flash2_t *ctx );
876 
893 void flash2_get_sfdp_params( flash2_t *ctx, uint32_t address, uint8_t *buffer,
894  uint32_t data_count );
895 
908 uint8_t flash2_quad_device_manufac( flash2_t *ctx );
909 
922 uint8_t flash2_quad_device_type( flash2_t *ctx );
923 
936 uint8_t flash2_quad_device_id( flash2_t *ctx );
937 
950 uint8_t flash2_device_manufac( flash2_t *ctx );
951 
964 uint8_t flash2_device_type( flash2_t *ctx );
965 
978 uint8_t flash2_device_id( flash2_t *ctx );
979 
990 void flash2_reset( flash2_t *ctx );
991 
1001 void flash2_write_status_reg( flash2_t *ctx, uint8_t s_reg );
1002 
1013 uint8_t flash2_get_config_reg( flash2_t *ctx );
1014 
1024 void flash2_write_enable( flash2_t *ctx );
1025 
1026 #ifdef __cplusplus
1027 }
1028 #endif
1029 #endif // _FLASH2_H_
1030  // End public_function group
1033 
1034 // ------------------------------------------------------------------------- END
flash2_hold_enable
void flash2_hold_enable(flash2_t *ctx)
Flash 2 Hold Enable.
flash2_t::spi
spi_master_t spi
Definition: flash2.h:151
flash2_device_type
uint8_t flash2_device_type(flash2_t *ctx)
Flash 2 Device Type.
flash2_nonvolatile_write_lock
void flash2_nonvolatile_write_lock(flash2_t *ctx, uint8_t *buffer)
Flash 2 Non-Volatile Write-Lock.
flash2_quad_device_id
uint8_t flash2_quad_device_id(flash2_t *ctx)
Flash 2 Quad Device ID.
flash2_write_generic
void flash2_write_generic(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 Write.
flash2_read_dual_io
void flash2_read_dual_io(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 Read Dual I/O.
flash2_sector_erase
void flash2_sector_erase(flash2_t *ctx, uint32_t address)
Flash 2 Sector Erase.
flash2_t::wp
digital_out_t wp
Definition: flash2.h:147
flash2_quadWrite
void flash2_quadWrite(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 Quad Write.
flash2_cfg_t::sck
pin_name_t sck
Definition: flash2.h:165
flash2_quad_device_type
uint8_t flash2_quad_device_type(flash2_t *ctx)
Flash 2 Quad Device Type.
flash2_quad_io_read
void flash2_quad_io_read(flash2_t *ctx, uint32_t address, uint8_t mode, uint8_t *buffer, uint32_t data_count)
Flash 2 Quad I/O Read.
flash2_quad_device_manufac
uint8_t flash2_quad_device_manufac(flash2_t *ctx)
Flash 2 Quad Device Manufacturer.
flash2_cfg_t::wp
pin_name_t wp
Definition: flash2.h:171
flash2_generic_transfer
void flash2_generic_transfer(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Generic transfer function.
flash2_read_dual_output
void flash2_read_dual_output(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 Read Dual Output.
flash2_security_status
uint8_t flash2_security_status(flash2_t *ctx)
Flash 2 Security Status.
flash2_t::hld
digital_out_t hld
Definition: flash2.h:146
flash2_cfg_t::hld
pin_name_t hld
Definition: flash2.h:170
flash2_init
FLASH2_RETVAL flash2_init(flash2_t *ctx, flash2_cfg_t *cfg)
Initialization function.
flash2_cfg_setup
void flash2_cfg_setup(flash2_cfg_t *cfg)
Config Object Initialization function.
flash2_device_manufac
uint8_t flash2_device_manufac(flash2_t *ctx)
Flash 2 Device Manufacturer.
flash2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: flash2.h:177
flash2_reset
void flash2_reset(flash2_t *ctx)
Flash 2 Reset.
flash2_spi_get_bpr
void flash2_spi_get_bpr(flash2_t *ctx, uint8_t *buffer, uint32_t data_count)
Flash 2 Get Block Protection Register SPI.
flash2_protect_status
uint8_t flash2_protect_status(flash2_t *ctx)
Flash 2 Protect Status.
flash2_read_generic
void flash2_read_generic(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 Read.
flash2_cfg_t::mosi
pin_name_t mosi
Definition: flash2.h:164
flash2_cfg_t::cs
pin_name_t cs
Definition: flash2.h:166
flash2_quad_reset
void flash2_quad_reset(flash2_t *ctx)
Flash 2 Quad Reset.
flash2_quad_enable
void flash2_quad_enable(flash2_t *ctx)
Flash 2 Quad Enable.
flash2_write_status_reg
void flash2_write_status_reg(flash2_t *ctx, uint8_t s_reg)
Flash 2 Write Status Register.
FLASH2_RETVAL
#define FLASH2_RETVAL
Definition: flash2.h:124
flash2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: flash2.h:176
flash2_write_status
uint8_t flash2_write_status(flash2_t *ctx)
Flash 2 Write Status.
flash2_hold_disable
void flash2_hold_disable(flash2_t *ctx)
Flash 2 Hold Disable.
flash2_global_block_unlock
void flash2_global_block_unlock(flash2_t *ctx)
Flash 2 Global Block Unlock.
flash2_get_config_reg
uint8_t flash2_get_config_reg(flash2_t *ctx)
Flash 2 Get Config Register.
flash2_cfg_t
Click configuration structure definition.
Definition: flash2.h:159
flash2_device_id
uint8_t flash2_device_id(flash2_t *ctx)
Flash 2 Device ID.
flash2_t::chip_select
pin_name_t chip_select
Definition: flash2.h:152
flash2_lock_security_id
void flash2_lock_security_id(flash2_t *ctx)
flash2_lock_security_id
flash2_cfg_t::spi_speed
uint32_t spi_speed
Definition: flash2.h:175
flash2_quad_out_read
void flash2_quad_out_read(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 Quad Output Read.
flash2_read_sqi_burst_wrap
void flash2_read_sqi_burst_wrap(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 Read Burst with Wrap through SQI.
flash2_program_status
uint8_t flash2_program_status(flash2_t *ctx)
Flash 2 Program Status.
flash2_set_burst
void flash2_set_burst(flash2_t *ctx, uint8_t length)
Flash 2 Set Burst.
flash2_lockBpr
void flash2_lockBpr(flash2_t *ctx)
Flash 2 Lock Block Protection Register.
flash2_write_suspend
void flash2_write_suspend(flash2_t *ctx)
Flash 2 Write Suspend.
flash2_get_sfdp_params
void flash2_get_sfdp_params(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 get Serial Flash Discoverable \ Parameters.
flash2_set_bpr
void flash2_set_bpr(flash2_t *ctx, uint8_t *buffer)
Flash 2 Set Block Protection Register.
flash2_sqi_get_security_id
void flash2_sqi_get_security_id(flash2_t *ctx, uint8_t *buffer, uint32_t data_count)
Flash 2 Get Security ID SQI.
flash2_highspeedRread
void flash2_highspeedRread(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 High Speed Read.
flash2_t
Click ctx object definition.
Definition: flash2.h:140
flash2_write_protect_enable
void flash2_write_protect_enable(flash2_t *ctx)
Flash 2 Write Protect Enable.
flash2_erase_status
uint8_t flash2_erase_status(flash2_t *ctx)
Flash 2 Erase Status.
flash2_set_security_id
void flash2_set_security_id(flash2_t *ctx, uint8_t *buffer, uint32_t data_count)
Flash 2 Set Security ID.
flash2_write_disable
void flash2_write_disable(flash2_t *ctx)
Flash 2 Write Disable.
flash2_write_protect_disable
void flash2_write_protect_disable(flash2_t *ctx)
Flash 2 Write Protect Disable.
flash2_sqi_get_bpr
void flash2_sqi_get_bpr(flash2_t *ctx, uint8_t *buffer, uint32_t data_count)
Flash 2 Get Block Protection Register SQI.
flash2_write_enable
void flash2_write_enable(flash2_t *ctx)
Flash 2 Write Enable.
flash2_busy
uint8_t flash2_busy(flash2_t *ctx)
Flash 2 Busy.
flash2_block_erase
void flash2_block_erase(flash2_t *ctx, uint32_t address)
Flash 2 Block Erase.
flash2_get_status_reg
uint8_t flash2_get_status_reg(flash2_t *ctx)
Flash 2 Get Status Register.
flash2_chip_erase
void flash2_chip_erase(flash2_t *ctx)
Flash 2 Chip Erase.
flash2_cfg_t::miso
pin_name_t miso
Definition: flash2.h:163
flash2_t::cs
digital_out_t cs
Definition: flash2.h:142
flash2_spi_get_security_id
void flash2_spi_get_security_id(flash2_t *ctx, uint8_t *buffer, uint32_t data_count)
Flash 2 Get Security ID SPI.
flash2_write_resume
void flash2_write_resume(flash2_t *ctx)
Flash 2 Write Resume.
flash2_read_spi_burst_wrap
void flash2_read_spi_burst_wrap(flash2_t *ctx, uint32_t address, uint8_t *buffer, uint32_t data_count)
Flash 2 Read Burst with Wrap through SPI.