rtems_flashdev Struct Reference

Flash device. More...

#include <flashdev.h>

Data Fields
int(*	read )(rtems_flashdev *flash, uintptr_t offset, size_t count, void *buffer)
	Call to the device driver to read the flash device.
int(*	write )(rtems_flashdev *flash, uintptr_t offset, size_t count, const void *buffer)
	Call to the device driver to write to the flash device.
int(*	erase )(rtems_flashdev *flash, uintptr_t offset, size_t count)
	Call to the device driver to erase the flash device.
uint32_t(*	jedec_id )(rtems_flashdev *flash)
	Call to the device driver to return the JEDEC ID.
int(*	flash_type )(rtems_flashdev *flash, rtems_flashdev_flash_type *type)
	Call to the device driver to return the flash type.
int(*	page_info_by_offset )(rtems_flashdev *flash, off_t search_offset, off_t *page_offset, size_t *page_size)
	Call to device driver to get size and offset of page at given offset.
int(*	page_info_by_index )(rtems_flashdev *flashdev, off_t search_index, off_t *page_offset, size_t *page_size)
	Call to device driver to get size and offset of page at given index.
int(*	page_count )(rtems_flashdev *flashdev, int *page_count)
	Call to device driver to return the number of pages on the flash device.
int(*	write_block_size )(rtems_flashdev *flashdev, size_t *write_block_size)
	Call to device driver to return the minimum write size of the flash device.
void(*	destroy )(rtems_flashdev *flashdev)
	Destroys the flash device.
void *	driver
	Pointer to device driver.
rtems_recursive_mutex	mutex
	Mutex to protect the flash device access.
rtems_flashdev_region_table *	region_table
	Region table defining size and memory for region allocations.

Detailed Description

Flash device.

Field Documentation

destroy

void(* rtems_flashdev::destroy) (rtems_flashdev *flashdev)

Destroys the flash device.

Parameters

[in]

flash

Pointer to flash device.

erase

int(* rtems_flashdev::erase) (rtems_flashdev *flash, uintptr_t offset, size_t count)

Call to the device driver to erase the flash device.

Parameters

[in]	flash	Pointer to flash device.
[in]	offset	Address to erase at.
[in]	count	Number of bytes to erase.

Return values

0	Successful operation.
1	Failed operation.

flash_type

int(* rtems_flashdev::flash_type) (rtems_flashdev *flash, rtems_flashdev_flash_type *type)

Call to the device driver to return the flash type.

Parameters

[in]	flash	The flash device.
[out]	type	The type of flash device.

Return values

0	Success @retbal Other Failure

jedec_id

uint32_t(* rtems_flashdev::jedec_id) (rtems_flashdev *flash)

Call to the device driver to return the JEDEC ID.

Parameters

[in]

flash

The flash device.

Return values

JEDEC

ID.

page_count

int(* rtems_flashdev::page_count) (rtems_flashdev *flashdev, int *page_count)

Call to device driver to return the number of pages on the flash device.

Parameters

[out]

page_count

The number of pages on the flash device.

Return values

0	Success.
non-zero	Failed.

page_info_by_index

int(* rtems_flashdev::page_info_by_index) (rtems_flashdev *flashdev, off_t search_index, off_t *page_offset, size_t *page_size)

Call to device driver to get size and offset of page at given index.

Parameters

[in]	flash	The flash device
[in]	search_index	The index of the page which info is to be returned.
[out]	page_offset	The offset of the start of the page
[out]	page_size	The size of the page

Return values

0	Success.
non-zero	Failed.

page_info_by_offset

int(* rtems_flashdev::page_info_by_offset) (rtems_flashdev *flash, off_t search_offset, off_t *page_offset, size_t *page_size)

Call to device driver to get size and offset of page at given offset.

Parameters

[in]	flash	The flash device
[in]	search_offset	The offset of the page which info is to be returned.
[out]	page_offset	The offset of the start of the page
[out]	page_size	The size of the page

Return values

0	Success.
non-zero	Failed.

read

int(* rtems_flashdev::read) (rtems_flashdev *flash, uintptr_t offset, size_t count, void *buffer)

Call to the device driver to read the flash device.

Parameters

[in]	flash	Pointer to flash device.
[in]	offset	Address to read from.
[in]	count	Number of bytes to read.
[out]	buffer	Buffer for data to be read into.

Return values

0	Successful operation.
1	Failed operation.

write

int(* rtems_flashdev::write) (rtems_flashdev *flash, uintptr_t offset, size_t count, const void *buffer)

Call to the device driver to write to the flash device.

Parameters

[in]	flash	Pointer to flash device.
[in]	offset	Address to write to.
[in]	count	Number of bytes to read.
[in]	buffer	Buffer for data to be written from.

Return values

0	Successful operation.
1	Failed operation.

write_block_size

int(* rtems_flashdev::write_block_size) (rtems_flashdev *flashdev, size_t *write_block_size)

Call to device driver to return the minimum write size of the flash device.

Parameters

[out]

write_block_size

The minimum write size of the flash device.

Return values

0	Success.
non-zero	Failed.

---

The documentation for this struct was generated from the following file:

• cpukit/include/dev/flash/flashdev.h