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 /** Device Stack */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define UX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "ux_api.h"
28 #include "ux_device_stack.h"
29
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _ux_device_stack_host_wakeup PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Chaoqiong Xiao, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function is called when the device wants to wake up the host. */
44 /* This command is only valid when the device is in suspend mode. */
45 /* */
46 /* INPUT */
47 /* */
48 /* None */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* Completion Status */
53 /* */
54 /* CALLS */
55 /* */
56 /* (ux_slave_dcd_function) DCD dispatch function */
57 /* */
58 /* CALLED BY */
59 /* */
60 /* Application */
61 /* */
62 /* RELEASE HISTORY */
63 /* */
64 /* DATE NAME DESCRIPTION */
65 /* */
66 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
67 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
68 /* resulting in version 6.1 */
69 /* */
70 /**************************************************************************/
_ux_device_stack_host_wakeup(VOID)71 UINT _ux_device_stack_host_wakeup(VOID)
72 {
73
74 UX_SLAVE_DCD *dcd;
75 UINT status = UX_FUNCTION_NOT_SUPPORTED;
76
77 /* If trace is enabled, insert this event into the trace buffer. */
78 UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_STACK_HOST_WAKEUP, 0, 0, 0, 0, UX_TRACE_DEVICE_STACK_EVENTS, 0, 0)
79
80 /* Get the pointer to the DCD. */
81 dcd = &_ux_system_slave -> ux_system_slave_dcd;
82
83 /* Check if DEVICE_REMOTE_WAKEUP feature is enabled. */
84 if (_ux_system_slave -> ux_system_slave_remote_wakeup_enabled)
85
86 /* Send the change signal to the controller driver. */
87 status = dcd -> ux_slave_dcd_function(dcd, UX_DCD_CHANGE_STATE, (VOID *) UX_DEVICE_REMOTE_WAKEUP);
88
89 /* Return the status to the caller. */
90 return(status);
91 }
92
93
