usbd-wrapper.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2016 Liviu Ionescu.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom
 * the Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef CMSIS_PLUS_DRIVER_USBD_WRAPPER_H_
#define CMSIS_PLUS_DRIVER_USBD_WRAPPER_H_

#include <cmsis-plus/driver/usb-device.h>

// ----------------------------------------------------------------------------

extern "C"
{
  // Avoid to include <Driver_USBD.h>
  typedef void
  (*ARM_USBD_SignalDeviceEvent_t) (uint32_t event); 
  typedef void
  (*ARM_USBD_SignalEndpointEvent_t) (uint8_t ep_addr, uint32_t event); 

  typedef struct _ARM_DRIVER_USBD const ARM_DRIVER_USBD;
}

namespace os
{
  namespace driver
  {
    // ========================================================================

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"

    // This wrapper makes a CMSIS USBD Keil driver behave like a
    // µOS++ Serial driver.

    class usbd_wrapper : public usb::Device
    {
    public:

      // ----------------------------------------------------------------------

      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;

      usbd_wrapper&
      operator= (const usbd_wrapper&) = delete;

      usbd_wrapper&
      operator= (usbd_wrapper&&) = delete;

      virtual
      ~usbd_wrapper () noexcept;

      // ----------------------------------------------------------------------

    protected:

      virtual const Version&
      do_get_version (void) noexcept override;

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

      virtual return_t
      do_power (Power state) noexcept override;

      virtual return_t
      do_connect (void) noexcept override;

      virtual return_t
      do_disconnect (void) noexcept override;

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

      virtual return_t
      do_wakeup_remote (void) noexcept override;

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

      virtual return_t
      do_read_setup_packet (uint8_t* buf) noexcept override;

      virtual usb::frame_number_t
      do_get_frame_number (void) 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_unconfigure_endpoint (usb::endpoint_t ep_addr) 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 std::size_t
      do_get_transfer_count (usb::endpoint_t ep_addr) noexcept override;

      virtual return_t
      do_abort_transfer (usb::endpoint_t ep_addr) noexcept override;

      // ----------------------------------------------------------------------

    private:

      ARM_DRIVER_USBD* driver_;

      ARM_USBD_SignalDeviceEvent_t c_cb_device_func_;
      ARM_USBD_SignalEndpointEvent_t c_cb_endpoint_func_;

      // Attempts to somehow use && failed, since the Keil driver
      // functions return temporary objects. So the only portable
      // solution was to copy these objects here and return
      // references to these objects.
      // (Not particularly proud of this solution, but could not find
      // a better one.)

      Version version_
        { 0, 0 };
      usb::device::Capabilities capa_;
      usb::device::Status status_;

    };

#pragma GCC diagnostic pop

  } /* namespace driver */
} /* namespace os */

// ----------------------------------------------------------------------------

#endif /* CMSIS_PLUS_DRIVER_USBD_WRAPPER_H_ */