Modules | Defines | Functions

Dataflash Driver - LUFA/Drivers/Board/Dataflash.h
[Board Drivers]

Modules

 EVK527
 STK525
 STK526
 USBKEY
 XPLAIN

Defines

#define DATAFLASH_CHIP_MASK(index)   __GET_DATAFLASH_MASK(index)

Functions

static void Dataflash_Init (void)
static uint8_t Dataflash_GetSelectedChip (void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT
static void Dataflash_SelectChip (const uint8_t ChipMask) ATTR_ALWAYS_INLINE
static void Dataflash_DeselectChip (void) ATTR_ALWAYS_INLINE
static void Dataflash_SelectChipFromPage (const uint16_t PageAddress)
static void Dataflash_ToggleSelectedChipCS (void)
static void Dataflash_WaitWhileBusy (void)
static void Dataflash_SendAddressBytes (uint16_t PageAddress, const uint16_t BufferByte)
static uint8_t Dataflash_TransferByte (const uint8_t Byte) ATTR_ALWAYS_INLINE
static void Dataflash_SendByte (const uint8_t Byte) ATTR_ALWAYS_INLINE
static uint8_t Dataflash_ReceiveByte (void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT

Detailed Description

Module Source Dependencies

The following files must be built with any user project that uses this module:

Description

Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards, for the storage of large amounts of data into the Dataflash's non-volatile memory.

If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project directory. Otherwise, it will include the appropriate built in board driver header file.


Define Documentation

#define DATAFLASH_CHIP_MASK (   index  )     __GET_DATAFLASH_MASK(index)

Retrieves the Dataflash chip select mask for the given Dataflash chip index.

Parameters:
[in] index Index of the dataflash chip mask to retrieve
Returns:
Mask for the given Dataflash chip's /CS pin

Function Documentation

static void Dataflash_DeselectChip ( void   )  [inline, static]

Deselects the current dataflash chip, so that no dataflash is selected.

static uint8_t Dataflash_GetSelectedChip ( void   )  [inline, static]

Determines the currently selected dataflash chip.

Returns:
Mask of the currently selected Dataflash chip, either DATAFLASH_NO_CHIP if no chip is selected or a DATAFLASH_CHIPn mask (where n is the chip number).
static void Dataflash_Init ( void   )  [inline, static]

Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.

static uint8_t Dataflash_ReceiveByte ( void   )  [inline, static]

Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.

Returns:
Last response byte from the dataflash
static void Dataflash_SelectChip ( const uint8_t  ChipMask  )  [inline, static]

Selects the given dataflash chip.

Parameters:
[in] ChipMask Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is the chip number).
static void Dataflash_SelectChipFromPage ( const uint16_t  PageAddress  )  [inline, static]

Selects a dataflash IC from the given page number, which should range from 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside the total number of pages contained in the boards dataflash ICs, all dataflash ICs are deselected.

Parameters:
[in] PageAddress Address of the page to manipulate, ranging from ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
static void Dataflash_SendAddressBytes ( uint16_t  PageAddress,
const uint16_t  BufferByte 
) [inline, static]

Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with dataflash commands which require a complete 24-byte address.

Parameters:
[in] PageAddress Page address within the selected dataflash IC
[in] BufferByte Address within the dataflash's buffer
static void Dataflash_SendByte ( const uint8_t  Byte  )  [inline, static]

Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.

Parameters:
[in] Byte of data to send to the dataflash
static void Dataflash_ToggleSelectedChipCS ( void   )  [inline, static]

Toggles the select line of the currently selected dataflash IC, so that it is ready to receive a new command.

static uint8_t Dataflash_TransferByte ( const uint8_t  Byte  )  [inline, static]

Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.

Parameters:
[in] Byte of data to send to the dataflash
Returns:
Last response byte from the dataflash
static void Dataflash_WaitWhileBusy ( void   )  [inline, static]

Spin-loops while the currently selected dataflash is busy executing a command, such as a main memory page program or main memory to buffer transfer.