#include <usbh-wrapper.h>

Inheritance diagram for os::driver::usbh_wrapper:

Public Member Functions
	usbh_wrapper (ARM_DRIVER_USBH *driver, ARM_USBH_SignalPortEvent_t c_cb_port_func, ARM_USBH_SignalPipeEvent_t c_cb_pipe_func) noexcept

	usbh_wrapper (const usbh_wrapper &)=delete

	usbh_wrapper (usbh_wrapper &&)=delete

virtual	~usbh_wrapper () noexcept

return_t	abort_transfer (pipe_t pipe) noexcept

pipe_t	create_pipe (device_address_t dev_addr, speed_t dev_speed, hub_addr_t hub_addr, hub_port_t hub_port, endpoint_t ep_addr, endpoint_type_t ep_type, packet_size_t ep_max_packet_size, polling_interval_t ep_interval) noexcept

return_t	delete_pipe (pipe_t pipe) noexcept

const host::Capabilities &	get_capabilities (void) noexcept

uint16_t	get_frame_number (void) noexcept

host::Status &	get_port_status (port_t port) noexcept

std::size_t	get_transfer_count (pipe_t pipe) noexcept

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

return_t	modify_pipe (pipe_t pipe, device_address_t dev_addr, speed_t dev_speed, hub_addr_t hub_addr, hub_port_t hub_port, packet_size_t ep_max_packet_size) noexcept

usbh_wrapper &	operator= (const usbh_wrapper &)=delete

usbh_wrapper &	operator= (usbh_wrapper &&)=delete

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

return_t	power_port_vbus (port_t port, bool vbus) noexcept

void	register_pipe_callback (host::signal_pipe_event_t cb_func, const void *cb_object=nullptr) noexcept

void	register_port_callback (host::signal_port_event_t cb_func, const void *cb_object=nullptr) noexcept
	Register port event callback.

return_t	reset_pipe (pipe_t pipe) noexcept

return_t	reset_port (port_t port) noexcept

return_t	resume_port (port_t port) noexcept

void	signal_pipe_event (pipe_t pipe, event_t event) noexcept

void	signal_port_event (port_t port, event_t event) noexcept

return_t	suspend_port (port_t port) noexcept

return_t	transfer (pipe_t pipe, uint32_t packet, uint8_t *data, std::size_t num) noexcept

Protected Member Functions
virtual return_t	do_abort_transfer (usb::pipe_t pipe) noexcept override

virtual usb::pipe_t	do_create_pipe (usb::device_address_t dev_addr, usb::speed_t dev_speed, usb::hub_addr_t hub_addr, usb::hub_port_t hub_port, usb::endpoint_t ep_addr, usb::endpoint_type_t ep_type, usb::packet_size_t ep_max_packet_size, usb::polling_interval_t ep_interval) noexcept override

virtual return_t	do_delete_pipe (usb::pipe_t pipe) noexcept override

virtual const usb::host::Capabilities &	do_get_capabilities (void) noexcept override

virtual uint16_t	do_get_frame_number (void) noexcept override

virtual usb::host::Status &	do_get_port_status (usb::port_t port) noexcept override

virtual std::size_t	do_get_transfer_count (usb::pipe_t pipe) noexcept override

virtual const Version &	do_get_version (void) noexcept override

virtual return_t	do_modify_pipe (usb::pipe_t pipe, usb::device_address_t dev_addr, usb::speed_t dev_speed, usb::hub_addr_t hub_addr, usb::hub_port_t hub_port, usb::packet_size_t ep_max_packet_size) noexcept override

virtual return_t	do_power (Power state) noexcept override

virtual return_t	do_power_port_vbus (usb::port_t port, bool vbus) noexcept override

virtual return_t	do_reset_pipe (usb::pipe_t pipe) noexcept override

virtual return_t	do_reset_port (usb::port_t port) noexcept override

virtual return_t	do_resume_port (usb::port_t port) noexcept override

