BUsbRaw Class Reference

#include <BUsbRaw.h>

Inheritance diagram for BUsbRaw:

Public Member Functions
	BUsbRaw (BUInt rxFifoSize=512, BUInt txFifoSize=512)
BError	init (BUsbType type=BUsbTypeFullSpeed, BUsbConfig *usbConfig=0)
	Initialise with optional config params. More...
void	setMaximumUsbChunk (BUInt usbChunkSize)
	Sets the maximum USB tranmitted chunk size. More...
void	close ()
	Close down the USB interface. More...
void	setBlocking (Bool on)
	Enable blocking mode. More...
void	setSync (Bool on)
	Set synchronous mode for writes. More...
void	start ()
	Start processing. More...
const char *	name ()
	The name of this interface. More...
BUInt32	byteRate ()
	The byte rate of this interface. More...
BUInt	writeAvailable ()
	How much write space is available. More...
BError	write (const void *data, BUInt32 nBytes, BUInt32 &nWritten)
	Write a set of data. More...
BUInt	readAvailable ()
	How many bytes of read data is available. More...
BError	read (void *data, BUInt32 nBytes, BUInt32 &nRead)
	Read the data. More...
BError	wait (BUInt8 events, BTimeout timeoutUs=BTimeoutForever, BUInt32 num=1)
BError	usbdInitHardware ()
BError	usbdInitUsbDev (USBD_HandleTypeDef *pdev)
BUInt8	usbdInit (USBD_HandleTypeDef *pdev, BUInt8 cfgidx)
void	usbdStarted ()
	The USB device is connected and running. More...
BUInt8	usbdDeInit (USBD_HandleTypeDef *pdev, BUInt8 cfgidx)
BUInt8	usbdSetup (USBD_HandleTypeDef *pdev, USBD_SetupReqTypedef *req)
void	usbdTx ()
	Data to USB stack. More...
BUInt8	usbdTxComplete ()
	Data has been sent. More...
int	usbdRx (USBD_HandleTypeDef *pdev, BUInt len)
	Data from USB stack. More...
void	usbdConnectChange (int connected)
void	usbdClientConnectChange (int connected)
void	usbdInterrupt ()
Public Member Functions inherited from BComms
	BComms ()
virtual	~BComms ()
virtual BError	init ()
virtual BError	setPacketMode (Bool packetMode)
	Set packet mode. More...
virtual Bool	packetMode ()
	Device is in packet mode. More...
virtual BError	setTimeout (BTimeout timeoutUs)
	Set communication timeout. More...
virtual BError	connect (const char *resource)
	Create a connection. More...
virtual Bool	isConnected ()
virtual BError	disconnect ()
	Disconnect. More...
virtual void	flush (Flush flush)
virtual BError	writeChunks (const BDataChunk *chunks, BUInt nChunks, BUInt32 &nTrans)
virtual BError	wait (BUInt32 eventSet, BTimeout timeoutUs=BTimeoutForever, BUInt32 num=1)
virtual void	eventQueue (BEventQueue *eventQueue, BUInt32 event, BUInt32 eventSet, BUInt num=1)
virtual void	eventEnable (Bool on)
	Enable events to be sent. More...

Private Attributes
BFifo< char >	otxFifo
	The transmit fifo. More...
BFifo< char >	orxFifo
	The receive fifo. More...
Bool	ohighSpeed
	High speed USB. More...
BUInt	opacketSize
	The maximum packet size. More...
Bool	oinitialised
	The USB device has initialised. More...
Bool	oconnected
	The USB is connected. More...
BSemaphore	owait
	Read wait semaphore. More...
BUInt	owaitReadNum
	The number of bytes to wait for. More...
Bool	oblocking
	Device set to block on writes. More...
Bool	osync
	Device set to wait for writes. More...
USBD_HandleTypeDef	ousbDev
	The USB device. More...
PCD_HandleTypeDef	ohpcd
	The USB PCD layer. More...
Bool	otxSending
	USB is transmitting. More...
int	otxSendLen
	The length of data sent. More...
char	orxBuffer [512]
	Receive packet buffer. More...
Bool	orxStalled
	Receive has stalled as no room in buffer. More...
BUInt	ousbChunkSize
	The maximum USB chunk size. More...

Additional Inherited Members
Public Types inherited from BComms
enum	Flush { FlushRead, FlushWrite, FlushReadWrite }
Protected Attributes inherited from BComms
Bool	oconnected
Bool	opacketMode
BTimeout	otimeout
BEventQueue *	oeventQueue
Bool	oeventEnabled
BUInt32	oevent
BUInt32	oeventSet
BUInt	oeventNum

Constructor & Destructor Documentation

BUsbRaw()

BUsbRaw::BUsbRaw	(	BUInt	rxFifoSize = 512,
		BUInt	txFifoSize = 512
	)

Member Function Documentation

byteRate()

