#include <usbd-wrapper.h>

Inheritance diagram for os::driver::usbd_wrapper:

Public Member Functions
	usbd_wrapper (ARM_DRIVER_USBD *driver, ARM_USBD_SignalDeviceEvent_t c_cb_device_func, ARM_USBD_SignalEndpointEvent_t c_cb_endpoint_func) noexcept

	usbd_wrapper (const usbd_wrapper &)=delete

	usbd_wrapper (usbd_wrapper &&)=delete

virtual	~usbd_wrapper () noexcept

return_t	abort_transfer (endpoint_t ep_addr) noexcept
	Abort current USB Endpoint transfer.

return_t	configure_address (device_address_t dev_addr) noexcept
	Set USB Device Address.

return_t	configure_endpoint (endpoint_t ep_addr, Endpoint_type ep_type, packet_size_t ep_max_packet_size) noexcept
	Configure USB Endpoint.

return_t	connect (void) noexcept
	Connect USB Device.

return_t	disconnect (void) noexcept
	Disconnect USB Device.

const device::Capabilities &	get_capabilities (void) noexcept
	Get driver capabilities.

frame_number_t	get_frame_number (void) noexcept
	Get current USB Frame Number.

device::Status &	get_status (void) noexcept
	Get current USB Device Status.

std::size_t	get_transfer_count (endpoint_t ep_addr) noexcept
	Get result of USB Endpoint transfer.

const Version &	get_version (void) noexcept
	Get driver version.

usbd_wrapper &	operator= (const usbd_wrapper &)=delete

usbd_wrapper &	operator= (usbd_wrapper &&)=delete

return_t	power (Power state) noexcept
	Power up/down device.

return_t	read_setup_packet (uint8_t *buf) noexcept
	Read setup packet received over Control Endpoint.

void	register_device_callback (device::signal_device_event_t cb_func, const void *cb_object=nullptr) noexcept
	Register device event callback.

void	register_endpoint_callback (device::signal_endpoint_event_t cb_func, const void *cb_object=nullptr) noexcept

void	signal_device_event (event_t event) noexcept
	Signal device events.

void	signal_endpoint_event (endpoint_t ep_addr, event_t event) noexcept
	Signal USB Endpoint Event.

return_t	stall_endpoint (endpoint_t ep_addr, bool stall) noexcept
	Set/Clear Stall for USB Endpoint.

return_t	transfer (endpoint_t ep_addr, uint8_t *data, std::size_t num) noexcept
	Read data from or Write data to USB Endpoint.

return_t	unconfigure_endpoint (endpoint_t ep_addr) noexcept
	Unconfigure USB Endpoint.

return_t	wakeup_remote (void) noexcept
	Trigger USB Remote Wakeup.

Protected Member Functions
virtual return_t	do_abort_transfer (usb::endpoint_t ep_addr) noexcept override

virtual return_t	do_configure_address (usb::device_address_t dev_addr) noexcept override

virtual return_t	do_configure_endpoint (usb::endpoint_t ep_addr, usb::Endpoint_type ep_type, usb::packet_size_t ep_max_packet_size) noexcept override

virtual return_t	do_connect (void) noexcept override

virtual return_t	do_disconnect (void) noexcept override

const usb::device::Capabilities &	do_get_capabilities (void) noexcept override

virtual usb::frame_number_t	do_get_frame_number (void) noexcept override

virtual usb::device::Status &	do_get_status (void) noexcept override

virtual std::size_t	do_get_transfer_count (usb::endpoint_t ep_addr) noexcept override

virtual const Version &	do_get_version (void) noexcept override

virtual return_t	do_power (Power state) noexcept override

virtual return_t	do_read_setup_packet (uint8_t *buf) noexcept override

virtual return_t	do_stall_endpoint (usb::endpoint_t ep_addr, bool stall) noexcept override

virtual return_t	do_transfer (usb::endpoint_t ep_addr, uint8_t *data, std::size_t num) noexcept override

