Skip to content

drivers: usb: uhc: add hub topology fields and getters #102838

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.

Sign up for GitHub

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

Closed
AidenHu wants to merge 4 commits into from
Closed

drivers: usb: uhc: add hub topology fields and getters #102838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
066af01
include: usb: uhc: extend usb_device with hub-related information
AidenHu Apr 22, 2026
af764d5
usb: host: set level value for the first USB device
AidenHu Apr 3, 2026
7ad1201
include: usb_hub: add missing USB hub definitions
AidenHu Apr 8, 2026
6f75d48
drivers: usb: uhc: improve peripheral information helper
AidenHu Dec 16, 2025
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
39 changes: 37 additions & 2 deletions drivers/usb/uhc/uhc_mcux_common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,49 @@ usb_status_t USB_HostHelperGetPeripheralInformation(usb_device_handle deviceHand
break;

case kUSB_HostGetDeviceHubNumber:
if (udev->hub != NULL) {
*infoValue = udev->hub->addr;
} else {
*infoValue = 0;
}
break;

case kUSB_HostGetDevicePortNumber:
*infoValue = udev->hub_port;
break;

case kUSB_HostGetDeviceHSHubNumber:
for (; udev->hub != NULL; udev = udev->hub) {
if (udev->hub->speed == USB_SPEED_SPEED_HS) {
*infoValue = udev->hub->addr;
return kStatus_USB_Success;
}
}
*infoValue = 0;
break;

case kUSB_HostGetDeviceHSHubPort:
case kUSB_HostGetHubThinkTime:
for (; udev->hub != NULL; udev = udev->hub) {
if (udev->hub->speed == USB_SPEED_SPEED_HS) {
*infoValue = udev->hub->hub_port;
return kStatus_USB_Success;
}
}
*infoValue = 0;
break;

case kUSB_HostGetHubThinkTime: {
uint16_t total_think_time = 0;

for (; udev->hub != NULL; udev = udev->hub) {
total_think_time += udev->hub->tt;
}
*infoValue = total_think_time;
break;
}

case kUSB_HostGetDeviceLevel:
*infoValue = 1;
*infoValue = udev->level;
Comment thread
josuah marked this conversation as resolved.
break;

case kUSB_HostGetDeviceSpeed:
Expand Down
8 changes: 8 additions & 0 deletions include/zephyr/drivers/usb/uhc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,14 @@ struct usb_device {
struct usb_host_ep ep_out[16];
/** Pointers to device IN endpoints */
struct usb_host_ep ep_in[16];
/** Pointer to the hub to which this device is connected */
struct usb_device *hub;
/** Device's hub Think Time */
uint16_t tt;
/** Device's hub port */
uint8_t hub_port;
/** Device's level (root device = 0) */
uint8_t level;
Comment on lines +99 to +106
Copy link
Copy Markdown
Contributor

@jfischer-no jfischer-no Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change in uhc.h does not seem to belong in this commit.

Copy link
Copy Markdown
Contributor Author

@AidenHu AidenHu Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated.

};

/**
Expand Down
199 changes: 186 additions & 13 deletions include/zephyr/usb/class/usb_hub.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,217 @@
/*
* Copyright (c) 2022 Emerson Electric Co.
*
* SPDX-FileCopyrightText: Copyright 2026 NXP
* SPDX-License-Identifier: Apache-2.0
*/

/**
* @file
* @brief USB Hub Class device API header
* @brief USB Hub Class public header
*/

#ifndef ZEPHYR_INCLUDE_USB_CLASS_USB_HUB_H_
#define ZEPHYR_INCLUDE_USB_CLASS_USB_HUB_H_

/** USB Hub Class Feature Selectors defined in spec. Table 11-17 */
/**
* @name USB Hub Class Codes
* @{
*/
/** Hub class code. */
#define USB_HUB_CLASS_CODE 0x09
/** Hub subclass code. */
#define USB_HUB_SUBCLASS_CODE 0x00
/** Hub protocol code. */
#define USB_HUB_PROTOCOL_CODE 0x00
/** @} */

/**
* @name USB Hub Descriptor Types
* @{
*/
/** Hub descriptor type. */
#define USB_HUB_DESCRIPTOR_TYPE 0x29
/** @} */

/**
* @name USB Hub Class Request Codes. See Table 11-16 of the specification.
* @{
*/
/** Get Status request. */
#define USB_HCREQ_GET_STATUS 0x00
/** Clear Feature request. */
#define USB_HCREQ_CLEAR_FEATURE 0x01
/** Set Feature request. */
#define USB_HCREQ_SET_FEATURE 0x03
/** Get Descriptor request. */
#define USB_HCREQ_GET_DESCRIPTOR 0x06
/** Set Descriptor request. */
#define USB_HCREQ_SET_DESCRIPTOR 0x07
/** Clear TT Buffer request. */
#define USB_HCREQ_CLEAR_TT_BUFFER 0x08
/** Reset TT request. */
#define USB_HCREQ_RESET_TT 0x09
/** Get TT State request. */
#define USB_HCREQ_GET_TT_STATE 0x0A
/** Stop TT request. */
#define USB_HCREQ_STOP_TT 0x0B
/** @} */

/**
* @name USB Hub Class Feature Selectors. See Table 11-17 of the specification.
Copy link
Copy Markdown
Contributor

@josuah josuah Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is a preview of the doc after this is merged:

https://builds.zephyrproject.io/zephyr/pr/102838/docs/doxygen/html/usb__hub_8h.html

As you see here the "See Table 11-17 ..." is on the title, I would be tempted to split it to the next line:

/**
 * @name USB Hub Class Feature Selectors.
 * 
 * See Table 11-17 of the specification.
 */

Here and other locations.

Copy link
Copy Markdown
Contributor Author

@AidenHu AidenHu Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, updated.

* @{
*/
/** Hub local power change feature selector. */
#define USB_HCFS_C_HUB_LOCAL_POWER 0x00
/** Hub over-current change feature selector. */
#define USB_HCFS_C_HUB_OVER_CURRENT 0x01
/** Port connection feature selector. */
#define USB_HCFS_PORT_CONNECTION 0x00
/** Port enable feature selector. */
#define USB_HCFS_PORT_ENABLE 0x01
/** Port suspend feature selector. */
#define USB_HCFS_PORT_SUSPEND 0x02
/** Port over-current feature selector. */
#define USB_HCFS_PORT_OVER_CURRENT 0x03
/** Port reset feature selector. */
#define USB_HCFS_PORT_RESET 0x04
/** Port power feature selector. */
#define USB_HCFS_PORT_POWER 0x08
/** Port low speed feature selector. */
#define USB_HCFS_PORT_LOW_SPEED 0x09
/** Port connection change feature selector. */
#define USB_HCFS_C_PORT_CONNECTION 0x10
/** Port enable change feature selector. */
#define USB_HCFS_C_PORT_ENABLE 0x11
/** Port suspend change feature selector. */
#define USB_HCFS_C_PORT_SUSPEND 0x12
/** Port over-current change feature selector. */
#define USB_HCFS_C_PORT_OVER_CURRENT 0x13
/** Port reset change feature selector. */
#define USB_HCFS_C_PORT_RESET 0x14
/** Port test feature selector. */
#define USB_HCFS_PORT_TEST 0x15
/** Port indicator feature selector. */
#define USB_HCFS_PORT_INDICATOR 0x16
/** @} */

/** USB Hub Class Request Codes defined in spec. Table 11-16 */
#define USB_HCREQ_GET_STATUS 0x00
#define USB_HCREQ_CLEAR_FEATURE 0x01
#define USB_HCREQ_SET_FEATURE 0x03
#define USB_HCREQ_GET_DESCRIPTOR 0x06
#define USB_HCREQ_SET_DESCRIPTOR 0x07
#define USB_HCREQ_CLEAR_TT_BUFFER 0x08
#define USB_HCREQ_RESET_TT 0x09
#define USB_HCREQ_GET_TT_STATE 0x0A
#define USB_HCREQ_STOP_TT 0x0B
/**
* @name USB Hub Status Field, wHubStatus. See Table 11-19 of the specification.
* @{
*/
/** Hub local power status bit. */
#define USB_HUB_STATUS_LOCAL_POWER BIT(0)
/** Hub over-current status bit. */
#define USB_HUB_STATUS_OVER_CURRENT BIT(1)
/** @} */

/**
* @name USB Hub Change Field, wHubChange. See Table 11-20 of the specification.
* @{
*/
/** Hub local power change bit. */
#define USB_HUB_CHANGE_LOCAL_POWER BIT(0)
/** Hub over-current change bit. */
#define USB_HUB_CHANGE_OVER_CURRENT BIT(1)
/** @} */

/**
* @name USB Hub Port Status Field, wPortStatus. See Table 11-21 of the specification.
* @{
*/
/** Port connection status bit. */
#define USB_HUB_PORT_STATUS_CONNECTION BIT(0)
/** Port enable status bit. */
#define USB_HUB_PORT_STATUS_ENABLE BIT(1)
/** Port suspend status bit. */
#define USB_HUB_PORT_STATUS_SUSPEND BIT(2)
/** Port over-current status bit. */
#define USB_HUB_PORT_STATUS_OVER_CURRENT BIT(3)
/** Port reset status bit. */
#define USB_HUB_PORT_STATUS_RESET BIT(4)
/** Port power status bit. */
#define USB_HUB_PORT_STATUS_POWER BIT(8)
/** Port low speed device attached bit. */
#define USB_HUB_PORT_STATUS_LOW_SPEED BIT(9)
/** Port high speed device attached bit. */
#define USB_HUB_PORT_STATUS_HIGH_SPEED BIT(10)
/** Port test mode bit. */
#define USB_HUB_PORT_STATUS_TEST BIT(11)
/** Port indicator control bit. */
#define USB_HUB_PORT_STATUS_INDICATOR BIT(12)
/** @} */

/**
* @name USB Hub Port Change Field, wPortChange. See Table 11-22 of the specification.
* @{
*/
/** Port connection change bit. */
#define USB_HUB_PORT_CHANGE_CONNECTION BIT(0)
/** Port enable change bit. */
#define USB_HUB_PORT_CHANGE_ENABLE BIT(1)
/** Port suspend change bit. */
#define USB_HUB_PORT_CHANGE_SUSPEND BIT(2)
/** Port over-current change bit. */
#define USB_HUB_PORT_CHANGE_OVER_CURRENT BIT(3)
/** Port reset change bit. */
#define USB_HUB_PORT_CHANGE_RESET BIT(4)
/** @} */

/**
* Maximum hub descriptor size.
* 7 bytes (fixed) + max 32 bytes (DeviceRemovable) + max 32 bytes (PortPwrCtrlMask)
*/
#define USB_HUB_DESC_BUF_SIZE 71

/**
* @brief Get Think Time value from wHubCharacteristics field.
*
* @param wHubCharacteristics Hub descriptor field wHubCharacteristics.
*
* @return Think time in full-speed bit times (8, 16, 24, or 32).
*/
#define USB_HUB_GET_THINK_TIME(wHubCharacteristics) \
(((((wHubCharacteristics) & 0x0060U) >> 5) + 1) << 3)

/**
* USB Hub Descriptor. See Table 11-13 of the specification.
*/
struct usb_hub_descriptor {
/** Descriptor length. */
uint8_t bDescLength;
/** Descriptor type. */
uint8_t bDescriptorType;
/** Number of downstream facing ports. */
uint8_t bNbrPorts;
/** Hub characteristics bitmap. */
uint16_t wHubCharacteristics;
/** Time from power-on to power-good (in 2ms intervals). */
uint8_t bPwrOn2PwrGood;
/** Maximum current requirements of the Hub Controller (in mA). */
uint8_t bHubContrCurrent;
/** Variable length fields follow:
* uint8_t DeviceRemovable[];
* uint8_t PortPwrCtrlMask[];
*/
} __packed;

/**
* USB Hub Status. See Table 11-19 and 11-20 of the specification.
*/
struct usb_hub_status {
/** Hub status bitmap. */
uint16_t wHubStatus;
/** Hub status change bitmap. */
uint16_t wHubChange;
} __packed;

/**
* USB Hub Port Status. See Table 11-21 and 11-22 of the specification.
*/
struct usb_hub_port_status {
/** Port status bitmap. */
uint16_t wPortStatus;
/** Port status change bitmap. */
uint16_t wPortChange;
} __packed;

#endif /* ZEPHYR_INCLUDE_USB_CLASS_USB_HUB_H_ */
1 change: 1 addition & 0 deletions subsys/usb/host/usbh_core.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ static void dev_connected_handler(struct usbh_context *const ctx,

if (ctx->root == NULL) {
ctx->root = udev;
udev->level = 1;
Copy link
Copy Markdown
Contributor

@jfischer-no jfischer-no Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is not udev->level. This commit is just wrong.

host: core: set initialized value of level for first udev

What host? What core?

usb: host: set level value for the first USB device ?

Copy link
Copy Markdown
Contributor Author

@AidenHu AidenHu Apr 22, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Adjust the commits' order and msg. Updated.

}

usbh_device_connect(ctx, udev);
Expand Down
Loading