usb-device.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2016-2025 Liviu Ionescu. All rights reserved.
 * Copyright (c) 2013-2014 ARM Ltd.
 *
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can
 * be obtained from https://opensource.org/licenses/mit.
 */
 
/*
 * The code is inspired by ARM CMSIS Driver_USBD.h file, v2.01,
 * and tries to remain functionally close to the CMSIS specifications.
 */
 
#ifndef CMSIS_PLUS_DRIVER_USB_DEVICE_H_
#define CMSIS_PLUS_DRIVER_USB_DEVICE_H_
 
// ----------------------------------------------------------------------------
 
#ifdef __cplusplus
 
// ----------------------------------------------------------------------------
 
#include <cmsis-plus/driver/common.h>
#include <cmsis-plus/driver/usb.h>
 
#include <cstdint>
#include <cstddef>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace driver
  {
    namespace usb
    {
      namespace device
      {
        // ====================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wpadded"
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wpadded"
#endif
 
        class Capabilities
        {
        public:
          // For compatibility with ARM CMSIS, these bits should be
          // exactly in this order.
 
          bool vbus_detection : 1;
 
          bool event_vbus_on : 1;
 
          bool event_vbus_off : 1;
        };
 
#pragma GCC diagnostic pop
 
        // ====================================================================
        // ----- USB Device Status -----
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wpadded"
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wpadded"
#endif
 
        class Status
        {
        public:
          bool
          is_vbus_on (void) const noexcept;
 
          speed_t
          get_speed (void) const noexcept;
 
          bool
          is_active (void) const noexcept;
 
          // ------------------------------------------------------------------
 
        public:
          // For compatibility with ARM CMSIS, these bits should be
          // exactly in this order.
 
          bool vbus : 1;
 
          speed_t speed : 2;
 
          bool active : 1;
        };
 
#pragma GCC diagnostic pop
 
        // ====================================================================
        // ----- USB Device Events -----
 
        enum Device_event : event_t
        {
          //
 
          vbus_on = (1UL << 0),
 
          vbus_off = (1UL << 1),
 
          reset = (1UL << 2),
 
          high_speed = (1UL << 3),
 
          suspend = (1UL << 4),
 
          resume = (1UL << 5)
        };
 
        // ====================================================================
        // ----- USB Device Endpoint Events -----
 
        enum Endpoint_event : event_t
        {
          setup = (1UL << 0),
 
          out = (1UL << 1),
 
          in = (1UL << 2),
        };
 
        // --------------------------------------------------------------------
 
        typedef void (*signal_device_event_t) (const void* object,
                                               event_t event);
 
        typedef void (*signal_endpoint_event_t) (const void* object,
                                                 endpoint_t ep_addr,
                                                 event_t event);
 
      } /* namespace device */
 
      // ======================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wpadded"
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wpadded"
#endif
 
      class Device : public Base
      {
 
      public:
        // --------------------------------------------------------------------
 
        Device () noexcept;
 
        Device (const Device&) = delete;
 
        Device (Device&&) = delete;
 
        Device&
        operator= (const Device&)
            = delete;
 
        Device&
        operator= (Device&&)
            = delete;
 
        virtual ~Device () noexcept override;
 
        // --------------------------------------------------------------------
 
        void
        register_device_callback (device::signal_device_event_t cb_func,
                                  const void* cb_object = nullptr) noexcept;
 
        void
        register_endpoint_callback (device::signal_endpoint_event_t cb_func,
                                    const void* cb_object = nullptr) noexcept;
 
        // --------------------------------------------------------------------
 
        const device::Capabilities&
        get_capabilities (void) noexcept;
 
        return_t
        connect (void) noexcept;
 
        return_t
        disconnect (void) noexcept;
 
        device::Status&
        get_status (void) noexcept;
 
        return_t
        wakeup_remote (void) noexcept;
 
        return_t
        configure_address (device_address_t dev_addr) noexcept;
 
        return_t
        read_setup_packet (uint8_t* buf) noexcept;
 
        frame_number_t
        get_frame_number (void) noexcept;
 
        return_t
        configure_endpoint (endpoint_t ep_addr, Endpoint_type ep_type,
                            packet_size_t ep_max_packet_size) noexcept;
 
        return_t
        unconfigure_endpoint (endpoint_t ep_addr) noexcept;
 
        return_t
        stall_endpoint (endpoint_t ep_addr, bool stall) noexcept;
 
        return_t
        transfer (endpoint_t ep_addr, uint8_t* data, std::size_t num) noexcept;
 
        std::size_t
        get_transfer_count (endpoint_t ep_addr) noexcept;
 
        return_t
        abort_transfer (endpoint_t ep_addr) noexcept;
 
        void
        signal_device_event (event_t event) noexcept;
 
        void
        signal_endpoint_event (endpoint_t ep_addr, event_t event) noexcept;
 
      protected:
        virtual const device::Capabilities&
        do_get_capabilities (void) noexcept
            = 0;
 
        virtual return_t
        do_connect (void) noexcept
            = 0;
 
        virtual return_t
        do_disconnect (void) noexcept
            = 0;
 
        virtual device::Status&
        do_get_status (void) noexcept
            = 0;
 
        virtual return_t
        do_wakeup_remote (void) noexcept
            = 0;
 
        virtual return_t
        do_configure_address (device_address_t dev_addr) noexcept
            = 0;
 
        virtual return_t
        do_read_setup_packet (uint8_t* buf) noexcept
            = 0;
 
        virtual frame_number_t
        do_get_frame_number (void) noexcept
            = 0;
 
        virtual return_t
        do_configure_endpoint (endpoint_t ep_addr, Endpoint_type ep_type,
                               packet_size_t ep_max_packet_size) noexcept
            = 0;
 
        virtual return_t
        do_unconfigure_endpoint (endpoint_t ep_addr) noexcept
            = 0;
 
        virtual return_t
        do_stall_endpoint (endpoint_t ep_addr, bool stall) noexcept
            = 0;
 
        virtual return_t
        do_transfer (endpoint_t ep_addr, uint8_t* data,
                     std::size_t num) noexcept
            = 0;
 
        virtual std::size_t
        do_get_transfer_count (endpoint_t ep_addr) noexcept
            = 0;
 
        virtual return_t
        do_abort_transfer (endpoint_t ep_addr) noexcept
            = 0;
 
      private:
        device::signal_device_event_t cb_device_func_;
 
        const void* cb_device_object_;
 
        device::signal_endpoint_event_t cb_endpoint_func_;
 
        const void* cb_endpoint_object_;
 
      protected:
        device::Status status_;
      };
 
#pragma GCC diagnostic pop
 
      // ----------------------------------------------------------------------
      // ----- Definitions -----
 
      namespace device
      {
        // --------------------------------------------------------------------
 
        inline bool
        Status::is_vbus_on (void) const noexcept
        {
          return vbus;
        }
 
        inline speed_t
        Status::get_speed (void) const noexcept
        {
          return speed;
        }
 
        inline bool
        Status::is_active (void) const noexcept
        {
          return active;
        }
 
      } /* namespace device */
 
      // ----------------------------------------------------------------------
 
      inline const device::Capabilities&
      Device::get_capabilities (void) noexcept
      {
        return do_get_capabilities ();
      }
 
      inline device::Status&
      Device::get_status (void) noexcept
      {
        return do_get_status ();
      }
 
      inline return_t
      Device::connect (void) noexcept
      {
        return do_connect ();
      }
 
      inline return_t
      Device::disconnect (void) noexcept
      {
        return do_disconnect ();
      }
 
      inline return_t
      Device::wakeup_remote (void) noexcept
      {
        return do_wakeup_remote ();
      }
 
      inline return_t
      Device::configure_address (uint8_t dev_addr) noexcept
      {
        return do_configure_address (dev_addr);
      }
 
      inline frame_number_t
      Device::get_frame_number (void) noexcept
      {
        return do_get_frame_number ();
      }
 
      inline return_t
      Device::configure_endpoint (endpoint_t ep_addr, Endpoint_type ep_type,
                                  packet_size_t ep_max_packet_size) noexcept
      {
        return do_configure_endpoint (ep_addr, ep_type, ep_max_packet_size);
      }
 
      inline return_t
      Device::unconfigure_endpoint (endpoint_t ep_addr) noexcept
      {
        return do_unconfigure_endpoint (ep_addr);
      }
 
      inline return_t
      Device::stall_endpoint (endpoint_t ep_addr, bool stall) noexcept
      {
        return do_stall_endpoint (ep_addr, stall);
      }
 
      inline std::size_t
      Device::get_transfer_count (endpoint_t ep_addr) noexcept
      {
        return do_get_transfer_count (ep_addr);
      }
 
      inline return_t
      Device::abort_transfer (endpoint_t ep_addr) noexcept
      {
        return do_abort_transfer (ep_addr);
      }
 
    } /* namespace usb */
  } /* namespace driver */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_DRIVER_USB_DEVICE_H_ */