spi_memory_t Struct Reference

#include <spi-memory.h>

Collaboration diagram for spi_memory_t:

Data Fields
const struct spi_t *	Spi
struct spi_memory_state_t *	State
struct spi_cs_t	ChipSelect
uint32_t	Baudrate
uint8_t	MemorySizeExponent
uint8_t	PageSizeExponent
uint8_t	SectorSizeExponent
uint8_t	BlockSizeExponent
uint32_t	AddressBytes: 3
uint32_t	HasPowerControl: 1
uint32_t	HasProtection: 1
uint32_t	HasChipErase: 1
uint32_t	HasWriteEnable: 1
uint32_t	HasProgrammingTime: 1
uint32_t	HasPowerPort: 1
uint32_t	PowerPin: 5
uint32_t	PowerActiveHigh: 1
uint32_t	Hint: 8
uint16_t	EnterPdTimeUs
uint16_t	ReleasePdTimeAfterCommandUs
uint16_t	ReleasePdTimeAfterCsActiveUs
uint16_t	VccPowerUpTimeUs
uint8_t	PowerUpTimeMs

Detailed Description

spi_memory_t structure is used for configuration of SPI-based memory. The structure must be initialized before the memory driver may be used.

Definition at line 86 of file spi-memory.h.

Field Documentation

const struct spi_t* spi_memory_t::Spi

SPI instance

Definition at line 88 of file spi-memory.h.

struct spi_memory_state_t* spi_memory_t::State

Pointer to the dynamic SPI memory state

Definition at line 89 of file spi-memory.h.

struct spi_cs_t spi_memory_t::ChipSelect

Chip select

Definition at line 90 of file spi-memory.h.

uint32_t spi_memory_t::Baudrate

Baudrate

Definition at line 91 of file spi-memory.h.

uint8_t spi_memory_t::MemorySizeExponent

Exponent for memory size (example value 15: 2^15 = 32768)

Definition at line 92 of file spi-memory.h.

uint8_t spi_memory_t::PageSizeExponent

Exponent for page size

Definition at line 93 of file spi-memory.h.

Referenced by SpiMemoryReadPage(), SpiMemoryReadPageAsync(), SpiMemoryReadPageWithOffset(), SpiMemoryReadPageWithOffsetAsync(), SpiMemoryVerifyPage(), SpiMemoryWritePage(), and SpiMemoryWritePageAsync().

uint8_t spi_memory_t::SectorSizeExponent

Exponent for sector size

Definition at line 94 of file spi-memory.h.

uint8_t spi_memory_t::BlockSizeExponent

Exponent for block size

Definition at line 95 of file spi-memory.h.

uint32_t spi_memory_t::AddressBytes

Number of bytes in the address

Definition at line 96 of file spi-memory.h.

uint32_t spi_memory_t::HasPowerControl

true if memory has power down instruction

Definition at line 97 of file spi-memory.h.

uint32_t spi_memory_t::HasProtection

true if memory has protection bits

Definition at line 98 of file spi-memory.h.

uint32_t spi_memory_t::HasChipErase

true if memory has chip erase instruction

Definition at line 99 of file spi-memory.h.

uint32_t spi_memory_t::HasWriteEnable

true if memory has write enable instruction

Definition at line 100 of file spi-memory.h.

uint32_t spi_memory_t::HasProgrammingTime

true if memory needs programming time after a programming instruction

Definition at line 101 of file spi-memory.h.

uint32_t spi_memory_t::HasPowerPort

true if memory power pin is controlled by external power switch

Definition at line 102 of file spi-memory.h.

uint32_t spi_memory_t::PowerPin

If HasPowerPort = true: Set port pin (0 - 31)

Definition at line 104 of file spi-memory.h.

uint32_t spi_memory_t::PowerActiveHigh

If HasPowerPort = true: Set true if PowerPin is active high, else false

Definition at line 105 of file spi-memory.h.

uint32_t spi_memory_t::Hint

!= 0 if memory need special program

Definition at line 107 of file spi-memory.h.

uint16_t spi_memory_t::EnterPdTimeUs

Time needed to enter power down (us)

Definition at line 108 of file spi-memory.h.

uint16_t spi_memory_t::ReleasePdTimeAfterCommandUs

Time needed to release from power down after release command (us)

Definition at line 109 of file spi-memory.h.

uint16_t spi_memory_t::ReleasePdTimeAfterCsActiveUs

Time needed to release from power down after chip select active (us)

Definition at line 110 of file spi-memory.h.

uint16_t spi_memory_t::VccPowerUpTimeUs

If HasPowerPort = true: Time needed after PowerPin is active (us)

Definition at line 111 of file spi-memory.h.

uint8_t spi_memory_t::PowerUpTimeMs

Time needed after power on (ms)

Definition at line 112 of file spi-memory.h.