virtual return_t	do_suspend_port (usb::port_t port) noexcept override

virtual return_t	do_transfer (usb::pipe_t pipe, uint32_t packet, uint8_t *data, std::size_t num) noexcept override

Private Attributes
ARM_USBH_SignalPipeEvent_t	c_cb_pipe_func_

ARM_USBH_SignalPortEvent_t	c_cb_port_func_

usb::host::Capabilities	capa_

host::signal_pipe_event_t	cb_pipe_func_
	Pointer to static function that implements the pipe callback.

const void *	cb_pipe_object_
	Pointer to object instance associated with the pipe callback.

host::signal_port_event_t	cb_port_func_
	Pointer to static function that implements the port callback.

const void *	cb_port_object_
	Pointer to object instance associated with the port callback.

ARM_DRIVER_USBH *	driver_
	Pointer to CMSIS USBD Keil driver.

usb::host::Status	status_

Version	version_ { 0, 0 }

Detailed Description

Definition at line 49 of file usbh-wrapper.h.

Constructor & Destructor Documentation

◆ usbh_wrapper() [1/3]

os::driver::usbh_wrapper::usbh_wrapper	(	ARM_DRIVER_USBH *	driver,
		ARM_USBH_SignalPortEvent_t	c_cb_port_func,
		ARM_USBH_SignalPipeEvent_t	c_cb_pipe_func
	)

noexcept

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

        : driver_ (driver), c_cb_port_func_ (c_cb_port_func),
          c_cb_pipe_func_ (c_cb_pipe_func)
    {
      trace::printf ("%s() %p\n", __func__, this);
    }

References os::trace::printf().

◆ usbh_wrapper() [2/3]

os::driver::usbh_wrapper::usbh_wrapper ( const usbh_wrapper & )

delete

◆ usbh_wrapper() [3/3]

os::driver::usbh_wrapper::usbh_wrapper ( usbh_wrapper && )

delete

◆ ~usbh_wrapper()

os::driver::usbh_wrapper::~usbh_wrapper ( )

virtualnoexcept

Definition at line 37 of file usbh-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::Host::abort_transfer ( pipe_t pipe )

inlinenoexceptinherited

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

      {
        return do_abort_transfer (pipe);
      }

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

◆ create_pipe()

pipe_t os::driver::usb::Host::create_pipe	(	device_address_t	dev_addr,
		speed_t	dev_speed,
		hub_addr_t	hub_addr,
		hub_port_t	hub_port,
		endpoint_t	ep_addr,
		endpoint_type_t	ep_type,
		packet_size_t	ep_max_packet_size,
		polling_interval_t	ep_interval
	)

inlinenoexceptinherited

Definition at line 455 of file usb-host.h.

      {
        return do_create_pipe (dev_addr, dev_speed, hub_addr, hub_port,
                               ep_addr, ep_type, ep_max_packet_size,
                               ep_interval);
      }

References os::driver::usb::Host::do_create_pipe().

◆ delete_pipe()

return_t os::driver::usb::Host::delete_pipe ( pipe_t pipe )

inlinenoexceptinherited

Definition at line 477 of file usb-host.h.

      {
        return do_delete_pipe (pipe);
      }

References os::driver::usb::Host::do_delete_pipe().

◆ do_abort_transfer()

return_t os::driver::usbh_wrapper::do_abort_transfer ( usb::pipe_t pipe )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 185 of file usbh-wrapper.cpp.

    {
      return driver_->PipeTransferAbort (pipe);
    }

◆ do_create_pipe()

usb::pipe_t os::driver::usbh_wrapper::do_create_pipe	(	usb::device_address_t	dev_addr,
		usb::speed_t	dev_speed,
		usb::hub_addr_t	hub_addr,
		usb::hub_port_t	hub_port,
		usb::endpoint_t	ep_addr,
		usb::endpoint_type_t	ep_type,
		usb::packet_size_t	ep_max_packet_size,
		usb::polling_interval_t	ep_interval
	)

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 133 of file usbh-wrapper.cpp.

    {
      return driver_->PipeCreate (dev_addr, dev_speed, hub_addr, hub_port,
                                  ep_addr, ep_type, ep_max_packet_size,
                                  ep_interval);
    }

