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 /** Video Class */
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_class_video.h"
29 #include "ux_host_stack.h"
30
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _ux_host_class_video_transfer_callback_set PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Chaoqiong Xiao, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function sets the callback function for video transfers. */
45 /* */
46 /* INPUT */
47 /* */
48 /* video Pointer to video class */
49 /* callback_function Pointer to callback function */
50 /* */
51 /* OUTPUT */
52 /* */
53 /* Completion Status */
54 /* */
55 /* CALLS */
56 /* */
57 /* None */
58 /* */
59 /* CALLED BY */
60 /* */
61 /* Application */
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_class_video_transfer_callback_set(UX_HOST_CLASS_VIDEO * video,VOID (* callback_function)(UX_TRANSFER *))72 VOID _ux_host_class_video_transfer_callback_set(UX_HOST_CLASS_VIDEO *video, VOID (*callback_function)(UX_TRANSFER*))
73 {
74
75 /* Save the callback function in the video instance. */
76 video -> ux_host_class_video_transfer_completion_function = callback_function;
77 }
78
79
80 /**************************************************************************/
81 /* */
82 /* FUNCTION RELEASE */
83 /* */
84 /* _uxe_host_class_video_transfer_callback_set PORTABLE C */
85 /* 6.3.0 */
86 /* AUTHOR */
87 /* */
88 /* Yajun Xia, Microsoft Corporation */
89 /* */
90 /* DESCRIPTION */
91 /* */
92 /* This function checks errors in video transfer callback set function */
93 /* call. */
94 /* */
95 /* INPUT */
96 /* */
97 /* video Pointer to video class */
98 /* callback_function Pointer to callback function */
99 /* */
100 /* OUTPUT */
101 /* */
102 /* Completion Status */
103 /* */
104 /* CALLS */
105 /* */
106 /* _ux_host_class_video_transfer_callback_set */
107 /* video transfer callback set */
108 /* */
109 /* CALLED BY */
110 /* */
111 /* Application */
112 /* */
113 /* RELEASE HISTORY */
114 /* */
115 /* DATE NAME DESCRIPTION */
116 /* */
117 /* 10-31-2023 Yajun xia Initial Version 6.3.0 */
118 /* */
119 /**************************************************************************/
_uxe_host_class_video_transfer_callback_set(UX_HOST_CLASS_VIDEO * video,VOID (* callback_function)(UX_TRANSFER *))120 VOID _uxe_host_class_video_transfer_callback_set(UX_HOST_CLASS_VIDEO *video, VOID (*callback_function)(UX_TRANSFER*))
121 {
122
123 /* Sanity checks. */
124 if (video == UX_NULL)
125 {
126
127 /* Return error. */
128 _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_INVALID_PARAMETER);
129 return;
130 }
131
132 /* Call the actual video transfer callback set function. */
133 _ux_host_class_video_transfer_callback_set(video, callback_function);
134 }