virtual return_t	do_unconfigure_endpoint (usb::endpoint_t ep_addr) noexcept override

virtual return_t	do_wakeup_remote (void) noexcept override

Private Attributes
ARM_USBD_SignalDeviceEvent_t	c_cb_device_func_

ARM_USBD_SignalEndpointEvent_t	c_cb_endpoint_func_

usb::device::Capabilities	capa_

device::signal_device_event_t	cb_device_func_
	Pointer to static function that implements the device callback.

const void *	cb_device_object_
	Pointer to object instance associated with the device callback.

device::signal_endpoint_event_t	cb_endpoint_func_
	Pointer to static function that implements the endpoint callback.

const void *	cb_endpoint_object_
	Pointer to object instance associated with the endpoint callback.

ARM_DRIVER_USBD *	driver_
	Pointer to CMSIS USBD Keil driver.

usb::device::Status	status_

Version	version_ { 0, 0 }

Detailed Description

Definition at line 47 of file usbd-wrapper.h.

Constructor & Destructor Documentation

◆ usbd_wrapper() [1/3]

os::driver::usbd_wrapper::usbd_wrapper	(	ARM_DRIVER_USBD *	driver,
		ARM_USBD_SignalDeviceEvent_t	c_cb_device_func,
		ARM_USBD_SignalEndpointEvent_t	c_cb_endpoint_func
	)

noexcept

Definition at line 28 of file usbd-wrapper.cpp.

        : driver_ (driver), c_cb_device_func_ (c_cb_device_func),
          c_cb_endpoint_func_ (c_cb_endpoint_func)
    {
      trace::printf ("%s() %p\n", __func__, this);
    }

References os::trace::printf().

◆ usbd_wrapper() [2/3]

os::driver::usbd_wrapper::usbd_wrapper ( const usbd_wrapper & )

delete

◆ usbd_wrapper() [3/3]

os::driver::usbd_wrapper::usbd_wrapper ( usbd_wrapper && )

delete

◆ ~usbd_wrapper()

os::driver::usbd_wrapper::~usbd_wrapper ( )

virtualnoexcept

Definition at line 37 of file usbd-wrapper.cpp.

    {
      trace::printf ("%s() %p\n", __func__, this);
 
      driver_ = nullptr;
    }

References driver_, and os::trace::printf().

Member Function Documentation

◆ abort_transfer()

return_t os::driver::usb::Device::abort_transfer ( endpoint_t ep_addr )

inlinenoexceptinherited

Parameters

[in]

ep_addr

Endpoint Address

ep_addr.0..3: Address
ep_addr.7: Direction

Returns: Execution status.

Definition at line 556 of file usb-device.h.

      {
        return do_abort_transfer (ep_addr);
      }

References os::driver::usb::Device::do_abort_transfer().

◆ configure_address()

return_t os::driver::usb::Device::configure_address ( device_address_t dev_addr )

inlinenoexceptinherited

Parameters

[in] dev_addr Device Address

Returns: Execution status.

Definition at line 519 of file usb-device.h.

      {
        return do_configure_address (dev_addr);
      }

References os::driver::usb::Device::do_configure_address().

◆ configure_endpoint()

return_t os::driver::usb::Device::configure_endpoint	(	endpoint_t	ep_addr,
		Endpoint_type	ep_type,
		packet_size_t	ep_max_packet_size
	)

inlinenoexceptinherited

Parameters

[in]	ep_addr	Endpoint Address ep_addr.0..3: Address ep_addr.7: Direction
[in]	ep_type	Endpoint Type (ARM_USB_ENDPOINT_xxx)
[in]	ep_max_packet_size	Endpoint Maximum Packet Size

Returns: Execution status.

Definition at line 531 of file usb-device.h.

      {
        return do_configure_endpoint (ep_addr, ep_type, ep_max_packet_size);
      }

