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 Pima Class */
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_class_pima.h"
29 #include "ux_device_stack.h"
30
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _ux_device_class_pima_object_add PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Chaoqiong Xiao, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function sends an event to the host to inform that an object */
45 /* has been added. */
46 /* */
47 /* INPUT */
48 /* */
49 /* pima Pointer to pima class */
50 /* object_handle Handle of object to delete */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* Completion Status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _ux_device_class_pima_event_set Add PIMA event to queue */
59 /* */
60 /* CALLED BY */
61 /* */
62 /* Device Pima Class */
63 /* */
64 /* RELEASE HISTORY */
65 /* */
66 /* DATE NAME DESCRIPTION */
67 /* */
68 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
69 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
70 /* resulting in version 6.1 */
71 /* */
72 /**************************************************************************/
_ux_device_class_pima_object_add(UX_SLAVE_CLASS_PIMA * pima,ULONG object_handle)73 UINT _ux_device_class_pima_object_add(UX_SLAVE_CLASS_PIMA *pima, ULONG object_handle)
74 {
75
76 UINT status;
77 UX_SLAVE_CLASS_PIMA_EVENT pima_event;
78
79 /* If trace is enabled, insert this event into the trace buffer. */
80 UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PIMA_OBJECT_ADD, pima, object_handle, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
81
82 /* Set the pima code for object added. */
83 pima_event.ux_device_class_pima_event_code = UX_DEVICE_CLASS_PIMA_EC_REQUEST_OBJECT_TRANSFER;
84
85 /* Set the object handle. */
86 pima_event.ux_device_class_pima_event_parameter_1 = object_handle;
87
88 /* Other parameters are not used. */
89 pima_event.ux_device_class_pima_event_parameter_2 = 0;
90 pima_event.ux_device_class_pima_event_parameter_3 = 0;
91
92 /* Add the event. */
93 status = _ux_device_class_pima_event_set(pima, &pima_event);
94
95 /* Return completion status. */
96 return(status);
97 }
98
99
100
