usb_hub.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Emerson Electric Co.
 * SPDX-FileCopyrightText: Copyright 2026 NXP
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_USB_CLASS_USB_HUB_H_
#define ZEPHYR_INCLUDE_USB_CLASS_USB_HUB_H_

#define USB_HUB_CLASS_CODE              0x09
#define USB_HUB_SUBCLASS_CODE           0x00
#define USB_HUB_PROTOCOL_FS             0x00
#define USB_HUB_PROTOCOL_HS_SINGLE_TT   0x01
#define USB_HUB_PROTOCOL_HS_MULTI_TT    0x02
#define USB_HUB_PROTOCOL_CODE           USB_HUB_PROTOCOL_HS_SINGLE_TT

#define USB_HUB_DESCRIPTOR_TYPE         0x29

#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

#define USB_HCFS_C_HUB_LOCAL_POWER      0x00
#define USB_HCFS_C_HUB_OVER_CURRENT     0x01
#define USB_HCFS_PORT_CONNECTION        0x00
#define USB_HCFS_PORT_ENABLE            0x01
#define USB_HCFS_PORT_SUSPEND           0x02
#define USB_HCFS_PORT_OVER_CURRENT      0x03
#define USB_HCFS_PORT_RESET             0x04
#define USB_HCFS_PORT_POWER             0x08
#define USB_HCFS_PORT_LOW_SPEED         0x09
#define USB_HCFS_C_PORT_CONNECTION      0x10
#define USB_HCFS_C_PORT_ENABLE          0x11
#define USB_HCFS_C_PORT_SUSPEND         0x12
#define USB_HCFS_C_PORT_OVER_CURRENT    0x13
#define USB_HCFS_C_PORT_RESET           0x14
#define USB_HCFS_PORT_TEST              0x15
#define USB_HCFS_PORT_INDICATOR         0x16

#define USB_HUB_STATUS_LOCAL_POWER      BIT(0)
#define USB_HUB_STATUS_OVER_CURRENT     BIT(1)

#define USB_HUB_CHANGE_LOCAL_POWER      BIT(0)
#define USB_HUB_CHANGE_OVER_CURRENT     BIT(1)

#define USB_HUB_PORT_STATUS_CONNECTION          BIT(0)
#define USB_HUB_PORT_STATUS_ENABLE              BIT(1)
#define USB_HUB_PORT_STATUS_SUSPEND             BIT(2)
#define USB_HUB_PORT_STATUS_OVER_CURRENT        BIT(3)
#define USB_HUB_PORT_STATUS_RESET               BIT(4)
#define USB_HUB_PORT_STATUS_POWER               BIT(8)
#define USB_HUB_PORT_STATUS_LOW_SPEED           BIT(9)
#define USB_HUB_PORT_STATUS_HIGH_SPEED          BIT(10)
#define USB_HUB_PORT_STATUS_TEST                BIT(11)
#define USB_HUB_PORT_STATUS_INDICATOR           BIT(12)

#define USB_HUB_PORT_CHANGE_CONNECTION          BIT(0)
#define USB_HUB_PORT_CHANGE_ENABLE              BIT(1)
#define USB_HUB_PORT_CHANGE_SUSPEND             BIT(2)
#define USB_HUB_PORT_CHANGE_OVER_CURRENT        BIT(3)
#define USB_HUB_PORT_CHANGE_RESET               BIT(4)

#define USB_HUB_DESC_BUF_SIZE 71

#define USB_HUB_GET_THINK_TIME(wHubCharacteristics) \
        (((((wHubCharacteristics) & 0x0060U) >> 5) + 1) << 3)

struct usb_hub_descriptor {
        uint8_t bDescLength;
        uint8_t bDescriptorType;
        uint8_t bNbrPorts;
        uint16_t wHubCharacteristics;
        uint8_t bPwrOn2PwrGood;
        uint8_t bHubContrCurrent;
} __packed;

struct usb_hub_status {
        uint16_t wHubStatus;
        uint16_t wHubChange;
} __packed;

struct usb_hub_port_status {
        uint16_t wPortStatus;
        uint16_t wPortChange;
} __packed;
 
#endif /* ZEPHYR_INCLUDE_USB_CLASS_USB_HUB_H_ */