References os::driver::usb::Device::do_configure_endpoint().

◆ connect()

return_t os::driver::usb::Device::connect ( void )

inlinenoexceptinherited

Returns: Execution status.

Definition at line 501 of file usb-device.h.

      {
        return do_connect ();
      }

References os::driver::usb::Device::do_connect().

◆ disconnect()

return_t os::driver::usb::Device::disconnect ( void )

inlinenoexceptinherited

Returns: Execution status.

Definition at line 507 of file usb-device.h.

      {
        return do_disconnect ();
      }

References os::driver::usb::Device::do_disconnect().

◆ do_abort_transfer()

return_t os::driver::usbd_wrapper::do_abort_transfer ( usb::endpoint_t ep_addr )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 183 of file usbd-wrapper.cpp.

    {
      return driver_->EndpointTransferAbort (ep_addr);
    }

◆ do_configure_address()

return_t os::driver::usbd_wrapper::do_configure_address ( usb::device_address_t dev_addr )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 128 of file usbd-wrapper.cpp.

    {
      return driver_->DeviceSetAddress (dev_addr);
    }

◆ do_configure_endpoint()

return_t os::driver::usbd_wrapper::do_configure_endpoint	(	usb::endpoint_t	ep_addr,
		usb::Endpoint_type	ep_type,
		usb::packet_size_t	ep_max_packet_size
	)

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 147 of file usbd-wrapper.cpp.

    {
      return driver_->EndpointConfigure (
          ep_addr, static_cast<uint8_t> (ep_type), ep_max_packet_size);
    }

◆ do_connect()

return_t os::driver::usbd_wrapper::do_connect ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 110 of file usbd-wrapper.cpp.

    {
      return driver_->DeviceConnect ();
    }

◆ do_disconnect()

return_t os::driver::usbd_wrapper::do_disconnect ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 116 of file usbd-wrapper.cpp.

    {
      return driver_->DeviceDisconnect ();
    }

◆ do_get_capabilities()

const usb::device::Capabilities & os::driver::usbd_wrapper::do_get_capabilities ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 63 of file usbd-wrapper.cpp.

    {
      // Overwrite the C++ instance. Assume same layout.
      *(reinterpret_cast<ARM_USBD_CAPABILITIES*> (&capa_))
          = driver_->GetCapabilities ();
      return capa_;
    }

◆ do_get_frame_number()

usb::frame_number_t os::driver::usbd_wrapper::do_get_frame_number ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 141 of file usbd-wrapper.cpp.

    {
      return driver_->GetFrameNumber ();
    }

◆ do_get_status()

usb::device::Status & os::driver::usbd_wrapper::do_get_status ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 72 of file usbd-wrapper.cpp.

    {
      // Overwrite the C++ instance. Assume same layout.
      *(reinterpret_cast<ARM_USBD_STATE*> (&status_))
          = driver_->DeviceGetState ();
      return status_;
    }

◆ do_get_transfer_count()

std::size_t os::driver::usbd_wrapper::do_get_transfer_count ( usb::endpoint_t ep_addr )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 177 of file usbd-wrapper.cpp.

    {
      return driver_->EndpointTransferGetResult (ep_addr);
    }

◆ do_get_version()

const Version & os::driver::usbd_wrapper::do_get_version ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::Base.

Definition at line 54 of file usbd-wrapper.cpp.

    {
      // Overwrite the C++ instance. Assume same layout.
      *(reinterpret_cast<ARM_DRIVER_VERSION*> (&version_))
          = driver_->GetVersion ();
      return version_;
    }

◆ do_power()

return_t os::driver::usbd_wrapper::do_power ( Power state )

overrideprotectedvirtualnoexcept

Implements os::driver::Base.