BUInt32 BUsbRaw::byteRate ( )

virtual

The byte rate of this interface.

Reimplemented from BComms.

close()

void BUsbRaw::close ( )

virtual

Close down the USB interface.

Reimplemented from BComms.

init()

BError BUsbRaw::init	(	BUsbType	type = BUsbTypeFullSpeed,
		BUsbConfig *	usbConfig = 0
	)

Initialise with optional config params.

name()

const char * BUsbRaw::name ( )

virtual

The name of this interface.

Reimplemented from BComms.

read()

BError BUsbRaw::read ( void *  data, BUInt32  nBytes, BUInt32 &  nRead  )

virtual

Read the data.

Implements BComms.

readAvailable()

BUInt BUsbRaw::readAvailable ( )

virtual

How many bytes of read data is available.

Reimplemented from BComms.

setBlocking()

void BUsbRaw::setBlocking

(

Bool

on

)

Enable blocking mode.

setMaximumUsbChunk()

void BUsbRaw::setMaximumUsbChunk

(

BUInt

usbChunkSize

)

Sets the maximum USB tranmitted chunk size.

setSync()

void BUsbRaw::setSync

(

Bool

on

)

Set synchronous mode for writes.

start()

void BUsbRaw::start

(

)

Start processing.

usbdClientConnectChange()

void BUsbRaw::usbdClientConnectChange

(

int

connected

)

usbdConnectChange()

void BUsbRaw::usbdConnectChange

(

int

connected

)

usbdDeInit()

BUInt8 BUsbRaw::usbdDeInit	(	USBD_HandleTypeDef *	pdev,
		BUInt8	cfgidx
	)

usbdInit()

BUInt8 BUsbRaw::usbdInit	(	USBD_HandleTypeDef *	pdev,
		BUInt8	cfgidx
	)

usbdInitHardware()

BError BUsbRaw::usbdInitHardware

(

)

usbdInitUsbDev()

BError BUsbRaw::usbdInitUsbDev

(

USBD_HandleTypeDef *

pdev

)

usbdInterrupt()

void BUsbRaw::usbdInterrupt

(

void

)

usbdRx()

int BUsbRaw::usbdRx	(	USBD_HandleTypeDef *	pdev,
		BUInt	len
	)

Data from USB stack.

usbdSetup()

BUInt8 BUsbRaw::usbdSetup	(	USBD_HandleTypeDef *	pdev,
		USBD_SetupReqTypedef *	req
	)

usbdStarted()

void BUsbRaw::usbdStarted

(

)

The USB device is connected and running.

usbdTx()

void BUsbRaw::usbdTx

(

)

Data to USB stack.

usbdTxComplete()

BUInt8 BUsbRaw::usbdTxComplete

(

)

Data has been sent.

wait()

BError BUsbRaw::wait	(	BUInt8	events,
		BTimeout	timeoutUs = BTimeoutForever,
		BUInt32	num = 1
	)

write()

BError BUsbRaw::write ( const void *  data, BUInt32  nBytes, BUInt32 &  nWritten  )

virtual

Write a set of data.

Implements BComms.

writeAvailable()

BUInt BUsbRaw::writeAvailable ( )

virtual

How much write space is available.

Reimplemented from BComms.

Member Data Documentation

oblocking

Bool BUsbRaw::oblocking

private

Device set to block on writes.

oconnected

Bool BUsbRaw::oconnected

private

The USB is connected.

ohighSpeed

Bool BUsbRaw::ohighSpeed

private

High speed USB.

ohpcd

PCD_HandleTypeDef BUsbRaw::ohpcd

private

The USB PCD layer.

oinitialised

Bool BUsbRaw::oinitialised

private

The USB device has initialised.

opacketSize

BUInt BUsbRaw::opacketSize

private

The maximum packet size.

orxBuffer

char BUsbRaw::orxBuffer[512]

private

Receive packet buffer.

orxFifo

BFifo<char> BUsbRaw::orxFifo

private

The receive fifo.

orxStalled

Bool BUsbRaw::orxStalled

private

Receive has stalled as no room in buffer.

osync

Bool BUsbRaw::osync

private

Device set to wait for writes.

otxFifo

BFifo<char> BUsbRaw::otxFifo

private

The transmit fifo.

otxSending

Bool BUsbRaw::otxSending

private

USB is transmitting.

otxSendLen

int BUsbRaw::otxSendLen

private

The length of data sent.

ousbChunkSize

BUInt BUsbRaw::ousbChunkSize

private

The maximum USB chunk size.

ousbDev

USBD_HandleTypeDef BUsbRaw::ousbDev

private

The USB device.

owait

BSemaphore BUsbRaw::owait

private

Read wait semaphore.

owaitReadNum

BUInt BUsbRaw::owaitReadNum

private

The number of bytes to wait for.

---

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

• BUsbRaw.h
• BUsbRaw.cpp