MityDSP::tcDspFtdiUsbFs Class Reference

#include <DspFtdiUsbFs.h>

Inheritance diagram for MityDSP::tcDspFtdiUsbFs:

List of all members.

Public Member Functions
	tcDspFtdiUsbFs (tcDspFtdiVNC1 *apFtdiDriver, int anOffset)
	This constructor is used to create access to the Usb filesystem connected to a FTDI VNC1L device.
	~tcDspFtdiUsbFs ()
void	MediaCallback (bool mbPresent)
	Media Callback function.
virtual int	write (void *apAddr, void *apData, int anBytes)
	Writes an address.
virtual int	write (unsigned int anSector, unsigned int anOffset, void *apData, int anBytes)
	Writes a sector.
virtual int	read (void *apStartAddr, void *apBuffer, int anBytes)
	Reads an address.
virtual int	read (unsigned int anSector, unsigned int anOffset, void *apBuffer, int anBytes)
	Reads a sector.
bool	InitSectorMap ()
	Initialize the sector map.
Static Public Member Functions
static void	StaticMediaCallback (bool mbPresent, void *mpArg)
	Static dispatch for the media callback.
Protected Attributes
int	mnOffset
tcDspFtdiVNC1 *	mpDriver
int	mnTxBytes
	Count of bytes written (debug).
int	mnRxBytes
	Count of bytes read (debug).

---

Constructor & Destructor Documentation

tcDspFtdiUsbFs::tcDspFtdiUsbFs	(	tcDspFtdiVNC1 *	apFtdiDriver,
		int	anOffset
	)

This constructor is used to create access to the Usb filesystem connected to a FTDI VNC1L device.

Parameters:

[in]	apFtdiDriver	The VNC1L low-level driver
[in]	anOffset	Usb Port offset (0 or 1)

Returns:

None.

See also:

DspFtdiUsbFs.h

tcDspFtdiUsbFs::~tcDspFtdiUsbFs

(

)

---

Member Function Documentation

void tcDspFtdiUsbFs::StaticMediaCallback	(	bool	abPresent,
		void *	apArg
	)			[static]

Static dispatch for the media callback.

Parameters:

[in]	abPresent	true if device was inserted
[in]	apArg	User arguement supplied when callback was registered

See also:

DspFtdiUsbFs.h

void tcDspFtdiUsbFs::MediaCallback

(

bool

abPresent

)

Media Callback function.

Calls the registered callback, if any, when media is inserted/removed

Parameters:

[in]

abPresent

true if device was inserted

See also:

DspFtdiUsbFs.h

int tcDspFtdiUsbFs::write	(	void *	apAddr,
		void *	apData,
		int	anBytes
	)			[virtual]

Writes an address.

Parameters:

[in]	apAddr	Address to write
[in]	apData	Data to write
[in]	anBytes	Number of bytes to write

Returns:

Number of bytes written

See also:

DspFtdiUsbFs.h

Implements MityDSP::tcDspStorageBase.

int tcDspFtdiUsbFs::write	(	unsigned int	anSector,
		unsigned int	anOffset,
		void *	apData,
		int	anBytes
	)			[virtual]

Writes a sector.

Parameters:

[in]	anSector	Sector number to write
[in]	anOffset	Offset into sector
[in]	apData	Data to write
[in]	anBytes	Number of bytes to write

Returns:

Number of bytes written

See also:

DspFtdiUsbFs.h

Implements MityDSP::tcDspStorageBase.

int tcDspFtdiUsbFs::read	(	void *	apStartAddr,
		void *	apBuffer,
		int	anBytes
	)			[virtual]

Reads an address.

Parameters:

[in]	apStartAddr	Address to read from
[in]	apBuffer	Buffer to read data into
[in]	anBytes	Size of buffer in bytes

Returns:

Number of bytes read

See also:

DspFtdiUsbFs.h

Implements MityDSP::tcDspStorageBase.

int tcDspFtdiUsbFs::read	(	unsigned int	anSector,
		unsigned int	anOffset,
		void *	apBuffer,
		int	anBytes
	)			[virtual]

Reads a sector.

Parameters:

[in]	anSector	Sector number to read
[in]	anOffset	Offset into sector
[in]	apBuffer	Buffer to read into
[in]	anBytes	Size of buffer in bytes

Returns:

Number of bytes read

See also:

DspFtdiUsbFs.h

Implements MityDSP::tcDspStorageBase.

bool tcDspFtdiUsbFs::InitSectorMap

(

)

Initialize the sector map.

Returns:

True if successful.

Note:

This should be called anytime a new drive is inserted.

See also:

DspFtdiUsbFs.h

---

Member Data Documentation

int MityDSP::tcDspFtdiUsbFs::mnOffset [protected]

tcDspFtdiVNC1* MityDSP::tcDspFtdiUsbFs::mpDriver [protected]

int MityDSP::tcDspFtdiUsbFs::mnTxBytes [protected]

Count of bytes written (debug).

Reimplemented from MityDSP::tcDspStorageBase.

int MityDSP::tcDspFtdiUsbFs::mnRxBytes [protected]

Count of bytes read (debug).

Reimplemented from MityDSP::tcDspStorageBase.