Definition at line 83 of file usbd-wrapper.cpp.

    {
      assert (driver_ != nullptr);
 
      return_t status;
 
      if (state == Power::full)
        {
          status
              = driver_->Initialize (c_cb_device_func_, c_cb_endpoint_func_);
          if (status != ARM_DRIVER_OK)
            {
              return status;
            }
        }
 
      status = driver_->PowerControl (static_cast<ARM_POWER_STATE> (state));
 
      if (state == Power::off)
        {
          driver_->Uninitialize ();
        }
 
      return status;
    }

References os::driver::full, and os::driver::off.

◆ do_read_setup_packet()

return_t os::driver::usbd_wrapper::do_read_setup_packet ( uint8_t * buf )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 135 of file usbd-wrapper.cpp.

    {
      return driver_->ReadSetupPacket (buf);
    }

◆ do_stall_endpoint()

return_t os::driver::usbd_wrapper::do_stall_endpoint	(	usb::endpoint_t	ep_addr,
		bool	stall
	)

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 162 of file usbd-wrapper.cpp.

    {
      return driver_->EndpointStall (ep_addr, stall);
    }

◆ do_transfer()

return_t os::driver::usbd_wrapper::do_transfer	(	usb::endpoint_t	ep_addr,
		uint8_t *	data,
		std::size_t	num
	)

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 169 of file usbd-wrapper.cpp.

    {
      return driver_->EndpointTransfer (ep_addr, data,
                                        static_cast<uint32_t> (num));
    }

◆ do_unconfigure_endpoint()

return_t os::driver::usbd_wrapper::do_unconfigure_endpoint ( usb::endpoint_t ep_addr )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 156 of file usbd-wrapper.cpp.

    {
      return driver_->EndpointUnconfigure (ep_addr);
    }

◆ do_wakeup_remote()

return_t os::driver::usbd_wrapper::do_wakeup_remote ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Device.

Definition at line 122 of file usbd-wrapper.cpp.

    {
      return driver_->DeviceRemoteWakeup ();
    }

◆ get_capabilities()

const device::Capabilities & os::driver::usb::Device::get_capabilities ( void )

inlinenoexceptinherited

Returns: Capabilities.

Definition at line 489 of file usb-device.h.

      {
        return do_get_capabilities ();
      }

References os::driver::usb::Device::do_get_capabilities().

◆ get_frame_number()

frame_number_t os::driver::usb::Device::get_frame_number ( void )

inlinenoexceptinherited

Returns: Frame Number

Definition at line 525 of file usb-device.h.

      {
        return do_get_frame_number ();
      }

References os::driver::usb::Device::do_get_frame_number().

◆ get_status()

device::Status & os::driver::usb::Device::get_status ( void )

inlinenoexceptinherited

Returns: Device State.

Definition at line 495 of file usb-device.h.

      {
        return do_get_status ();
      }

References os::driver::usb::Device::do_get_status().

◆ get_transfer_count()

std::size_t os::driver::usb::Device::get_transfer_count ( endpoint_t ep_addr )

inlinenoexceptinherited

Parameters

[in]

ep_addr

Endpoint Address

ep_addr.0..3: Address
ep_addr.7: Direction

Returns: number of successfully transferred data bytes

Definition at line 550 of file usb-device.h.

      {
        return do_get_transfer_count (ep_addr);
      }

References os::driver::usb::Device::do_get_transfer_count().

◆ get_version()

const Version & os::driver::Base::get_version ( void )

inlinenoexceptinherited

Returns: Version.

Definition at line 185 of file common.h.

    {
      return do_get_version ();
    }

◆ operator=() [1/2]

usbd_wrapper & os::driver::usbd_wrapper::operator= ( const usbd_wrapper & )

delete

◆ operator=() [2/2]

usbd_wrapper & os::driver::usbd_wrapper::operator= ( usbd_wrapper && )

delete

◆ power()

return_t os::driver::Base::power ( Power state )

inlinenoexceptinherited

Parameters

[in] state Power state

Returns: Execution status

Definition at line 191 of file common.h.

    {
      return do_power (state);
    }

