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_delete PORTABLE C */
38 /* 6.1.10 */
39 /* AUTHOR */
40 /* */
41 /* Chaoqiong Xiao, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function informs the application that an object is to be */
46 /* deleted. The handle points to an object or all objects if -1 */
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_response_send Send PIMA response */
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 /* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
73 /* updated status handling, */
74 /* resulting in version 6.1.10 */
75 /* */
76 /**************************************************************************/
_ux_device_class_pima_object_delete(UX_SLAVE_CLASS_PIMA * pima,ULONG object_handle,ULONG object_format)77 UINT _ux_device_class_pima_object_delete(UX_SLAVE_CLASS_PIMA *pima, ULONG object_handle, ULONG object_format)
78 {
79
80 UINT status;
81
82 /* If trace is enabled, insert this event into the trace buffer. */
83 UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PIMA_OBJECT_DELETE, pima, object_handle, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
84
85 if (object_format == 0)
86
87 /* Invoke the application callback function. */
88 status = pima -> ux_device_class_pima_object_delete(pima, object_handle);
89 else
90
91 /* Not supported. */
92 status = UX_DEVICE_CLASS_PIMA_RC_FORMAT_UNSUPPORTED;
93
94 /* Response status. */
95 status = _ux_device_class_pima_response_send(pima, (status == UX_SUCCESS) ?
96 UX_DEVICE_CLASS_PIMA_RC_OK : status, 0, 0, 0, 0);
97
98 /* Return completion status. */
99 return(status);
100 }
101
