azure-rtos/usbx
1
0
Fork 0
mirror of https://github.com/azure-rtos/usbx.git synced 2025-10-25 04:17:07 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
dev
usbx/common/usbx_host_classes/inc/ux_host_class_hub.h
Bo Chen (from Dev Box) a6087c2efa Update copyright.
2024-01-29 14:21:32 +08:00

277 lines
14 KiB
C
Raw Permalink Blame History

/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** HUB Class */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* COMPONENT DEFINITION RELEASE */
/* */
/* ux_host_class_hub.h PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file contains all the header and extern functions used by the */
/* USBX HUB class. */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* resulting in version 6.1 */
/* 08-02-2021 Wen Wang Modified comment(s), */
/* added extern "C" keyword */
/* for compatibility with C++, */
/* resulting in version 6.1.8 */
/* 07-29-2022 Chaoqiong Xiao Modified comment(s), */
/* added standalone support, */
/* resulting in version 6.1.12 */
/* 10-31-2023 Chaoqiong Xiao Modified comment(s), */
/* optimized USB descriptors, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/
#ifndef UX_HOST_CLASS_HUB_H
#define UX_HOST_CLASS_HUB_H
/* Determine if a C++ compiler is being used. If so, ensure that standard
C is used to process the API information. */
#ifdef __cplusplus
/* Yes, C++ compiler is present. Use standard C. */
extern "C" {
#endif
/* Define HUB Class constants. */
#define UX_HOST_CLASS_HUB_CLASS 9
#define UX_HOST_CLASS_HUB_PROTOCOL_FS 0
#define UX_HOST_CLASS_HUB_PROTOCOL_SINGLE_TT 1
#define UX_HOST_CLASS_HUB_PROTOCOL_MULTIPLE_TT 2
/* Define HUB Class descriptor field constants. */
#define UX_HOST_CLASS_HUB_GANG_POWER_SWITCHING 0x00
#define UX_HOST_CLASS_HUB_INDIVIDUAL_POWER_SWITCHING 0x01
#define UX_HOST_CLASS_HUB_NO_POWER_SWITCHING 0x02
#define UX_HOST_CLASS_HUB_COMPOUND_DEVICE 0x04
#define UX_HOST_CLASS_HUB_GLOBAL_OVERCURRENT 0x00
#define UX_HOST_CLASS_HUB_INDIVIDUAL_OVERCURRENT 0x08
#define UX_HOST_CLASS_HUB_NO_OVERCURRENT 0x10
/* Define HUB Class command constants. */
#define UX_HOST_CLASS_HUB_GET_STATUS 0x00
#define UX_HOST_CLASS_HUB_CLEAR_FEATURE 0x01
#define UX_HOST_CLASS_HUB_GET_STATE 0x02
#define UX_HOST_CLASS_HUB_SET_FEATURE 0x03
#define UX_HOST_CLASS_HUB_GET_DESCRIPTOR 0x06
#define UX_HOST_CLASS_HUB_SET_DESCRIPTOR 0x07
/* Define HUB Class set_feature command constants. */
#define UX_HOST_CLASS_HUB_PORT_CONNECTION 0x00
#define UX_HOST_CLASS_HUB_PORT_ENABLE 0x01
#define UX_HOST_CLASS_HUB_PORT_SUSPEND 0x02
#define UX_HOST_CLASS_HUB_PORT_OVER_CURRENT 0x03
#define UX_HOST_CLASS_HUB_PORT_RESET 0x04
#define UX_HOST_CLASS_HUB_PORT_POWER 0x08
#define UX_HOST_CLASS_HUB_PORT_LOW_SPEED 0x09
#define UX_HOST_CLASS_HUB_C_PORT_CONNECTION 0x10
#define UX_HOST_CLASS_HUB_C_PORT_ENABLE 0x11
#define UX_HOST_CLASS_HUB_C_PORT_SUSPEND 0x12
#define UX_HOST_CLASS_HUB_C_PORT_OVER_CURRENT 0x13
#define UX_HOST_CLASS_HUB_C_PORT_RESET 0x14
/* Define HUB Class port status constants. */
#define UX_HOST_CLASS_HUB_PORT_STATUS_CONNECTION 0x0001
#define UX_HOST_CLASS_HUB_PORT_STATUS_ENABLE 0x0002
#define UX_HOST_CLASS_HUB_PORT_STATUS_SUSPEND 0x0004
#define UX_HOST_CLASS_HUB_PORT_STATUS_OVER_CURRENT 0x0008
#define UX_HOST_CLASS_HUB_PORT_STATUS_RESET 0x0010
#define UX_HOST_CLASS_HUB_PORT_STATUS_POWER 0x0100
#define UX_HOST_CLASS_HUB_PORT_STATUS_LOW_SPEED 0x0200
#define UX_HOST_CLASS_HUB_PORT_STATUS_HIGH_SPEED 0x0400
/* Define HUB Class port change constants. */
#define UX_HOST_CLASS_HUB_PORT_CHANGE_CONNECTION 0x00001u
#define UX_HOST_CLASS_HUB_PORT_CHANGE_ENABLE 0x00002u
#define UX_HOST_CLASS_HUB_PORT_CHANGE_SUSPEND 0x00004u
#define UX_HOST_CLASS_HUB_PORT_CHANGE_OVER_CURRENT 0x00008u
#define UX_HOST_CLASS_HUB_PORT_CHANGE_RESET 0x00010u
/* Define HUB Class other constants. */
#define UX_HOST_CLASS_HUB_ENABLE_RETRY_COUNT 3
#define UX_HOST_CLASS_HUB_ENABLE_RETRY_DELAY 100
#define UX_HOST_CLASS_HUB_ENUMERATION_RETRY 3
#define UX_HOST_CLASS_HUB_ENUMERATION_DEBOUNCE_DELAY 100
#define UX_HOST_CLASS_HUB_ENUMERATION_RESET_RECOVERY_DELAY 10
#define UX_HOST_CLASS_HUB_ENUMERATION_RETRY_DELAY 300
/* Define HUB Descriptor. */
#define UX_HUB_DESCRIPTOR_ENTRIES 8
#define UX_HUB_DESCRIPTOR_LENGTH 9
/* Define HUB Class structure. */
#define UX_MAX_HUB_PORTS 15
/* Define HUB state machine states. */
#define UX_HOST_CLASS_HUB_ENUM_GET_STATUS (UX_STATE_STEP + 0)
#define UX_HOST_CLASS_HUB_ENUM_POWER_CHECK (UX_STATE_STEP + 1)
#define UX_HOST_CLASS_HUB_ENUM_SET_CONFIG (UX_STATE_STEP + 2)
#define UX_HOST_CLASS_HUB_ENUM_SET_CONFIG_DONE (UX_STATE_STEP + 3)
#define UX_HOST_CLASS_HUB_ENUM_GET_HUB_DESC (UX_STATE_STEP + 4)
#define UX_HOST_CLASS_HUB_ENUM_GET_HUB_DESC_DONE (UX_STATE_STEP + 5)
#define UX_HOST_CLASS_HUB_ENUM_PORT_POWER (UX_STATE_STEP + 6)
#define UX_HOST_CLASS_HUB_ENUM_PORT_POWER_DELAY (UX_STATE_STEP + 7)
#define UX_HOST_CLASS_HUB_ENUM_PORT_POWER_ON (UX_STATE_STEP + 8)
#define UX_HOST_CLASS_HUB_ENUM_PORT_NEXT (UX_STATE_STEP + 9)
#define UX_HOST_CLASS_HUB_ENUM_INTERRUPT_START (UX_STATE_STEP + 10)
#define UX_HOST_CLASS_HUB_ENUM_DONE (UX_STATE_STEP + 11)
#define UX_HOST_CLASS_HUB_ENUM_TRANS_WAIT (UX_STATE_STEP + 12)
#define UX_HOST_CLASS_HUB_ENUM_DELAY_WAIT (UX_STATE_STEP + 13)
#define UX_HOST_CLASS_HUB_CHANGE_CHECK (UX_STATE_STEP + 0)
#define UX_HOST_CLASS_HUB_CHANGE_NEXT (UX_STATE_STEP + 1)
#define UX_HOST_CLASS_HUB_RESET (UX_STATE_STEP + 2)
#define UX_HOST_CLASS_HUB_STATUS_GET (UX_STATE_STEP + 3)
#define UX_HOST_CLASS_HUB_STATUS_GET_DONE (UX_STATE_STEP + 4)
#define UX_HOST_CLASS_HUB_STATUS_PROCESS (UX_STATE_STEP + 5)
#define UX_HOST_CLASS_HUB_RESET_PROCESS (UX_STATE_STEP + 6)
#define UX_HOST_CLASS_HUB_CONNECT_PROCESS (UX_STATE_STEP + 7)
#define UX_HOST_CLASS_HUB_DISC_DISABLED (UX_STATE_STEP + 8)
#define UX_HOST_CLASS_HUB_DISC_CLEAR_1 (UX_STATE_STEP + 9)
#define UX_HOST_CLASS_HUB_TRANS_WAIT (UX_STATE_STEP + 10)
#define UX_HOST_CLASS_HUB_DELAY_WAIT (UX_STATE_STEP + 11)
typedef struct UX_HUB_DESCRIPTOR_STRUCT
{
UCHAR bLength;
UCHAR bDescriptorType;
UCHAR bNbPorts;
UCHAR _align_wHubCharacteristics[1];
USHORT wHubCharacteristics;
UCHAR bPwrOn2PwrGood;
UCHAR bHubContrCurrent;
UCHAR bDeviceRemovable;
UCHAR bPortPwrCtrlMask;
UCHAR _align_size[2];
} UX_HUB_DESCRIPTOR;
/* Define HUB Class instance structure. */
typedef struct UX_HOST_CLASS_HUB_STRUCT
{
struct UX_HOST_CLASS_HUB_STRUCT
*ux_host_class_hub_next_instance;
UX_HOST_CLASS *ux_host_class_hub_class;
UX_DEVICE *ux_host_class_hub_device;
UX_ENDPOINT *ux_host_class_hub_interrupt_endpoint;
UX_INTERFACE *ux_host_class_hub_interface;
UINT ux_host_class_hub_instance_status;
UINT ux_host_class_hub_state;
UINT ux_host_class_hub_change_semaphore;
struct UX_HUB_DESCRIPTOR_STRUCT
ux_host_class_hub_descriptor;
UINT ux_host_class_hub_port_state;
UINT ux_host_class_hub_port_power;
#if defined(UX_HOST_STANDALONE)
UINT ux_host_class_hub_run_status;
UCHAR *ux_host_class_hub_allocated;
UX_TRANSFER *ux_host_class_hub_transfer;
USHORT ux_host_class_hub_run_port_change;
USHORT ux_host_class_hub_run_port_status;
ULONG ux_host_class_hub_wait_start;
ULONG ux_host_class_hub_wait_ms;
UCHAR ux_host_class_hub_enum_state;
UCHAR ux_host_class_hub_run_state;
UCHAR ux_host_class_hub_next_state;
UCHAR ux_host_class_hub_run_port;
#endif
} UX_HOST_CLASS_HUB;
/* Define HUB Class function prototypes. */
UINT _ux_host_class_hub_activate(UX_HOST_CLASS_COMMAND *command);
VOID _ux_host_class_hub_change_detect(VOID);
UINT _ux_host_class_hub_change_process(UX_HOST_CLASS_HUB *hub);
UINT _ux_host_class_hub_configure(UX_HOST_CLASS_HUB *hub);
UINT _ux_host_class_hub_deactivate(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_hub_descriptor_get(UX_HOST_CLASS_HUB *hub);
UINT _ux_host_class_hub_entry(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_hub_feature(UX_HOST_CLASS_HUB *hub, UINT port, UINT command, UINT function);
UINT _ux_host_class_hub_hub_change_process(UX_HOST_CLASS_HUB *hub);
UINT _ux_host_class_hub_interrupt_endpoint_start(UX_HOST_CLASS_HUB *hub);
VOID _ux_host_class_hub_port_change_connection_process(UX_HOST_CLASS_HUB *hub, UINT port, UINT port_status);
VOID _ux_host_class_hub_port_change_enable_process(UX_HOST_CLASS_HUB *hub, UINT port, UINT port_status);
VOID _ux_host_class_hub_port_change_over_current_process(UX_HOST_CLASS_HUB *hub, UINT port, UINT port_status);
UINT _ux_host_class_hub_port_change_process(UX_HOST_CLASS_HUB *hub, UINT port);
VOID _ux_host_class_hub_port_change_reset_process(UX_HOST_CLASS_HUB *hub, UINT port, UINT port_status);
VOID _ux_host_class_hub_port_change_suspend_process(UX_HOST_CLASS_HUB *hub, UINT port, UINT port_status);
UINT _ux_host_class_hub_port_reset(UX_HOST_CLASS_HUB *hub, UINT port);
UINT _ux_host_class_hub_ports_power(UX_HOST_CLASS_HUB *hub);
UINT _ux_host_class_hub_status_get(UX_HOST_CLASS_HUB *hub, UINT port, USHORT *port_status, USHORT *port_change);
VOID _ux_host_class_hub_transfer_request_completed(UX_TRANSFER *transfer_request);
UINT _ux_host_class_hub_tasks_run(UX_HOST_CLASS *hub_class);
/* Determine if a C++ compiler is being used. If so, complete the standard
C conditional started above. */
#ifdef __cplusplus
}
#endif
#endif
Reference in New Issue View Git Blame Copy Permalink