◆ read_setup_packet()

return_t os::driver::usb::Device::read_setup_packet ( uint8_t * buf )

noexceptinherited

Parameters

[out] buf Pointer to buffer for setup packet

Returns: Execution status.

Definition at line 74 of file usb-device.cpp.

      {
        assert (buf != nullptr);
        return do_read_setup_packet (buf);
      }

◆ register_device_callback()

void os::driver::usb::Device::register_device_callback	(	device::signal_device_event_t	cb_func,
		const void *	cb_object = `nullptr`
	)

noexceptinherited

Parameters

[in]	cb_func	Pointer to function.
[in]	cb_object	Pointer to object passed to the function.

Returns: Nothing.

Definition at line 55 of file usb-device.cpp.

      {
        cb_device_func_ = cb_func;
        cb_device_object_ = cb_object;
      }

◆ register_endpoint_callback()

void os::driver::usb::Device::register_endpoint_callback	(	device::signal_endpoint_event_t	cb_func,
		const void *	cb_object = `nullptr`
	)

noexceptinherited

Definition at line 63 of file usb-device.cpp.

      {
        cb_endpoint_func_ = cb_func;
        cb_endpoint_object_ = cb_object;
      }

◆ signal_device_event()

void os::driver::usb::Device::signal_device_event ( event_t event )

noexceptinherited

Parameters

[in] event Event.

Returns: Nothing.

Definition at line 95 of file usb-device.cpp.

      {
        if (cb_device_func_ != nullptr)
          {
            // Forward event to registered callback.
            cb_device_func_ (cb_device_object_, event);
          }
      }

◆ signal_endpoint_event()

void os::driver::usb::Device::signal_endpoint_event	(	endpoint_t	ep_addr,
		event_t	event
	)

noexceptinherited

Parameters

[in]	ep_addr	Endpoint Address ep_addr.0..3: Address ep_addr.7: Direction
[in]	event	Event.

Returns: Nothing.

Definition at line 105 of file usb-device.cpp.

      {
        if (cb_endpoint_func_ != nullptr)
          {
            // Forward event to registered callback.
            cb_endpoint_func_ (cb_endpoint_object_, ep_addr, event);
          }
      }

◆ stall_endpoint()

return_t os::driver::usb::Device::stall_endpoint	(	endpoint_t	ep_addr,
		bool	stall
	)

inlinenoexceptinherited

Parameters

[in]	ep_addr	Endpoint Address ep_addr.0..3: Address ep_addr.7: Direction
[in]	stall	Operation false Clear true Set

Returns: Execution status.

Definition at line 544 of file usb-device.h.

      {
        return do_stall_endpoint (ep_addr, stall);
      }

References os::driver::usb::Device::do_stall_endpoint().

◆ transfer()

return_t os::driver::usb::Device::transfer	(	endpoint_t	ep_addr,
		uint8_t *	data,
		std::size_t	num
	)

noexceptinherited

Parameters

[in]	ep_addr	Endpoint Address ep_addr.0..3: Address ep_addr.7: Direction
[out]	data	Pointer to buffer for data to read or with data to write
[in]	num	Number of data bytes to transfer

Returns: Execution status.

Definition at line 81 of file usb-device.cpp.

      {
        assert (data != nullptr);
        if (num == 0)
          {
            return RETURN_OK;
          }
        return do_transfer (ep_addr, data, num);
      }

References os::driver::RETURN_OK.

◆ unconfigure_endpoint()

return_t os::driver::usb::Device::unconfigure_endpoint ( endpoint_t ep_addr )

inlinenoexceptinherited

Parameters

[in]

ep_addr

Endpoint Address

ep_addr.0..3: Address
ep_addr.7: Direction

Returns: Execution status.

Definition at line 538 of file usb-device.h.

      {
        return do_unconfigure_endpoint (ep_addr);
      }

