flash7.h File Reference

This file contains API for Flash 7 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures
struct	flash7_t
	Flash 7 Click context object. More...
struct	flash7_cfg_t
	Flash 7 Click configuration object. More...

Macros
#define	FLASH7_STAT_REG_LSB_SRP0   0x80
	Flash 7 description register.
#define	FLASH7_STAT_REG_LSB_BP4   0x40
#define	FLASH7_STAT_REG_LSB_BP3   0x20
#define	FLASH7_STAT_REG_LSB_BP2   0x10
#define	FLASH7_STAT_REG_LSB_BP1   0x08
#define	FLASH7_STAT_REG_LSB_BP0   0x04
#define	FLASH7_STAT_REG_LSB_WEL   0x02
#define	FLASH7_STAT_REG_LSB_WIP   0x01
#define	FLASH7_STAT_REG_MSB_SUS1   0x80
	Flash 7 MSB status registers.
#define	FLASH7_STAT_REG_MSB_CMP   0x40
#define	FLASH7_STAT_REG_MSB_LB3   0x20
#define	FLASH7_STAT_REG_MSB_LB2   0x10
#define	FLASH7_STAT_REG_MSB_LB1   0x08
#define	FLASH7_STAT_REG_MSB_SUS2   0x04
#define	FLASH7_STAT_REG_MSB_QE   0x02
#define	FLASH7_STAT_REG_MSB_SRP1   0x01
#define	FLASH7_MEMORY_ADDR_START   0x00000000
	Flash 7 Memory address boundary.
#define	FLASH7_MEMORY_ADDR_END   0x00FFFFFF
#define	FLASH7_MEM_SECTOR_LEN   0x00001000
#define	FLASH7_MEMORY_BLOCK_SIZE   0x00008000
#define	FLASH7_CMD_WRSR   0x01
	Flash 7 description setting.
#define	FLASH7_CMD_WRITE   0x02
#define	FLASH7_CMD_READ   0x03
#define	FLASH7_CMD_WRDI   0x04
#define	FLASH7_CMD_RDSR_LSB   0x05
#define	FLASH7_CMD_RDSR_MSB   0x35
#define	FLASH7_CMD_WREN   0x06
#define	FLASH7_CMD_FREAD   0x0B
#define	FLASH7_CMD_WEVSR   0x50
#define	FLASH7_CMD_SE   0x20
#define	FLASH7_CMD_BE_32KB   0x52
#define	FLASH7_CMD_BE_64KB   0xD8
#define	FLASH7_CMD_CE   0x60
#define	FLASH7_CMD_SLEEP   0xB9
#define	FLASH7_CMD_WAKE   0xAB
#define	FLASH7_CMD_REMS   0x90
#define	FLASH7_CMD_RDID   0x9F
#define	FLASH7_CMD_ID   0x4B
#define	FLASH7_CMD_ENRES   0x66
#define	FLASH7_CMD_RES   0x99
#define	FLASH7_WRITE_PROTECT_DISABLE   0x00
	Flash 7 write protect.
#define	FLASH7_WRITE_PROTECT_ENABLE   0x01
#define	FLASH7_HOLD_DISABLE   0x00
	Flash 7 hold.
#define	FLASH7_HOLD_ENABLE   0x01
#define	FLASH7_DUMMY   0x00
	Dummy data.
#define	FLASH7_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	flash7_return_value_t { FLASH7_OK = 0 , FLASH7_ERROR = -1 }
	Flash 7 Click return value data. More...

Functions
void	flash7_cfg_setup (flash7_cfg_t *cfg)
	Flash 7 configuration object setup function.
err_t	flash7_init (flash7_t *ctx, flash7_cfg_t *cfg)
	Flash 7 initialization function.
err_t	flash7_default_cfg (flash7_t *ctx)
	Flash 7 default configuration function.
err_t	flash7_generic_write (flash7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	Flash 7 data writing 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_write_protect (flash7_t *ctx, uint8_t en_write_protect)
	Enable write protect 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.
void	flash7_write_enable (flash7_t *ctx)
	Write enable function.
void	flash7_write_disable (flash7_t *ctx)
	Write disable function.
void	flash7_chip_erase (flash7_t *ctx)
	Chip erase function.
uint8_t	flash7_read_status_register (flash7_t *ctx, uint8_t status_byte)
	Read status register function.
void	flash7_write_status_register (flash7_t *ctx, uint16_t status_data)
	Write status register 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_read_memory (flash7_t *ctx, uint32_t mem_addr, uint8_t *p_rx_data, uint16_t n_bytes)
	Read memory 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.
uint8_t	flash7_sector_erase (flash7_t *ctx, uint16_t mem_sector)
	Sector erase function.
uint8_t	flash7_block_erase (flash7_t *ctx, uint8_t mem_block, uint8_t mem_block_len)
	Block erase function.
void	flash7_go_to_sleep (flash7_t *ctx)
	Go to sleep mode function.
uint8_t	flash7_wake_up (flash7_t *ctx)
	Wake up function.
void	flash7_read_id (flash7_t *ctx, uint8_t *manufacturer_id, uint8_t *device_id)
	Read ID 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_sw_reset (flash7_t *ctx)
	Soft reset function.

Detailed Description

This file contains API for Flash 7 Click Driver.

Enumeration Type Documentation

flash7_return_value_t

enum flash7_return_value_t

Flash 7 Click return value data.

Predefined enum values for driver return values.

Enumerator
FLASH7_OK
FLASH7_ERROR