os::driver Namespace Reference

Namespaces
namespace	serial
namespace	usb

Classes
class	Base
class	Serial
class	usart_wrapper
class	usbd_wrapper
class	usbh_wrapper
class	Version

Typedefs
using	event_t = uint32_t
using	power_t = uint32_t
using	return_t = int32_t
typedef void(*	signal_event_t) (const void *object, event_t event)
using	version_t = uint16_t

Enumerations
enum class	Power : power_t {   off ,   low ,   full }

Variables
constexpr return_t	ERROR = -1
constexpr return_t	ERROR_BUSY = -2
constexpr return_t	ERROR_PARAMETER = -5
constexpr return_t	ERROR_SPECIFIC = -6
constexpr return_t	ERROR_TIMEOUT = -3
constexpr return_t	ERROR_UNSUPPORTED = -4
constexpr return_t	RETURN_OK = 0

Typedef Documentation

event_t

using os::driver::event_t = typedef uint32_t

Definition at line 45 of file common.h.

power_t

using os::driver::power_t = typedef uint32_t

Definition at line 47 of file common.h.

return_t

using os::driver::return_t = typedef int32_t

Definition at line 46 of file common.h.

signal_event_t

typedef void(* os::driver::signal_event_t) (const void *object, event_t event)

Definition at line 67 of file common.h.

version_t

using os::driver::version_t = typedef uint16_t

Definition at line 44 of file common.h.

Enumeration Type Documentation

Power

enum class os::driver::Power : power_t

strong

Enumerator
off
low
full

Definition at line 71 of file common.h.

    {
      //
 
      // Completely power off the device.
      off,
      // Low power mode.
      low,
      // Fully power on the
      full
    };

Variable Documentation

ERROR

constexpr return_t os::driver::ERROR = -1

constexpr

Unspecified error.

Definition at line 55 of file common.h.

ERROR_BUSY

constexpr return_t os::driver::ERROR_BUSY = -2

constexpr

Driver is busy.

Definition at line 57 of file common.h.

ERROR_PARAMETER

constexpr return_t os::driver::ERROR_PARAMETER = -5

constexpr

Parameter error.

Definition at line 63 of file common.h.

ERROR_SPECIFIC

constexpr return_t os::driver::ERROR_SPECIFIC = -6

constexpr

Start of driver specific errors.

Definition at line 65 of file common.h.

ERROR_TIMEOUT

constexpr return_t os::driver::ERROR_TIMEOUT = -3

constexpr

Timeout occurred.

Definition at line 59 of file common.h.

ERROR_UNSUPPORTED

constexpr return_t os::driver::ERROR_UNSUPPORTED = -4

constexpr

Operation not supported.

Definition at line 61 of file common.h.

RETURN_OK

constexpr return_t os::driver::RETURN_OK = 0

constexpr

Operation succeeded.

Definition at line 52 of file common.h.

Referenced by os::posix::device_serial_buffered< CS >::do_close(), os::posix::device_serial_buffered< CS >::do_vopen(), os::posix::device_serial_buffered< CS >::do_write(), os::driver::Serial::receive(), os::driver::Serial::send(), os::posix::device_serial_buffered< CS >::signal_event(), os::driver::Serial::transfer(), os::driver::usb::Device::transfer(), and os::driver::usb::Host::transfer().