References os::driver::usb::Device::do_unconfigure_endpoint().

◆ wakeup_remote()

return_t os::driver::usb::Device::wakeup_remote ( void )

inlinenoexceptinherited

Returns: Execution status.

Definition at line 513 of file usb-device.h.

      {
        return do_wakeup_remote ();
      }

References os::driver::usb::Device::do_wakeup_remote().

Member Data Documentation

◆ c_cb_device_func_

ARM_USBD_SignalDeviceEvent_t os::driver::usbd_wrapper::c_cb_device_func_

private

Pointer to non-reentrant callback. Must be stored because Initialize() is now delayed just before PowerControl(FULL).

Definition at line 134 of file usbd-wrapper.h.

◆ c_cb_endpoint_func_

ARM_USBD_SignalEndpointEvent_t os::driver::usbd_wrapper::c_cb_endpoint_func_

private

Definition at line 135 of file usbd-wrapper.h.

◆ capa_

usb::device::Capabilities os::driver::usbd_wrapper::capa_

private

Definition at line 145 of file usbd-wrapper.h.

◆ cb_device_func_

device::signal_device_event_t os::driver::usb::Device::cb_device_func_

privateinherited

Definition at line 442 of file usb-device.h.

Referenced by os::driver::usb::Device::Device().

◆ cb_device_object_

const void* os::driver::usb::Device::cb_device_object_

privateinherited

Definition at line 445 of file usb-device.h.

Referenced by os::driver::usb::Device::Device().

◆ cb_endpoint_func_

device::signal_endpoint_event_t os::driver::usb::Device::cb_endpoint_func_

privateinherited

Definition at line 448 of file usb-device.h.

Referenced by os::driver::usb::Device::Device().

◆ cb_endpoint_object_

const void* os::driver::usb::Device::cb_endpoint_object_

privateinherited

Definition at line 451 of file usb-device.h.

Referenced by os::driver::usb::Device::Device().

◆ driver_

ARM_DRIVER_USBD* os::driver::usbd_wrapper::driver_

private

Definition at line 130 of file usbd-wrapper.h.

Referenced by ~usbd_wrapper().

◆ status_

usb::device::Status os::driver::usbd_wrapper::status_

private

Definition at line 146 of file usbd-wrapper.h.

◆ version_

Version os::driver::usbd_wrapper::version_ { 0, 0 }

private

Definition at line 144 of file usbd-wrapper.h.

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ usbd_wrapper() [1/3]

◆ usbd_wrapper() [2/3]

◆ usbd_wrapper() [3/3]

◆ ~usbd_wrapper()

Member Function Documentation

◆ abort_transfer()

◆ configure_address()

◆ configure_endpoint()

◆ connect()

◆ disconnect()

◆ do_abort_transfer()

◆ do_configure_address()

◆ do_configure_endpoint()

◆ do_connect()

◆ do_disconnect()

◆ do_get_capabilities()

◆ do_get_frame_number()

◆ do_get_status()

◆ do_get_transfer_count()

◆ do_get_version()

◆ do_power()

◆ do_read_setup_packet()

◆ do_stall_endpoint()

◆ do_transfer()

◆ do_unconfigure_endpoint()

◆ do_wakeup_remote()

◆ get_capabilities()

◆ get_frame_number()

◆ get_status()

◆ get_transfer_count()

◆ get_version()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ power()

◆ read_setup_packet()

◆ register_device_callback()

◆ register_endpoint_callback()

◆ signal_device_event()

◆ signal_endpoint_event()

◆ stall_endpoint()

◆ transfer()

◆ unconfigure_endpoint()

◆ wakeup_remote()

Member Data Documentation

◆ c_cb_device_func_

◆ c_cb_endpoint_func_

◆ capa_

◆ cb_device_func_

◆ cb_device_object_

◆ cb_endpoint_func_

◆ cb_endpoint_object_

◆ driver_

◆ status_

◆ version_