Base class for implementing block devices and other file drivers which can be seeked and addressed by absolute byte offsets. More...

#include <DeviceFile.hxx>

Inheritance diagram for DeviceFile:

Protected Member Functions
	DeviceFile (const char *name)
	Constructor.

	~DeviceFile ()
	Destructor.

virtual ssize_t	write (unsigned int index, const void *buf, size_t len)=0
	Write to the DeviceFile.

virtual ssize_t	read (unsigned int index, void *buf, size_t len)=0
	Read from the DeviceFile.

int	open (File file, const char path, int flags, int mode) OVERRIDE
	Open a device.

Protected Member Functions inherited from Node
	Node (const char *name)
	Constructor.

virtual	~Node ()
	Destructor.

int	open (File , const char , int, int) OVERRIDE
	Open method.

int	close (File *) OVERRIDE
	Close method.

virtual int	fstat (File file, struct stat stat) override
	Get the status information of a file or device.

Protected Member Functions inherited from FileIO
	FileIO (const char *name)
	Constructor.

virtual	~FileIO ()
	Destructor.

virtual off_t	lseek (File *f, off_t offset, int whence)
	Seek method.

virtual int	ioctl (File *file, unsigned long int key, unsigned long data)
	Request an ioctl transaction.

virtual int	fcntl (File *file, int cmd, unsigned long data)
	Manipulate a file descriptor.

virtual bool	select (File *file, int mode)
	Device select method.

Private Member Functions
ssize_t	read (File file, void buf, size_t count) OVERRIDE
	Read from a file or device.

ssize_t	write (File file, const void buf, size_t count) OVERRIDE
	Write to a file or device.

void	enable () OVERRIDE
	function to enable device

void	disable () OVERRIDE
	function to disable device

void	flush_buffers () OVERRIDE
	Discards all pending buffers.

	DeviceFile ()
	Default constructor.

	DISALLOW_COPY_AND_ASSIGN (DeviceFile)

Additional Inherited Members
Public Member Functions inherited from Device
	Device (const char *name)
	Constructor.

virtual	~Device ()
	Destructor.

Static Public Member Functions inherited from Device
static int	open (struct _reent reent, const char path, int flags, int mode)
	Open a file or device.

static int	close (struct _reent *reent, int fd)
	Close a file or device.

static int	stat (struct _reent reent, const char path, struct stat *stat)
	Get the status information of a file or device.

static int	select (int nfds, fd_set readfds, fd_set writefds, fd_set *exceptfds, long long timeout)
	POSIX select().

static void	select_clear ()
	Clears the current thread's select bits.

Static Public Member Functions inherited from FileIO
static ssize_t	read (struct _reent reent, int fd, void buf, size_t count)
	Read from a file or device.

static ssize_t	write (struct _reent reent, int fd, const void buf, size_t count)
	Write to a file or device.

static _off_t	lseek (struct _reent *reent, int fd, _off_t offset, int whence)
	Change the offset index of a file or device.

static int	fstat (struct _reent reent, int fd, struct stat stat)
	Get the status information of a file or device.

static int	ioctl (int fd, unsigned long int key, unsigned long data)
	Request and ioctl transaction.

static int	fcntl (int fd, int cmd, unsigned long data)
	Manipulate a file descriptor.

static bool	is_device (int fd)
	Test if the file descriptor belongs to a device.

Static Protected Member Functions inherited from Device
static void	select_insert (SelectInfo *info)
	Add client to list of clients needing woken.

static void	select_wakeup (SelectInfo *info)
	Wakeup the list of clients needing woken.

static void	select_wakeup_from_isr (SelectInfo info, int woken)
	Wakeup the list of clients needing woken.

Static Protected Member Functions inherited from FileIO
static int	fd_alloc (void)
	Allocate a free file descriptor.

static void	fd_free (int fd)
	Free up a file descriptor.

static File *	file_lookup (int fd)
	Looks up a reference to a File corresponding to a given file descriptor.

static int	fd_lookup (File *file)
	Looks up a file descriptor corresponding to a given File reference.

Protected Attributes inherited from Node
OSMutex	lock_
	protects internal structures.

