flash12  2.1.0.0
flash12.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 FLASH12_H
29 #define FLASH12_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 FLASH12_CMD_READ_ARRAY 0x03
61 #define FLASH12_CMD_FAST_READ_ARRAY 0x0B
62 
67 #define FLASH12_CMD_BYTE_PAGE_PROGRAM 0x02
68 #define FLASH12_CMD_PAGE_ERASE 0x81
69 #define FLASH12_CMD_BLOCK_ERASE_4KB 0x20
70 #define FLASH12_CMD_BLOCK_ERASE_32KB 0x52
71 #define FLASH12_CMD_BLOCK_ERASE_64KB 0xD8
72 #define FLASH12_CMD_CHIP_ERASE 0x60
73 
78 #define FLASH12_CMD_ERASE_SECURITY_REG 0x44
79 #define FLASH12_CMD_PROGRAM_SECURITY_REG 0x42
80 #define FLASH12_CMD_READ_SECURITY_REG 0x48
81 #define FLASH12_CMD_READ_SERIAL_FLASH 0x5A
82 
87 #define FLASH12_CMD_WRITE_ENABLE 0x06
88 #define FLASH12_CMD_VOLATILE_STATUS 0x50
89 #define FLASH12_CMD_WRITE_DISABLE 0x04
90 
95 #define FLASH12_CMD_READ_STATUS_1 0x05
96 #define FLASH12_CMD_WRITE_STATUS_1 0x01
97 #define FLASH12_CMD_READ_STATUS_2 0x35
98 #define FLASH12_CMD_ACT_STATUS_INT 0x25
99 
104 #define FLASH12_CMD_DEEP_POWER_DOWN 0xB9
105 #define FLASH12_CMD_RELEASE_PD_ID 0xAB
106 #define FLASH12_CMD_MANUFACTURER_ID 0x90
107 #define FLASH12_CMD_JEDEC_ID 0x9F
108 #define FLASH12_CMD_READ_UNIQUE_ID_NUM 0x4B
109 
114 #define FLASH12_CMD_ENABLE_RESET 0x66
115 #define FLASH12_CMD_RESET_DEVICE 0x99
116 
117  // flash12_cmd
119 
134 #define FLASH12_MANUFACTURER_ID 0x1F
135 #define FLASH12_DEVICE_ID 0x14
136 
141 #define FLASH12_STATUS1_SRP0 0x80
142 #define FLASH12_STATUS1_BPSIZE 0x40
143 #define FLASH12_STATUS1_TB 0x20
144 #define FLASH12_STATUS1_WEL 0x02
145 #define FLASH12_STATUS1_BSY 0x01
146 
151 #define FLASH12_MIN_ADDRESS 0x000000ul
152 #define FLASH12_MAX_ADDRESS 0x07FFFFul
153 #define FLASH12_PAGE_SIZE 256
154 #define FLASH12_CMD_MAX_LEN 8
155 
164 #define FLASH12_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
165 #define FLASH12_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
166  // flash12_set
168 
183 #define FLASH12_MAP_MIKROBUS( cfg, mikrobus ) \
184  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
185  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
186  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
187  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
188  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
189  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_INT )
190  // flash12_map // flash12
193 
198 typedef struct
199 {
200  // Output pins
201  digital_out_t wp;
202  digital_out_t hld;
204  // Modules
205  spi_master_t spi;
207  pin_name_t chip_select;
209 } flash12_t;
210 
215 typedef struct
216 {
217  // Communication gpio pins
218  pin_name_t miso;
219  pin_name_t mosi;
220  pin_name_t sck;
221  pin_name_t cs;
223  // Additional gpio pins
224  pin_name_t wp;
225  pin_name_t hld;
227  // static variable
228  uint32_t spi_speed;
229  spi_master_mode_t spi_mode;
230  spi_master_chip_select_polarity_t cs_polarity;
232 } flash12_cfg_t;
233 
238 typedef enum
239 {
241  FLASH12_ERROR = -1
242 
244 
261 
275 err_t flash12_init ( flash12_t *ctx, flash12_cfg_t *cfg );
276 
290 
304 
318 
332 
346 
358 err_t flash12_write_cmd ( flash12_t *ctx, uint8_t cmd );
359 
374 err_t flash12_write_cmd_data ( flash12_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
375 
390 err_t flash12_read_cmd_data ( flash12_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len );
391 
407 err_t flash12_write_cmd_address_data ( flash12_t *ctx, uint8_t cmd, uint32_t mem_addr, uint8_t *data_in, uint32_t len );
408 
424 err_t flash12_read_cmd_address_data ( flash12_t *ctx, uint8_t cmd, uint32_t mem_addr, uint8_t *data_out, uint32_t len );
425 
441 err_t flash12_memory_write ( flash12_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint32_t len );
442 
458 err_t flash12_memory_read ( flash12_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint32_t len );
459 
471 
484 
497 
510 err_t flash12_read_status ( flash12_t *ctx, uint8_t reg_num, uint8_t *status );
511 
524 err_t flash12_write_status ( flash12_t *ctx, uint8_t status );
525 
540 err_t flash12_erase_memory ( flash12_t *ctx, uint8_t erase_cmd, uint32_t mem_addr );
541 
555 err_t flash12_get_device_id ( flash12_t *ctx, uint8_t *mfr_id, uint8_t *dev_id );
556 
557 #ifdef __cplusplus
558 }
559 #endif
560 #endif // FLASH12_H
561  // flash12
563 
564 // ------------------------------------------------------------------------ END
flash12_return_value_t
flash12_return_value_t
Flash 12 Click return value data.
Definition: flash12.h:239
flash12_cfg_t::hld
pin_name_t hld
Definition: flash12.h:225
flash12_soft_reset
err_t flash12_soft_reset(flash12_t *ctx)
Flash 12 soft reset function.
flash12_cfg_t::mosi
pin_name_t mosi
Definition: flash12.h:219
flash12_t::spi
spi_master_t spi
Definition: flash12.h:205
flash12_get_device_id
err_t flash12_get_device_id(flash12_t *ctx, uint8_t *mfr_id, uint8_t *dev_id)
Flash 12 device ID reading function.
flash12_cfg_t::cs
pin_name_t cs
Definition: flash12.h:221
flash12_write_enable
err_t flash12_write_enable(flash12_t *ctx)
Flash 12 write enable function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
flash12_read_cmd_data
err_t flash12_read_cmd_data(flash12_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len)
Flash 12 command data reading function.
flash12_hw_write_disable
void flash12_hw_write_disable(flash12_t *ctx)
Flash 12 hardware write disable function.
flash12_read_status
err_t flash12_read_status(flash12_t *ctx, uint8_t reg_num, uint8_t *status)
Flash 12 status reading function.
flash12_write_cmd
err_t flash12_write_cmd(flash12_t *ctx, uint8_t cmd)
Flash 12 command writing function.
flash12_default_cfg
err_t flash12_default_cfg(flash12_t *ctx)
Flash 12 default configuration function.
flash12_t
Flash 12 Click context object.
Definition: flash12.h:199
flash12_t::chip_select
pin_name_t chip_select
Definition: flash12.h:207
flash12_t::hld
digital_out_t hld
Definition: flash12.h:202
flash12_memory_write
err_t flash12_memory_write(flash12_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint32_t len)
Flash 12 memory data writing function.
flash12_erase_memory
err_t flash12_erase_memory(flash12_t *ctx, uint8_t erase_cmd, uint32_t mem_addr)
Flash 12 erase memory function.
flash12_read_cmd_address_data
err_t flash12_read_cmd_address_data(flash12_t *ctx, uint8_t cmd, uint32_t mem_addr, uint8_t *data_out, uint32_t len)
Flash 12 command address data reading function.
flash12_cfg_t::spi_speed
uint32_t spi_speed
Definition: flash12.h:228
FLASH12_ERROR
@ FLASH12_ERROR
Definition: flash12.h:241
flash12_write_cmd_address_data
err_t flash12_write_cmd_address_data(flash12_t *ctx, uint8_t cmd, uint32_t mem_addr, uint8_t *data_in, uint32_t len)
Flash 12 command address data writing function.
flash12_hold_enable
void flash12_hold_enable(flash12_t *ctx)
Flash 12 hold enable function.
flash12_cfg_t::wp
pin_name_t wp
Definition: flash12.h:224
flash12_cfg_t::miso
pin_name_t miso
Definition: flash12.h:218
flash12_write_cmd_data
err_t flash12_write_cmd_data(flash12_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len)
Flash 12 command data writing function.
flash12_cfg_t
Flash 12 Click configuration object.
Definition: flash12.h:216
FLASH12_OK
@ FLASH12_OK
Definition: flash12.h:240
flash12_memory_read
err_t flash12_memory_read(flash12_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint32_t len)
Flash 12 memory data reading function.
flash12_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: flash12.h:229
flash12_hw_write_enable
void flash12_hw_write_enable(flash12_t *ctx)
Flash 12 hardware write enable function.
flash12_cfg_setup
void flash12_cfg_setup(flash12_cfg_t *cfg)
Flash 12 configuration object setup function.
flash12_t::wp
digital_out_t wp
Definition: flash12.h:201
flash12_hold_disable
void flash12_hold_disable(flash12_t *ctx)
Flash 12 hold disable function.
flash12_cfg_t::sck
pin_name_t sck
Definition: flash12.h:220
flash12_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: flash12.h:230
flash12_write_disable
err_t flash12_write_disable(flash12_t *ctx)
Flash 12 write disable function.
flash12_init
err_t flash12_init(flash12_t *ctx, flash12_cfg_t *cfg)
Flash 12 initialization function.
flash12_write_status
err_t flash12_write_status(flash12_t *ctx, uint8_t status)
Flash 12 status writing function.