1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11
12 /**************************************************************************/
13 /**************************************************************************/
14 /** */
15 /** USBX Component */
16 /** */
17 /** Host Stack */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22
23 /* Include necessary system files. */
24
25 #define UX_SOURCE_CODE
26
27 #include "ux_api.h"
28 #include "ux_host_stack.h"
29
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _ux_host_stack_rh_device_extraction PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Chaoqiong Xiao, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function handles a device extraction on a downstream port */
44 /* of the root hub pointed by HCD. */
45 /* */
46 /* INPUT */
47 /* */
48 /* HCD Pointer to HCD structure */
49 /* port_index Port index of insertion */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* Completion Status */
54 /* */
55 /* CALLS */
56 /* */
57 /* _ux_host_stack_device_remove Remove device */
58 /* */
59 /* CALLED BY */
60 /* */
61 /* USBX Components */
62 /* */
63 /* RELEASE HISTORY */
64 /* */
65 /* DATE NAME DESCRIPTION */
66 /* */
67 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
68 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
69 /* resulting in version 6.1 */
70 /* */
71 /**************************************************************************/
_ux_host_stack_rh_device_extraction(UX_HCD * hcd,UINT port_index)72 UINT _ux_host_stack_rh_device_extraction(UX_HCD *hcd, UINT port_index)
73 {
74
75 /* If trace is enabled, insert this event into the trace buffer. */
76 UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_STACK_RH_DEVICE_EXTRACTION, hcd, port_index, 0, 0, UX_TRACE_HOST_STACK_EVENTS, 0, 0)
77
78 /* Ask the stack to remove the device, pass the value 0 as the parent root hub. */
79 _ux_host_stack_device_remove(hcd, 0, port_index);
80
81 /* The device has been removed, so the port is free again. */
82 hcd -> ux_hcd_rh_device_connection &= (ULONG)~(1 << port_index);
83
84 /* That command should never fail! */
85 return(UX_SUCCESS);
86 }
87
88
