F4Light::USBDriver Class Reference

#include <USBDriver.h>

Inheritance diagram for F4Light::USBDriver:

Collaboration diagram for F4Light::USBDriver:

Public Member Functions
	USBDriver (bool usb)
void	begin (uint32_t b)
void	begin (uint32_t b, uint16_t rxS, uint16_t txS)
void	end ()
bool	is_initialized ()
void	set_blocking_writes (bool blocking)
bool	tx_pending ()
void	flush ()
uint32_t	available () override
uint32_t	txspace () override
int16_t	read () override
size_t	write (uint8_t c)
size_t	write (const uint8_t *buffer, size_t size)
Public Member Functions inherited from AP_HAL::UARTDriver
	UARTDriver ()
virtual bool	lock_port (uint32_t key)
virtual size_t	write_locked (const uint8_t *buffer, size_t size, uint32_t key)
virtual void	set_flow_control (enum flow_control flow_control_setting)
virtual enum flow_control	get_flow_control (void)
virtual void	configure_parity (uint8_t v)
virtual void	set_stop_bits (int n)
virtual bool	set_unbuffered_writes (bool on)
virtual bool	wait_timeout (uint16_t n, uint32_t timeout_ms)
virtual void	_timer_tick (void)
virtual uint64_t	receive_time_constraint_us (uint16_t nbytes)
Public Member Functions inherited from AP_HAL::BetterStream
virtual void	printf (const char *,...) FMT_PRINTF(2
virtual void virtual void	vprintf (const char *, va_list)
void	print (const char *str)
void	println (const char *str)
size_t	write (const char *str)

Private Attributes
bool	_initialized
bool	_blocking

Additional Inherited Members
Public Types inherited from AP_HAL::UARTDriver
enum	flow_control { FLOW_CONTROL_DISABLE =0, FLOW_CONTROL_ENABLE =1, FLOW_CONTROL_AUTO =2 }

Detailed Description

Definition at line 21 of file USBDriver.h.

Constructor & Destructor Documentation

USBDriver()

USBDriver::USBDriver

(

bool

usb

)

Definition at line 32 of file USBDriver.cpp.

Member Function Documentation

available()

uint32_t USBDriver::available ( void  )

overridevirtual

Implements AP_HAL::BetterStream.

Definition at line 48 of file USBDriver.cpp.

Referenced by flush(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

begin() [1/2]

void USBDriver::begin ( uint32_t  b )

virtual

Implements AP_HAL::UARTDriver.

Definition at line 38 of file USBDriver.cpp.

begin() [2/2]

void F4Light::USBDriver::begin ( uint32_t  baud, uint16_t  rxSpace, uint16_t  txSpace  )

inlinevirtual

Extended port open method

Allows for both opening with specified buffer sizes, and re-opening to adjust a subset of the port's settings.

Note

Buffer sizes greater than ::_max_buffer_size will be rounded down.

Parameters

baud	Selects the speed that the port will be configured to. If zero, the port speed is left unchanged.
rxSpace	Sets the receive buffer size for the port. If zero then the buffer size is left unchanged if the port is open, or set to ::_default_rx_buffer_size if it is currently closed.
txSpace	Sets the transmit buffer size for the port. If zero then the buffer size is left unchanged if the port is open, or set to ::_default_tx_buffer_size if it is currently closed.

Implements AP_HAL::UARTDriver.

Definition at line 26 of file USBDriver.h.

Referenced by begin().

Here is the call graph for this function:

Here is the caller graph for this function:

end()

void F4Light::USBDriver::end ( )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 28 of file USBDriver.h.

Here is the call graph for this function:

flush()

void F4Light::USBDriver::flush ( void  )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 33 of file USBDriver.h.

Here is the call graph for this function:

is_initialized()

bool F4Light::USBDriver::is_initialized ( )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 29 of file USBDriver.h.

read()

int16_t USBDriver::read ( void  )

overridevirtual

Implements AP_HAL::BetterStream.

Definition at line 56 of file USBDriver.cpp.

Referenced by flush().

Here is the call graph for this function:

Here is the caller graph for this function:

set_blocking_writes()

void F4Light::USBDriver::set_blocking_writes ( bool  blocking )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 30 of file USBDriver.h.

tx_pending()

bool F4Light::USBDriver::tx_pending ( )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 31 of file USBDriver.h.

txspace()

uint32_t USBDriver::txspace ( void  )

overridevirtual

Implements AP_HAL::BetterStream.

Definition at line 53 of file USBDriver.cpp.

Referenced by flush().

Here is the call graph for this function:

Here is the caller graph for this function:

write() [1/2]

size_t USBDriver::write ( uint8_t  c )

virtual

Implements AP_HAL::BetterStream.

Definition at line 65 of file USBDriver.cpp.

Referenced by flush().

Here is the caller graph for this function:

write() [2/2]

size_t USBDriver::write ( const uint8_t *  buffer, size_t  size  )

virtual

Reimplemented from AP_HAL::BetterStream.

Definition at line 70 of file USBDriver.cpp.

Here is the call graph for this function:

Member Data Documentation

_blocking

bool F4Light::USBDriver::_blocking

private

Definition at line 44 of file USBDriver.h.

Referenced by set_blocking_writes(), and write().

_initialized

bool F4Light::USBDriver::_initialized

private

Definition at line 43 of file USBDriver.h.

Referenced by begin(), and is_initialized().

---

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

• libraries/AP_HAL_F4Light/USBDriver.h
• libraries/AP_HAL_F4Light/USBDriver.cpp