Go to the documentation of this file.
38 #include "mikrosdk_version.h"
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
63 #define FLASH5_MAP_MIKROBUS( cfg, mikrobus ) \
64 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68 cfg.wp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69 cfg.hld = MIKROBUS( mikrobus, MIKROBUS_PWM );
76 #define FLASH5_RETVAL uint8_t
78 #define FLASH5_OK 0x00
79 #define FLASH5_INIT_ERROR 0xFF
86 #define FLASH5_MAX_addr 0xFFFF
87 #define FLASH5_PAGESIZE 2048
94 #define FLASH5_CMD_RESET 0xFF
95 #define FLASH5_CMD_DEVICE_ID 0x9F
96 #define FLASH5_CMD_READ_REG_STATUS1 0x05
97 #define FLASH5_CMD_READ_REG_STATUS2 0x0F
98 #define FLASH5_CMD_WRITE_REG_STATUS1 0x01
99 #define FLASH5_CMD_WRITE_REG_STATUS2 0x1F
100 #define FLASH5_CMD_WRITE_ENABLE 0x06
101 #define FLASH5_CMD_WRITE_DISABLE 0x04
102 #define FLASH5_CMD_BAD_BLOCK_MANAGE 0xA1
103 #define FLASH5_CMD_READ_BBM_TABLE 0xA5
104 #define FLASH5_CMD_LAST_ECC_FAIL_PAGE 0xA9
105 #define FLASH5_CMD_BLOCK_ERASE 0xD8
106 #define FLASH5_CMD_LOAD_DATA 0x02
107 #define FLASH5_CMD__RND_LOAD_DATA 0x84
108 #define FLASH5_CMD_QUAD_LOAD_DATA 0x32
109 #define FLASH5_CMD_QUAD_RND_LOAD_DATA 0x34
110 #define FLASH5_CMD_EXECUTE 0x10
111 #define FLASH5_CMD_PAGE_READ_DATA 0x13
112 #define FLASH5_CMD_READ_DATA 0x03
113 #define FLASH5_CMD_FAST_READ 0x0B
114 #define FLASH5_CMD_FAST_READ_4BYTE_addr 0x0C
115 #define FLASH5_CMD_FAST_READ_DUAL_OUT 0x3B
116 #define FLASH5_CMD_FAST_READ_DUAL_OUT_4BYTE_addr 0x3C
117 #define FLASH5_CMD_FAST_READ_QUAD_OUT 0x6B
118 #define FLASH5_CMD_FAST_READ_QUAD_OUT_4BYTE_addr 0x6C
119 #define FLASH5_CMD_FAST_READ_DUAL_IO 0xBB
120 #define FLASH5_CMD_FAST_READ_IO_4BYTE_addr 0xBC
121 #define FLASH5_CMD_FAST_READ_QUAD_IO 0xEB
122 #define FLASH5_CMD_FAST_READ_QUAD_IO_4BYTE_addr 0xEC
129 #define FLASH5_REG_STATUS_1 0xA0
130 #define FLASH5_REG_STATUS_2 0xB0
131 #define FLASH5_REG_STATUS_3 0xC0
138 #define FLASH5_RS1_WRITE_PROTECTION_ENABLE 0x02
139 #define FLASH5_RS1_WRITE_PROTECTION_DISABLE 0x00
140 #define FLASH5_RS1_SRP1_ENABLE 0x01
141 #define FLASH5_RS1_SRP2_ENABLE 0x80
148 #define FLASH5_RS2_PAGE_READ_MODE 0x08
149 #define FLASH5_RS2_PAGE_CONTINOUS_READ_MODE 0x00
150 #define FLASH5_RS2_ECC_ENABLED 0x10
151 #define FLASH5_RS2_ECC_DISABLED 0x10
152 #define FLASH5_RS2_OTP_LOCK 0x80
153 #define FLASH5_RS2_OTP_ACCESS 0x40
154 #define FLASH5_RS2_REG_STATUS_1_LOCK 0x20
161 #define FLASH5_DEVICE_OK 0xFF
162 #define FLASH5_DEVICE_ERROR 0xAA
169 #define FLASH5_PIN_STATUS_HIGH 1
170 #define FLASH5_PIN_STATUS_LOW 0
266 uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
spi_master_chip_select_polarity_t cs_polarity
Definition: flash5.h:219
uint8_t flash5_set_hold_pin(flash5_t *ctx, uint8_t status)
Sets hold pin to one state.
#define FLASH5_RETVAL
Definition: flash5.h:76
void flash5_send_cmd(flash5_t *ctx, uint8_t cmd_data)
Function for sending one Byte od data.
void flash5_erase_page_data(flash5_t *ctx, uint16_t page_addr)
Function for eraseing one page.
pin_name_t sck
Definition: flash5.h:207
pin_name_t miso
Definition: flash5.h:205
FLASH5_RETVAL flash5_init(flash5_t *ctx, flash5_cfg_t *cfg)
Initialization function.
digital_out_t wp
Definition: flash5.h:188
void flash5_write_data(flash5_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint16_t n_buf_size)
Generic funcion for writing.
void flash5_read_data(flash5_t *ctx, uint8_t reg_addr, uint8_t *data_buf, uint16_t n_buf_size)
Generic funcion for reading.
void flash5_generic_transfer(flash5_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
digital_out_t hld
Definition: flash5.h:189
void flash5_page_read(flash5_t *ctx, uint16_t page_num)
Function for setting page read.
pin_name_t wp
Definition: flash5.h:212
Click ctx object definition.
Definition: flash5.h:184
Click configuration structure definition.
Definition: flash5.h:202
void flash5_execute_load(flash5_t *ctx, uint16_t page_num)
Function for executing page load.
pin_name_t mosi
Definition: flash5.h:206
void flash5_write_status_data(flash5_t *ctx, uint8_t status_cmd, uint8_t status_addr, uint8_t status_data)
Function for writing status data.
pin_name_t hld
Definition: flash5.h:213
void flash5_software_reset(flash5_t *ctx)
Function for reseting device.
uint32_t spi_speed
Definition: flash5.h:217
void flash5_page_read_memory(flash5_t *ctx, uint16_t column_addr, uint8_t *data_buf, uint16_t buf_size)
Function for reading one page.
pin_name_t chip_select
Definition: flash5.h:194
uint8_t flash5_read_status_data(flash5_t *ctx, uint8_t status_cmd, uint8_t status_addr)
Function for reading status data.
uint8_t flash5_device_id_check(flash5_t *ctx)
Funcion for checking device id.
spi_master_mode_t spi_mode
Definition: flash5.h:218
digital_out_t cs
Definition: flash5.h:187
spi_master_t spi
Definition: flash5.h:193
void flash5_continous_read_memory(flash5_t *ctx, uint8_t *data_buf, uint16_t buf_size)
Function for continous reading.
void flash5_cfg_setup(flash5_cfg_t *cfg)
Config Object Initialization function.
pin_name_t cs
Definition: flash5.h:208
void flash5_page_load_memory(flash5_t *ctx, uint16_t column_addr, uint8_t *data_buf, uint16_t buf_size)
Function for loading one page.
uint8_t flash5_set_wp_pin(flash5_t *ctx, uint8_t status)
Sets wp pin to one state.