mode_t	mode_
	File open mode, such as O_NONBLOCK.

unsigned int	references_
	number of open references

Protected Attributes inherited from FileIO
const char *	name
	device name

Static Protected Attributes inherited from FileIO
static const unsigned int	numOpenFiles = 20

static File	files []
	File descriptor pool.

static OSMutex	mutex
	mutual exclusion for fileio

Detailed Description

Base class for implementing block devices and other file drivers which can be seeked and addressed by absolute byte offsets.

Definition at line 47 of file DeviceFile.hxx.

Constructor & Destructor Documentation

◆ DeviceFile()

DeviceFile::DeviceFile ( const char * name )

inlineprotected

Constructor.

Parameters

name	device file name

Definition at line 53 of file DeviceFile.hxx.

◆ ~DeviceFile()

DeviceFile::~DeviceFile ( )

inlineprotected

Destructor.

Definition at line 60 of file DeviceFile.hxx.

Member Function Documentation

◆ disable()

void DeviceFile::disable ( )

inlineprivatevirtual

function to disable device

Implements Node.

Definition at line 109 of file DeviceFile.hxx.

◆ enable()

void DeviceFile::enable ( )

inlineprivatevirtual

function to enable device

Implements Node.

Definition at line 108 of file DeviceFile.hxx.

◆ flush_buffers()

void DeviceFile::flush_buffers ( )

inlineprivatevirtual

Discards all pending buffers.

Called after disable().

Implements Node.

Definition at line 112 of file DeviceFile.hxx.

◆ open()

int DeviceFile::open	(	File *	file,
		const char *	path,
		int	flags,
		int	mode
	)

protectedvirtual

Open a device.

Parameters

file	new file reference to this device
path	file or device name
flags	open flags
mode	open mode

Returns: 0 upon success, negative errno upon failure

Implements FileIO.

Reimplemented in FlashFile< FLASH >.

Definition at line 45 of file DeviceFile.cxx.

◆ read() [1/2]

ssize_t DeviceFile::read	(	File *	file,
		void *	buf,
		size_t	count
	)

privatevirtual

Read from a file or device.

Parameters

file	file reference for this device
buf	location to place read data
count	number of bytes to read

Returns: number of bytes read upon success, -errno upon failure

Implements FileIO.

Definition at line 68 of file DeviceFile.cxx.

◆ read() [2/2]

virtual ssize_t DeviceFile::read	(	unsigned int	index,
		void *	buf,
		size_t	len
	)

protectedpure virtual

Read from the DeviceFile.

Parameters

index	index within DeviceFile address space to start read
buf	location to post read data
len	length in bytes of data to read

Returns: number of bytes read upon success, -errno upon failure

Implemented in FlashFile< FLASH >, CC32xxDeviceFile, and TivaEEPROMFile.

◆ write() [1/2]

ssize_t DeviceFile::write	(	File *	file,
		const void *	buf,
		size_t	count
	)

privatevirtual

Write to a file or device.

Parameters

file	file reference for this device
buf	location to find write data
count	number of bytes to write

Returns: number of bytes written upon success, -errno upon failure

Implements FileIO.

Definition at line 98 of file DeviceFile.cxx.

◆ write() [2/2]

virtual ssize_t DeviceFile::write	(	unsigned int	index,
		const void *	buf,
		size_t	len
	)

protectedpure virtual

Write to the DeviceFile.

NOTE!!! This is not necessarily atomic across byte boundaries in the case of power loss. The user should take this into account as it relates to data integrity of a whole block.

Parameters

index	index within DeviceFile address space to start write
buf	data to write
len	length in bytes of data to write

Returns: number of bytes written upon success, -errno upon failure

Implemented in FlashFile< FLASH >, CC32xxDeviceFile, and TivaEEPROMFile.

The documentation for this class was generated from the following files:

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DeviceFile()

◆ ~DeviceFile()

Member Function Documentation

◆ disable()

◆ enable()

◆ flush_buffers()

◆ open()

◆ read() [1/2]

◆ read() [2/2]

◆ write() [1/2]

◆ write() [2/2]