Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

USBH - Adds Status Check Methods #641

Merged
merged 1 commit into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/hid/usb_host.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ class USBHostHandle::Impl
Result Process();
Result ReEnumerate();

bool IsPortEnabled();
bool IsDeviceConnected();

bool GetReady();

inline Config& GetConfig() { return config_; }
Expand Down Expand Up @@ -127,6 +130,16 @@ bool USBHostHandle::Impl::GetReady()
return Appli_state == APPLICATION_READY;
}

bool USBHostHandle::Impl::IsPortEnabled()
{
return USBH_IsPortEnabled(&hUsbHostHS);
}

bool USBHostHandle::Impl::IsDeviceConnected()
{
return hUsbHostHS.device.is_connected;
}

USBHostHandle::Result USBHostHandle::RegisterClass(USBH_ClassTypeDef* pClass)
{
return pimpl_->RegisterClass(pClass);
Expand Down Expand Up @@ -170,6 +183,16 @@ bool USBHostHandle::GetPresent()
&& state != HOST_DEV_DISCONNECTED);
}

bool USBHostHandle::IsPortEnabled()
{
return pimpl_->IsPortEnabled();
}

bool USBHostHandle::IsDeviceConnected()
{
return pimpl_->IsDeviceConnected();
}

// Shared USB IRQ Handlers are located in sys/System.cpps

// This isn't super useful for our typical code structure
Expand Down
32 changes: 19 additions & 13 deletions src/hid/usb_host.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
namespace daisy
{
/** Status of USB Host application
*
*
*/
typedef enum
{
Expand All @@ -17,7 +17,7 @@ typedef enum
APPLICATION_DISCONNECT
} ApplicationTypeDef;

/**
/**
@author Gabriel Ball
@date September 16, 2021

Expand All @@ -26,10 +26,10 @@ typedef enum
class USBHostHandle
{
public:
/** @brief return codes from the USB Processing
/** @brief return codes from the USB Processing
* can be used to check the state of USB while running
* outside of what may be happening with the limited user callbacks.
*
*
* At this time, these correlate directly to the ST Middleware
* USBH_StatusTypeDef codes
*/
Expand All @@ -49,19 +49,19 @@ class USBHostHandle
/** @brief User defineable callback for USB Disconnection */
typedef void (*DisconnectCallback)(void* data);

/** @brief User defineable callback upon completion of class initialization
/** @brief User defineable callback upon completion of class initialization
* For example, when a USB drive is connected and the usb device class
* initialization has finished, this callback will fire.
*
*
* @param userdata a pointer to some arbitrary data for use by the user.
* this is supplied in the Config struct. Can be used to avoid globals.
*
*
* @todo At some point this may be replaced for individual callbacks
* for each supported USB Host class.
*/
typedef void (*ClassActiveCallback)(void* userdata);

/** @brief User defineable callback for USB Unrecoverable Error
/** @brief User defineable callback for USB Unrecoverable Error
* @todo add some sort of feedback about the type of error, etc.
* if possible
*/
Expand Down Expand Up @@ -91,13 +91,13 @@ class USBHostHandle
Result RegisterClass(USBH_ClassTypeDef* pClass);

/** Initializes the USB drivers and starts timeout.
*
*
* \param config Configuration struct for initialization
*/
Result Init(USBHostHandle::Config& config);

/** Deinitializes USB host-related peripherals
*
*
*/
Result Deinit();

Expand All @@ -107,7 +107,7 @@ class USBHostHandle
bool IsActiveClass(USBH_ClassTypeDef* usbClass);

/** Manages usb host functionality
*
*
*/
Result Process();

Expand All @@ -116,20 +116,26 @@ class USBHostHandle

/** Returns true if a Mass Storage Device is connected
* and ready for communicaton
*
*
*/
bool GetReady();

/** Run after the first `Process` call to detect if
* a device is present
*
*
*/
bool GetPresent();

/** Returns name of the connected devices if there is one
*/
const char* GetProductName();

/** @brief Returns if the HAL detects that the port is enabled */
bool IsPortEnabled();

/** @brief Returns if the ST Middleware detects a connected device */
bool IsDeviceConnected();

USBHostHandle() : pimpl_(nullptr) {}
USBHostHandle(const USBHostHandle& other) = default;
USBHostHandle& operator=(const USBHostHandle& other) = default;
Expand Down
Loading