flash7 2.0.0.0
flash7.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 FLASH7_H
29#define FLASH7_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_spi_master.h"
38
64#define FLASH7_STAT_REG_LSB_SRP0 0x80
65#define FLASH7_STAT_REG_LSB_BP4 0x40
66#define FLASH7_STAT_REG_LSB_BP3 0x20
67#define FLASH7_STAT_REG_LSB_BP2 0x10
68#define FLASH7_STAT_REG_LSB_BP1 0x08
69#define FLASH7_STAT_REG_LSB_BP0 0x04
70#define FLASH7_STAT_REG_LSB_WEL 0x02
71#define FLASH7_STAT_REG_LSB_WIP 0x01
72
77#define FLASH7_STAT_REG_MSB_SUS1 0x80
78#define FLASH7_STAT_REG_MSB_CMP 0x40
79#define FLASH7_STAT_REG_MSB_LB3 0x20
80#define FLASH7_STAT_REG_MSB_LB2 0x10
81#define FLASH7_STAT_REG_MSB_LB1 0x08
82#define FLASH7_STAT_REG_MSB_SUS2 0x04
83#define FLASH7_STAT_REG_MSB_QE 0x02
84#define FLASH7_STAT_REG_MSB_SRP1 0x01
85
90#define FLASH7_MEMORY_ADDR_START 0x00000000
91#define FLASH7_MEMORY_ADDR_END 0x00FFFFFF
92#define FLASH7_MEM_SECTOR_LEN 0x00001000
93#define FLASH7_MEMORY_BLOCK_SIZE 0x00008000
94 // flash7_reg
96
116#define FLASH7_CMD_WRSR 0x01
117#define FLASH7_CMD_WRITE 0x02
118#define FLASH7_CMD_READ 0x03
119#define FLASH7_CMD_WRDI 0x04
120#define FLASH7_CMD_RDSR_LSB 0x05
121#define FLASH7_CMD_RDSR_MSB 0x35
122#define FLASH7_CMD_WREN 0x06
123#define FLASH7_CMD_FREAD 0x0B
124#define FLASH7_CMD_WEVSR 0x50
125#define FLASH7_CMD_SE 0x20
126#define FLASH7_CMD_BE_32KB 0x52
127#define FLASH7_CMD_BE_64KB 0xD8
128#define FLASH7_CMD_CE 0x60
129#define FLASH7_CMD_SLEEP 0xB9
130#define FLASH7_CMD_WAKE 0xAB
131#define FLASH7_CMD_REMS 0x90
132#define FLASH7_CMD_RDID 0x9F
133#define FLASH7_CMD_ID 0x4B
134#define FLASH7_CMD_ENRES 0x66
135#define FLASH7_CMD_RES 0x99
136
141#define FLASH7_WRITE_PROTECT_DISABLE 0x00
142#define FLASH7_WRITE_PROTECT_ENABLE 0x01
143
148#define FLASH7_HOLD_DISABLE 0x00
149#define FLASH7_HOLD_ENABLE 0x01
150
155#define FLASH7_DUMMY 0x00
156 // flash7_set
158
173#define FLASH7_MAP_MIKROBUS( cfg, mikrobus ) \
174 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
175 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
176 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
177 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
178 cfg.io2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
179 cfg.io3 = MIKROBUS( mikrobus, MIKROBUS_INT )
180 // flash7_map // flash7
183
188typedef struct
189{
190 // Output pins
191 digital_out_t io2;
192 digital_out_t io3;
194 // Modules
195 spi_master_t spi;
197 pin_name_t chip_select;
199} flash7_t;
200
205typedef struct
206{
207 // Communication gpio pins
208 pin_name_t miso;
209 pin_name_t mosi;
210 pin_name_t sck;
211 pin_name_t cs;
213 // Additional gpio pins
214
215 pin_name_t io2;
216 pin_name_t io3;
218 // static variable
219 uint32_t spi_speed;
220 spi_master_mode_t spi_mode;
221 spi_master_chip_select_polarity_t cs_polarity;
224
229typedef enum
230{
232 FLASH7_ERROR = -1
233
235
252
267err_t flash7_init ( flash7_t *ctx, flash7_cfg_t *cfg );
268
283
299err_t flash7_generic_write ( flash7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
300
315err_t flash7_generic_read ( flash7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
316
328void flash7_write_protect ( flash7_t *ctx, uint8_t en_write_protect );
329
340void flash7_hold ( flash7_t *ctx, uint8_t en_hold );
341
352void flash7_send_command ( flash7_t *ctx, uint8_t cmd );
353
364
375
386
397uint8_t flash7_read_status_register ( flash7_t *ctx, uint8_t status_byte );
398
409void flash7_write_status_register ( flash7_t *ctx, uint16_t status_data );
410
424uint8_t flash7_page_program ( flash7_t *ctx, uint32_t mem_addr, uint8_t *p_tx_data, uint16_t n_bytes );
425
439void flash7_read_memory ( flash7_t *ctx, uint32_t mem_addr, uint8_t *p_rx_data, uint16_t n_bytes );
440
454void flash7_fast_read_memory ( flash7_t *ctx, uint32_t mem_addr, uint8_t *p_rx_data, uint16_t n_bytes );
455
471uint8_t flash7_sector_erase ( flash7_t *ctx, uint16_t mem_sector );
472
489uint8_t flash7_block_erase ( flash7_t *ctx, uint8_t mem_block, uint8_t mem_block_len );
490
503
514uint8_t flash7_wake_up ( flash7_t *ctx );
515
527void flash7_read_id ( flash7_t *ctx, uint8_t *manufacturer_id, uint8_t *device_id );
528
541void flash7_get_identification ( flash7_t *ctx, uint8_t *manufacturer_id, uint8_t *memory_type_id, uint8_t *capacity_id );
542
553
554#ifdef __cplusplus
555}
556#endif
557#endif // FLASH7_H
558 // flash7
560
561// ------------------------------------------------------------------------ END
flash7_return_value_t
Flash 7 Click return value data.
Definition: flash7.h:230
@ FLASH7_OK
Definition: flash7.h:231
@ FLASH7_ERROR
Definition: flash7.h:232
void flash7_read_memory(flash7_t *ctx, uint32_t mem_addr, uint8_t *p_rx_data, uint16_t n_bytes)
Read memory function.
void flash7_hold(flash7_t *ctx, uint8_t en_hold)
Enable hold operation function.
void flash7_send_command(flash7_t *ctx, uint8_t cmd)
Send command function.
uint8_t flash7_wake_up(flash7_t *ctx)
Wake up function.
void flash7_chip_erase(flash7_t *ctx)
Chip erase function.
void flash7_write_enable(flash7_t *ctx)
Write enable function.
void flash7_read_id(flash7_t *ctx, uint8_t *manufacturer_id, uint8_t *device_id)
Read ID function.
uint8_t flash7_block_erase(flash7_t *ctx, uint8_t mem_block, uint8_t mem_block_len)
Block erase function.
void flash7_write_protect(flash7_t *ctx, uint8_t en_write_protect)
Enable write protect function.
void flash7_get_identification(flash7_t *ctx, uint8_t *manufacturer_id, uint8_t *memory_type_id, uint8_t *capacity_id)
Get identification function.
void flash7_cfg_setup(flash7_cfg_t *cfg)
Flash 7 configuration object setup function.
uint8_t flash7_sector_erase(flash7_t *ctx, uint16_t mem_sector)
Sector erase function.
err_t flash7_init(flash7_t *ctx, flash7_cfg_t *cfg)
Flash 7 initialization function.
err_t flash7_generic_write(flash7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Flash 7 data writing function.
void flash7_write_status_register(flash7_t *ctx, uint16_t status_data)
Write status register function.
uint8_t flash7_read_status_register(flash7_t *ctx, uint8_t status_byte)
Read status register function.
err_t flash7_generic_read(flash7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Flash 7 data reading function.
void flash7_go_to_sleep(flash7_t *ctx)
Go to sleep mode function.
void flash7_sw_reset(flash7_t *ctx)
Soft reset function.
uint8_t flash7_page_program(flash7_t *ctx, uint32_t mem_addr, uint8_t *p_tx_data, uint16_t n_bytes)
Page program function.
void flash7_write_disable(flash7_t *ctx)
Write disable function.
err_t flash7_default_cfg(flash7_t *ctx)
Flash 7 default configuration function.
void flash7_fast_read_memory(flash7_t *ctx, uint32_t mem_addr, uint8_t *p_rx_data, uint16_t n_bytes)
Fast read memory function.
Flash 7 Click configuration object.
Definition: flash7.h:206
spi_master_chip_select_polarity_t cs_polarity
Definition: flash7.h:221
pin_name_t io2
Definition: flash7.h:215
pin_name_t sck
Definition: flash7.h:210
spi_master_mode_t spi_mode
Definition: flash7.h:220
pin_name_t mosi
Definition: flash7.h:209
uint32_t spi_speed
Definition: flash7.h:219
pin_name_t miso
Definition: flash7.h:208
pin_name_t io3
Definition: flash7.h:216
pin_name_t cs
Definition: flash7.h:211
Flash 7 Click context object.
Definition: flash7.h:189
spi_master_t spi
Definition: flash7.h:195
digital_out_t io3
Definition: flash7.h:192
digital_out_t io2
Definition: flash7.h:191
pin_name_t chip_select
Definition: flash7.h:197