flash6 2.0.0.0
flash6.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 FLASH6_H
36#define FLASH6_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 FLASH6_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
65#define FLASH6_RETVAL uint8_t
66
67#define FLASH6_OK 0x00
68#define FLASH6_INIT_ERROR 0xFF
75#define FLASH6_CMD_WRITE_ENABLE 0x06
76#define FLASH6_CMD_VOL_SR_WRITE_ENABLE 0x50
77#define FLASH6_CMD_WRITE_DISABLE 0x04
78#define FLASH6_CMD_RELEASE_POWER_DOWN_ID 0xAB
79#define FLASH6_CMD_MANUFACTURER_DEVICE_ID 0x90
80#define FLASH6_CMD_JEDEC_ID 0x9F
81#define FLASH6_CMD_UINQUE_ID 0x4B
82#define FLASH6_CMD_READ_DATA 0x03
83#define FLASH6_CMD_FAST_READ_DATA 0x0B
84#define FLASH6_CMD_PAGE_PROGRAM 0x02
85#define FLASH6_CMD_SECTOR_ERASE_4KB 0x20
86#define FLASH6_CMD_BLOCK_ERASE_32KB 0x52
87#define FLASH6_CMD_BLOCK_ERASE_64KB 0xD8
88#define FLASH6_CMD_CHIP_ERASE 0xC7 //0x60
89#define FLASH6_CMD_READ_STATUS_1 0x05
90#define FLASH6_CMD_WRITE_STATUS_1 0x01
91#define FLASH6_CMD_READ_STATUS_2 0x35
92#define FLASH6_CMD_WRITE_STATUS_2 0x31
93#define FLASH6_CMD_READ_STATUS_3 0x15
94#define FLASH6_CMD_WRITE_STATUS_3 0x11
95#define FLASH6_CMD_READ_SFDP_REG 0x5A
96#define FLASH6_CMD_ERASE_SECURITY_REG 0x44
97#define FLASH6_CMD_PROGRAM_SECURITY_REG 0x42
98#define FLASH6_CMD_READ_SECURITY_REG 0x48
99#define FLASH6_CMD_GLOBAL_BLOCK_LOCK 0x7E
100#define FLASH6_CMD_GLOBAL_BLOCK_UNLOCK 0x98
101#define FLASH6_CMD_READ_BLOCK_LOCK 0x3D
102#define FLASH6_CMD_INDIVIDUAL_BLOCK_LOCK 0x36
103#define FLASH6_CMD_INDIVIDUAL_BLOCK_UNLOCK 0x39
104#define FLASH6_CMD_ERASE_PROGRAM_SUSPEND 0x75
105#define FLASH6_CMD_ERASE_PROGRAM_RESUME 0x7A
106#define FLASH6_CMD_POWER_DOWN 0xB9
107#define FLASH6_CMD_ENABLE_RESET 0x66
108#define FLASH6_CMD_RESET_DEVICE 0x99
115#define FLASH6_DEVICE_ID 0x17
116#define FLASH6_MANIFACTURE_ID 0xEF
123#define FLASH6_DEVICE_OK 0xFF
124#define FLASH6_DEVICE_ERROR 0xAA // End group macro
128// --------------------------------------------------------------- PUBLIC TYPES
137typedef struct
138{
139 digital_out_t cs;
140 // Modules
141
142 spi_master_t spi;
143 pin_name_t chip_select;
144
145} flash6_t;
146
150typedef struct
151{
152 // Communication gpio pins
153
154 pin_name_t miso;
155 pin_name_t mosi;
156 pin_name_t sck;
157 pin_name_t cs;
158
159 // static variable
160
161 uint32_t spi_speed;
162 spi_master_mode_t spi_mode;
163 spi_master_chip_select_polarity_t cs_polarity;
164
166 // End types group
168// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
169
174#ifdef __cplusplus
175extern "C"{
176#endif
177
187
196
206(
207 flash6_t *ctx,
208 uint8_t *wr_buf,
209 uint16_t wr_len,
210 uint8_t *rd_buf,
211 uint16_t rd_len
212);
213
222void flash6_read_data ( flash6_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint16_t len );
223
232void flash6_write_data ( flash6_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint8_t len );
233
239void flash6_send_cmd ( flash6_t *ctx, uint8_t cmd_data );
240
250uint8_t flash6_get_manufacture_device_id ( flash6_t *ctx, uint8_t *manufacture_id, uint8_t *device_id );
251
263void flash6_erase_memory_segment( flash6_t *ctx, uint8_t segment, uint32_t start_addr );
264
272uint8_t flash6_read_status_reg ( flash6_t *ctx, uint8_t status_cmd );
273
281void flash6_write_status_reg ( flash6_t *ctx, uint8_t status_cmd, uint8_t status_data );
282
291void flash6_write_memory_data ( flash6_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size );
292
301void flash6_read_memory_data ( flash6_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size );
302
309
310#ifdef __cplusplus
311}
312#endif
313#endif // _FLASH6_H_
314 // End public_function group
317
318// ------------------------------------------------------------------------- END
#define FLASH6_RETVAL
Definition: flash6.h:65
void flash6_erase_memory_segment(flash6_t *ctx, uint8_t segment, uint32_t start_addr)
Function for eraseing segment.
void flash6_send_cmd(flash6_t *ctx, uint8_t cmd_data)
Function for sending one Byte od data.
uint8_t flash6_read_status_reg(flash6_t *ctx, uint8_t status_cmd)
Function for reading status register.
void flash6_write_memory_data(flash6_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size)
Function used for writing in memory.
uint8_t flash6_get_manufacture_device_id(flash6_t *ctx, uint8_t *manufacture_id, uint8_t *device_id)
Funcion for checking manufacture and device id.
void flash6_write_data(flash6_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint8_t len)
Generic funcion for writing.
void flash6_read_memory_data(flash6_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size)
Function used for reading from memory.
void flash6_generic_transfer(flash6_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
void flash6_software_reset(flash6_t *ctx)
Function for reseting device.
FLASH6_RETVAL flash6_init(flash6_t *ctx, flash6_cfg_t *cfg)
Initialization function.
void flash6_cfg_setup(flash6_cfg_t *cfg)
Config Object Initialization function.
void flash6_write_status_reg(flash6_t *ctx, uint8_t status_cmd, uint8_t status_data)
Function for writing status register.
void flash6_read_data(flash6_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint16_t len)
Generic funcion for reading.
Click configuration structure definition.
Definition: flash6.h:151
spi_master_chip_select_polarity_t cs_polarity
Definition: flash6.h:163
pin_name_t sck
Definition: flash6.h:156
spi_master_mode_t spi_mode
Definition: flash6.h:162
pin_name_t mosi
Definition: flash6.h:155
uint32_t spi_speed
Definition: flash6.h:161
pin_name_t miso
Definition: flash6.h:154
pin_name_t cs
Definition: flash6.h:157
Click ctx object definition.
Definition: flash6.h:138
digital_out_t cs
Definition: flash6.h:139
spi_master_t spi
Definition: flash6.h:142
pin_name_t chip_select
Definition: flash6.h:143