◆ do_delete_pipe()

return_t os::driver::usbh_wrapper::do_delete_pipe ( usb::pipe_t pipe )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 159 of file usbh-wrapper.cpp.

    {
      return driver_->PipeDelete (pipe);
    }

◆ do_get_capabilities()

const usb::host::Capabilities & os::driver::usbh_wrapper::do_get_capabilities ( void )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

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

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

◆ do_get_frame_number()

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

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 191 of file usbh-wrapper.cpp.

    {
      return driver_->GetFrameNumber ();
    }

◆ do_get_port_status()

usb::host::Status & os::driver::usbh_wrapper::do_get_port_status ( usb::port_t port )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

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

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

◆ do_get_transfer_count()

std::size_t os::driver::usbh_wrapper::do_get_transfer_count ( usb::pipe_t pipe )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 179 of file usbh-wrapper.cpp.

    {
      return driver_->PipeTransferGetResult (pipe);
    }

◆ do_get_version()

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

overrideprotectedvirtualnoexcept

Implements os::driver::Base.

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

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

◆ do_modify_pipe()

return_t os::driver::usbh_wrapper::do_modify_pipe	(	usb::pipe_t	pipe,
		usb::device_address_t	dev_addr,
		usb::speed_t	dev_speed,
		usb::hub_addr_t	hub_addr,
		usb::hub_port_t	hub_port,
		usb::packet_size_t	ep_max_packet_size
	)

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 148 of file usbh-wrapper.cpp.

    {
      return driver_->PipeModify (pipe, dev_addr, dev_speed, hub_addr,
                                  hub_port, ep_max_packet_size);
    }

◆ do_power()

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

overrideprotectedvirtualnoexcept

