flash  2.0.0.0
flash.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 _FLASH_H_
36 #define _FLASH_H_
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_spi_master.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define FLASH_MEM_ADDR_FIRST_PAGE_START 0x0
66 #define FLASH_MEM_ADDR_FIRST_PAGE_END 0xFF
67 #define FLASH_MEM_ADDR_SECOND_PAGE_START 0x100
68 #define FLASH_MEM_ADDR_SECOND_PAGE_END 0x1FF
69 #define FLASH_MEM_ADDR_LAST_PAGE_START 0xFFF00
70 #define FLASH_MEM_ADDR_LAST_PAGE_END 0xFFFFF
71 #define FLASH_MEM_ADDR_FIRST_SECTOR_START 0x0
72 #define FLASH_MEM_ADDR_FIRST_SECTOR_END 0xFFF
73 #define FLASH_MEM_ADDR_LAST_SECTOR_START 0xFF000
74 #define FLASH_MEM_ADDR_LAST_SECTOR_END 0xFFFFF
75 #define FLASH_MEM_ADDR_FIRST_BLOCK_START 0x0
76 #define FLASH_MEM_ADDR_FIRST_BLOCK_END 0xFFFF
77 #define FLASH_MEM_ADDR_LAST_BLOCK_START 0xF0000
78 #define FLASH_MEM_ADDR_LAST_BLOCK_END 0xFFFFF
79 
85 #define FLASH_NDATA_TRANSFER_MIN 1
86 #define FLASH_NDATA_TRANSFER_MAX 256
87 
98 #define FLASH_STATUS_MASK_WRITE_BUSY 0x1
99 #define FLASH_STATUS_MASK_WRITE_EN 0x2
100 #define FLASH_STATUS_MASK_BLOCK_PROTECT 0x3C
101 #define FLASH_STATUS_MASK_WP_DIS 0x40
102 #define FLASH_STATUS_MASK_OTP_LOCK 0x80
103 
109 #define FLASH_STATUS_SET_BLOCK_PROT_BIT0 0x4
110 #define FLASH_STATUS_SET_BLOCK_PROT_BIT1 0x8
111 #define FLASH_STATUS_SET_BLOCK_PROT_BIT2 0x10
112 #define FLASH_STATUS_SET_BLOCK_PROT_BIT3 0x20
113 #define FLASH_STATUS_SET_WP_DIS 0x40
114 #define FLASH_STATUS_SET_OTP_LOCK 0x80
115  // End status group
118 
123 #define FLASH_MAP_MIKROBUS( cfg, mikrobus ) \
124  cfg.sdo = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
125  cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
126  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
127  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
128  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_RST ); \
129  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
130  // End macros group
133 // --------------------------------------------------------------- PUBLIC TYPES
142 typedef enum
143 {
144  FLASH_OK = 0x0,
148 
150 
154 typedef enum
155 {
158 
160 
164 typedef struct
165 {
166  // Output pins
167  digital_out_t cs;
168 
169  // Control pins.
170  digital_out_t hld;
171  digital_out_t wp;
172 
173  // Module.
174  spi_master_t spi;
175  pin_name_t chip_select;
176 
177 } flash_t;
178 
182 typedef struct
183 {
184  // Communication gpio pins.
185  pin_name_t sdo;
186  pin_name_t sdi;
187  pin_name_t sck;
188  pin_name_t cs;
189 
190  // Additional gpio pins.
191  pin_name_t hld;
192  pin_name_t wp;
193 
194  // SPI configuration.
195  uint32_t spi_speed;
196  spi_master_mode_t spi_mode;
197  spi_master_chip_select_polarity_t cs_polarity;
198 
199 } flash_cfg_t;
200  // End types group
202 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
208 #ifdef __cplusplus
209 extern "C"{
210 #endif
211 
222 
236 
245 
255 void flash_reset( flash_t *ctx );
256 
266 
277 
288 void flash_write_status( flash_t *ctx, uint8_t data_tx );
289 
299 uint8_t flash_read_status( flash_t *ctx );
300 
311 void flash_read_id( flash_t *ctx, uint8_t *manufact_id, uint16_t *dev_id );
312 
328 flash_err_t flash_write_byte( flash_t *ctx, uint32_t mem_addr, uint8_t data_tx );
329 
343 flash_err_t flash_read_byte( flash_t *ctx, uint32_t mem_addr, uint8_t *data_rx );
344 
362 flash_err_t flash_write_page( flash_t *ctx, uint32_t mem_addr, uint8_t *data_tx,
363  uint16_t n_data );
364 
380 flash_err_t flash_read_page( flash_t *ctx, uint32_t mem_addr, uint8_t *data_rx,
381  uint16_t n_data );
382 
393 
407 flash_err_t flash_erase_block( flash_t *ctx, uint32_t mem_addr );
408 
423 flash_err_t flash_erase_half_block( flash_t *ctx, uint32_t mem_addr );
424 
438 flash_err_t flash_erase_sector( flash_t *ctx, uint32_t mem_addr );
439 
449 
459 
460 #ifdef __cplusplus
461 }
462 #endif
463 #endif // _FLASH_H_
464  // End public_function group
467 
468 // ------------------------------------------------------------------------ END
flash_write_status
void flash_write_status(flash_t *ctx, uint8_t data_tx)
Status Write function.
flash_read_id
void flash_read_id(flash_t *ctx, uint8_t *manufact_id, uint16_t *dev_id)
ID Read function.
flash_init
flash_err_t flash_init(flash_t *ctx, flash_cfg_t *cfg)
Click Initialization function.
FLASH_ERR_MEM_ADDR
@ FLASH_ERR_MEM_ADDR
Definition: flash.h:146
flash_t
Click context object definition.
Definition: flash.h:165
flash_cfg_t::spi_speed
uint32_t spi_speed
Definition: flash.h:195
flash_t::spi
spi_master_t spi
Definition: flash.h:174
FLASH_PIN_STATE_HIGH
@ FLASH_PIN_STATE_HIGH
Definition: flash.h:157
flash_write_disable
void flash_write_disable(flash_t *ctx)
Write Disable function.
flash_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: flash.h:196
flash_pin_state_t
flash_pin_state_t
Click pin states.
Definition: flash.h:155
flash_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: flash.h:197
flash_write_enable
void flash_write_enable(flash_t *ctx)
Write Enable function.
flash_read_byte
flash_err_t flash_read_byte(flash_t *ctx, uint32_t mem_addr, uint8_t *data_rx)
Byte Read function.
flash_cfg_t::sdo
pin_name_t sdo
Definition: flash.h:185
flash_read_page
flash_err_t flash_read_page(flash_t *ctx, uint32_t mem_addr, uint8_t *data_rx, uint16_t n_data)
Page Read function.
flash_cfg_setup
void flash_cfg_setup(flash_cfg_t *cfg)
Config Object Setup function.
flash_err_t
flash_err_t
Click error code definition.
Definition: flash.h:143
flash_erase_sector
flash_err_t flash_erase_sector(flash_t *ctx, uint32_t mem_addr)
Sector Erase function.
FLASH_PIN_STATE_LOW
@ FLASH_PIN_STATE_LOW
Definition: flash.h:156
FLASH_OK
@ FLASH_OK
Definition: flash.h:144
flash_erase_half_block
flash_err_t flash_erase_half_block(flash_t *ctx, uint32_t mem_addr)
Half Block Erase function.
flash_write_byte
flash_err_t flash_write_byte(flash_t *ctx, uint32_t mem_addr, uint8_t data_tx)
Byte Write function.
flash_set_hold_pin
void flash_set_hold_pin(flash_t *ctx, flash_pin_state_t state)
HLD Pin Set function.
flash_reset
void flash_reset(flash_t *ctx)
Reset function.
FLASH_ERR_NDATA
@ FLASH_ERR_NDATA
Definition: flash.h:147
flash_write_page
flash_err_t flash_write_page(flash_t *ctx, uint32_t mem_addr, uint8_t *data_tx, uint16_t n_data)
Page Write function.
FLASH_ERR_INIT_DRV
@ FLASH_ERR_INIT_DRV
Definition: flash.h:145
flash_cfg_t::cs
pin_name_t cs
Definition: flash.h:188
flash_erase_chip
void flash_erase_chip(flash_t *ctx)
Chip Erase function.
flash_cfg_t
Click configuration structure definition.
Definition: flash.h:183
flash_t::chip_select
pin_name_t chip_select
Definition: flash.h:175
flash_cfg_t::sck
pin_name_t sck
Definition: flash.h:187
flash_t::hld
digital_out_t hld
Definition: flash.h:170
flash_cfg_t::sdi
pin_name_t sdi
Definition: flash.h:186
flash_erase_block
flash_err_t flash_erase_block(flash_t *ctx, uint32_t mem_addr)
Block Erase function.
flash_t::cs
digital_out_t cs
Definition: flash.h:167
flash_cfg_t::wp
pin_name_t wp
Definition: flash.h:192
flash_default_cfg
void flash_default_cfg(flash_t *ctx)
Click Default Configuration function.
flash_cfg_t::hld
pin_name_t hld
Definition: flash.h:191
flash_t::wp
digital_out_t wp
Definition: flash.h:171
flash_set_write_protect_pin
void flash_set_write_protect_pin(flash_t *ctx, flash_pin_state_t state)
WP Pin Set function.
flash_read_status
uint8_t flash_read_status(flash_t *ctx)
Status Read function.