1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** USBX Component */
17 /** */
18 /** Device Pima Class */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define UX_SOURCE_CODE
24
25
26 /* Include necessary system files. */
27
28 #include "ux_api.h"
29 #include "ux_device_class_pima.h"
30 #include "ux_device_stack.h"
31
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _ux_device_class_pima_object_add PORTABLE C */
38 /* 6.1 */
39 /* AUTHOR */
40 /* */
41 /* Chaoqiong Xiao, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function sends an event to the host to inform that an object */
46 /* has been added. */
47 /* */
48 /* INPUT */
49 /* */
50 /* pima Pointer to pima class */
51 /* object_handle Handle of object to delete */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* Completion Status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _ux_device_class_pima_event_set Add PIMA event to queue */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Device Pima Class */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
70 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_ux_device_class_pima_object_add(UX_SLAVE_CLASS_PIMA * pima,ULONG object_handle)74 UINT _ux_device_class_pima_object_add(UX_SLAVE_CLASS_PIMA *pima, ULONG object_handle)
75 {
76
77 UINT status;
78 UX_SLAVE_CLASS_PIMA_EVENT pima_event;
79
80 /* If trace is enabled, insert this event into the trace buffer. */
81 UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PIMA_OBJECT_ADD, pima, object_handle, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
82
83 /* Set the pima code for object added. */
84 pima_event.ux_device_class_pima_event_code = UX_DEVICE_CLASS_PIMA_EC_REQUEST_OBJECT_TRANSFER;
85
86 /* Set the object handle. */
87 pima_event.ux_device_class_pima_event_parameter_1 = object_handle;
88
89 /* Other parameters are not used. */
90 pima_event.ux_device_class_pima_event_parameter_2 = 0;
91 pima_event.ux_device_class_pima_event_parameter_3 = 0;
92
93 /* Add the event. */
94 status = _ux_device_class_pima_event_set(pima, &pima_event);
95
96 /* Return completion status. */
97 return(status);
98 }
99
100
101
