W25Q128

Data Structures
struct	W25Q128_t

Functions
W25Q128_t	W25Q128_init (W25Q128_t *, SPI_t *, GPIOpin_t)
	Initialise flash struct.
void	W25Q128_readPage (W25Q128_t *, uint32_t, volatile uint8_t *)
	Read from flash.
void	W25Q128_writePage (W25Q128_t *, uint32_t, uint8_t *)
	Write page to flash.
void	W25Q128_erase (W25Q128_t *)
	Erase flash chip.
void	_W25Q128_writeEnable (W25Q128_t *)
	Send Write Enable instruction to the flash device.
void	_W25Q128_readStatus1 (W25Q128_t *, uint8_t *)
	Read from Status Register 1.
void	_W25Q128_readStatus2 (W25Q128_t *, uint8_t *)
	Read from Status Register 2.
void	_W25Q128_readStatus3 (W25Q128_t *, uint8_t *)
	Read from Status Register 3.

Detailed Description

---

Data Structure Documentation

W25Q128_t

struct W25Q128_t

Definition at line 31 of file w25q128.h.

Data Fields
SPI_t *	base	Parent SPI interface.
GPIOpin_t	cs	Chip select GPIO.
int	pageSize	Number of bytes per page.
long	pageCount	Total number of pages.
void(*)(struct W25Q128 *)	erase	Chip erase method. See also W25Q128_erase
void(*)(struct W25Q128 *, uint32_t, volatile uint8_t *)	readPage	Read page method. See also W25Q128_readPage
void(*)(struct W25Q128 *, uint32_t, uint8_t *)	writePage	Write page method. See also W25Q128_writePage

Function Documentation

W25Q128_init()

W25Q128_t W25Q128_init	(	W25Q128_t *	flash,
		SPI_t *	spi,
		GPIOpin_t	cs )

Initialise flash struct.

Parameters

*flash	Pointer to Flash struct.
*port	Pointer to GPIO port.
cs	Address to flash chip select.

Returns

NULL.

---

Definition at line 23 of file w25q128.c.

W25Q128_readPage()

void W25Q128_readPage	(	W25Q128_t *	flash,
		uint32_t	address,
		volatile uint8_t *	data )

Read from flash.

Parameters

*flash	Pointer to Flash struct.
address	Address in memory to write to.
*data	Pointer to start of page buffer to read to.

Returns

NULL.

---

Definition at line 195 of file w25q128.c.

W25Q128_writePage()

void W25Q128_writePage	(	W25Q128_t *	flash,
		uint32_t	address,
		uint8_t *	data )

Write page to flash.

Parameters

*flash	Pointer to Flash struct.
address	Address in memory to write to.
*data	Pointer to start of page buffer to write.

Returns

NULL.

---

Definition at line 157 of file w25q128.c.

W25Q128_erase()

void W25Q128_erase

(

W25Q128_t *

flash

)

Erase flash chip.

Parameters

*flash

Pointer to Flash struct.

Returns

NULL.

---

Definition at line 129 of file w25q128.c.

_W25Q128_writeEnable()

void _W25Q128_writeEnable

(

W25Q128_t *

flash

)

Send Write Enable instruction to the flash device.

Parameters

*flash

Pointer to Flash struct.

Returns

NULL.

---

Definition at line 51 of file w25q128.c.

_W25Q128_readStatus1()

void _W25Q128_readStatus1	(	W25Q128_t *	flash,
		uint8_t *	status )

Read from Status Register 1.

Parameters

*flash	Pointer to Flash struct.
*status	Pointer to status output variable.

Returns

NULL.

---

Definition at line 69 of file w25q128.c.

_W25Q128_readStatus2()

void _W25Q128_readStatus2	(	W25Q128_t *	flash,
		uint8_t *	status )

Read from Status Register 2.

Parameters

*flash	Pointer to Flash struct.
*status	Pointer to status output variable.

Returns

NULL.

---

Definition at line 88 of file w25q128.c.

_W25Q128_readStatus3()

void _W25Q128_readStatus3	(	W25Q128_t *	flash,
		uint8_t *	status )

Read from Status Register 3.

Parameters

*flash	Pointer to Flash struct.
*status	Pointer to status output variable.

Returns

NULL.

---

Definition at line 107 of file w25q128.c.