Implements os::driver::Base.

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

    {
      assert (driver_ != nullptr);
 
      return_t status;
 
      if (state == Power::full)
        {
          status = driver_->Initialize (c_cb_port_func_, c_cb_pipe_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_power_port_vbus()

return_t os::driver::usbh_wrapper::do_power_port_vbus	(	usb::port_t	port,
		bool	vbus
	)

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 109 of file usbh-wrapper.cpp.

    {
      return driver_->PortVbusOnOff (port, vbus);
    }

◆ do_reset_pipe()

return_t os::driver::usbh_wrapper::do_reset_pipe ( usb::pipe_t pipe )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 165 of file usbh-wrapper.cpp.

    {
      return driver_->PipeReset (pipe);
    }

◆ do_reset_port()

return_t os::driver::usbh_wrapper::do_reset_port ( usb::port_t port )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 115 of file usbh-wrapper.cpp.

    {
      return driver_->PortReset (port);
    }

◆ do_resume_port()

return_t os::driver::usbh_wrapper::do_resume_port ( usb::port_t port )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 127 of file usbh-wrapper.cpp.

    {
      return driver_->PortResume (port);
    }

◆ do_suspend_port()

return_t os::driver::usbh_wrapper::do_suspend_port ( usb::port_t port )

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 121 of file usbh-wrapper.cpp.

    {
      return driver_->PortSuspend (port);
    }

◆ do_transfer()

return_t os::driver::usbh_wrapper::do_transfer	(	usb::pipe_t	pipe,
		uint32_t	packet,
		uint8_t *	data,
		std::size_t	num
	)

overrideprotectedvirtualnoexcept

Implements os::driver::usb::Host.

Definition at line 171 of file usbh-wrapper.cpp.

    {
      return driver_->PipeTransfer (pipe, packet, data,
                                    static_cast<uint32_t> (num));
    }

◆ get_capabilities()

const host::Capabilities & os::driver::usb::Host::get_capabilities ( void )

inlinenoexceptinherited

Definition at line 419 of file usb-host.h.

      {
        return do_get_capabilities ();
      }

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

◆ get_frame_number()

uint16_t os::driver::usb::Host::get_frame_number ( void )

inlinenoexceptinherited

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

      {
        return do_get_frame_number ();
      }

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

◆ get_port_status()

host::Status & os::driver::usb::Host::get_port_status ( port_t port )

inlinenoexceptinherited

Definition at line 449 of file usb-host.h.

      {
        return do_get_port_status (port);
      }

References os::driver::usb::Host::do_get_port_status().

◆ get_transfer_count()

std::size_t os::driver::usb::Host::get_transfer_count ( pipe_t pipe )

inlinenoexceptinherited

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

      {
        return do_get_transfer_count (pipe);
      }

References os::driver::usb::Host::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 ();
    }

◆ modify_pipe()

return_t os::driver::usb::Host::modify_pipe	(	pipe_t	pipe,
		device_address_t	dev_addr,
		speed_t	dev_speed,
		hub_addr_t	hub_addr,
		hub_port_t	hub_port,
		packet_size_t	ep_max_packet_size
	)

inlinenoexceptinherited

Definition at line 467 of file usb-host.h.

      {
        return do_modify_pipe (pipe, dev_addr, dev_speed, hub_addr, hub_port,
                               ep_max_packet_size);
      }

References os::driver::usb::Host::do_modify_pipe().

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

usbh_wrapper & os::driver::usbh_wrapper::operator= ( usbh_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);
    }

◆ power_port_vbus()

return_t os::driver::usb::Host::power_port_vbus	(	port_t	port,
		bool	vbus
	)

inlinenoexceptinherited

Definition at line 425 of file usb-host.h.

      {
        return do_power_port_vbus (port, vbus);
      }

References os::driver::usb::Host::do_power_port_vbus().

◆ register_pipe_callback()

void os::driver::usb::Host::register_pipe_callback	(	host::signal_pipe_event_t	cb_func,
		const void *	cb_object = `nullptr`
	)

noexceptinherited

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

      {
        cb_pipe_func_ = cb_func;
        cb_pipe_object_ = cb_object;
      }

◆ register_port_callback()

void os::driver::usb::Host::register_port_callback	(	host::signal_port_event_t	cb_func,
		const void *	cb_object = `nullptr`
	)

noexceptinherited

Parameters

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

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

      {
        cb_port_func_ = cb_func;
        cb_port_object_ = cb_object;
      }

◆ reset_pipe()

return_t os::driver::usb::Host::reset_pipe ( pipe_t pipe )

inlinenoexceptinherited

Definition at line 483 of file usb-host.h.

      {
        return do_reset_pipe (pipe);
      }

References os::driver::usb::Host::do_reset_pipe().

◆ reset_port()

return_t os::driver::usb::Host::reset_port ( port_t port )

inlinenoexceptinherited

Definition at line 431 of file usb-host.h.

      {
        return do_reset_port (port);
      }

References os::driver::usb::Host::do_reset_port().

◆ resume_port()

return_t os::driver::usb::Host::resume_port ( port_t port )

inlinenoexceptinherited

Definition at line 443 of file usb-host.h.

      {
        return do_resume_port (port);
      }

References os::driver::usb::Host::do_resume_port().

◆ signal_pipe_event()

void os::driver::usb::Host::signal_pipe_event	(	pipe_t	pipe,
		event_t	event
	)

noexceptinherited

Definition at line 97 of file usb-host.cpp.

      {
        if (cb_pipe_func_ != nullptr)
          {
            // Forward event to registered callback.
            cb_pipe_func_ (cb_pipe_object_, pipe, event);
          }
      }

◆ signal_port_event()

void os::driver::usb::Host::signal_port_event	(	port_t	port,
		event_t	event
	)

noexceptinherited

Definition at line 87 of file usb-host.cpp.

      {
        if (cb_port_func_ != nullptr)
          {
            // Forward event to registered callback.
            cb_port_func_ (cb_port_object_, port, event);
          }
      }

◆ suspend_port()

return_t os::driver::usb::Host::suspend_port ( port_t port )

inlinenoexceptinherited

Definition at line 437 of file usb-host.h.

      {
        return do_suspend_port (port);
      }

References os::driver::usb::Host::do_suspend_port().

◆ transfer()

return_t os::driver::usb::Host::transfer	(	pipe_t	pipe,
		uint32_t	packet,
		uint8_t *	data,
		std::size_t	num
	)

noexceptinherited

Definition at line 73 of file usb-host.cpp.

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

References os::driver::RETURN_OK.

Member Data Documentation

◆ c_cb_pipe_func_

ARM_USBH_SignalPipeEvent_t os::driver::usbh_wrapper::c_cb_pipe_func_

private

Definition at line 140 of file usbh-wrapper.h.

◆ c_cb_port_func_

ARM_USBH_SignalPortEvent_t os::driver::usbh_wrapper::c_cb_port_func_

private

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

Definition at line 139 of file usbh-wrapper.h.

◆ capa_

usb::host::Capabilities os::driver::usbh_wrapper::capa_

private

Definition at line 150 of file usbh-wrapper.h.

◆ cb_pipe_func_

host::signal_pipe_event_t os::driver::usb::Host::cb_pipe_func_

privateinherited

Definition at line 378 of file usb-host.h.

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

◆ cb_pipe_object_

const void* os::driver::usb::Host::cb_pipe_object_

privateinherited

Definition at line 381 of file usb-host.h.

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

◆ cb_port_func_

host::signal_port_event_t os::driver::usb::Host::cb_port_func_

privateinherited

Definition at line 372 of file usb-host.h.

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

◆ cb_port_object_

const void* os::driver::usb::Host::cb_port_object_

privateinherited

Definition at line 375 of file usb-host.h.

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

◆ driver_

ARM_DRIVER_USBH* os::driver::usbh_wrapper::driver_

private

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

Referenced by ~usbh_wrapper().

◆ status_

usb::host::Status os::driver::usbh_wrapper::status_

private

Definition at line 151 of file usbh-wrapper.h.

◆ version_

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

private

Definition at line 149 of file usbh-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

◆ usbh_wrapper() [1/3]

◆ usbh_wrapper() [2/3]

◆ usbh_wrapper() [3/3]

◆ ~usbh_wrapper()

Member Function Documentation

◆ abort_transfer()

◆ create_pipe()

◆ delete_pipe()

◆ do_abort_transfer()

◆ do_create_pipe()

◆ do_delete_pipe()

◆ do_get_capabilities()

◆ do_get_frame_number()

◆ do_get_port_status()

◆ do_get_transfer_count()

◆ do_get_version()

◆ do_modify_pipe()

◆ do_power()

◆ do_power_port_vbus()

◆ do_reset_pipe()

◆ do_reset_port()

◆ do_resume_port()

◆ do_suspend_port()

◆ do_transfer()

◆ get_capabilities()

◆ get_frame_number()

◆ get_port_status()

◆ get_transfer_count()

◆ get_version()

◆ modify_pipe()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ power()

◆ power_port_vbus()

◆ register_pipe_callback()

◆ register_port_callback()

◆ reset_pipe()

◆ reset_port()

◆ resume_port()

◆ signal_pipe_event()

◆ signal_port_event()

◆ suspend_port()

◆ transfer()

Member Data Documentation

◆ c_cb_pipe_func_

◆ c_cb_port_func_

◆ capa_

◆ cb_pipe_func_

◆ cb_pipe_object_

◆ cb_port_func_

◆ cb_port_object_

◆ driver_

◆ status_

◆ version_