1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** Pictbridge Application */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_pictbridge.h"
#include "ux_device_stack.h"
#include "ux_device_class_pima.h"
#ifdef UX_PIMA_WITH_MTP_SUPPORT
static USHORT _dpsclient_object_prop_supported[] = {0};
static UINT _dpsclient_object_prop_desc_get (struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG object_property,
ULONG object_format_code,
UCHAR **object_prop_dataset,
ULONG *object_prop_dataset_length)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(object_property);
UX_PARAMETER_NOT_USED(object_format_code);
UX_PARAMETER_NOT_USED(object_prop_dataset);
UX_PARAMETER_NOT_USED(object_prop_dataset_length);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
static UINT _dpsclient_object_prop_value_get (struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG object_handle,
ULONG object_property,
UCHAR **object_prop_value,
ULONG *object_prop_value_length)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(object_handle);
UX_PARAMETER_NOT_USED(object_property);
UX_PARAMETER_NOT_USED(object_prop_value);
UX_PARAMETER_NOT_USED(object_prop_value_length);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
static UINT _dpsclient_object_prop_value_set (struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG object_handle,
ULONG object_property,
UCHAR *object_prop_value,
ULONG object_prop_value_length)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(object_handle);
UX_PARAMETER_NOT_USED(object_property);
UX_PARAMETER_NOT_USED(object_prop_value);
UX_PARAMETER_NOT_USED(object_prop_value_length);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
static UINT _dpsclient_object_references_get (struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG object_handle,
UCHAR **object_references_array,
ULONG *object_references_array_length)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(object_handle);
UX_PARAMETER_NOT_USED(object_references_array);
UX_PARAMETER_NOT_USED(object_references_array_length);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
static UINT _dpsclient_object_references_set (struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG object_handle,
UCHAR *object_references_array,
ULONG object_references_array_length)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(object_handle);
UX_PARAMETER_NOT_USED(object_references_array);
UX_PARAMETER_NOT_USED(object_references_array_length);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
#endif
static UINT _dpsclient_device_reset(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima)
{
UX_PARAMETER_NOT_USED(pima);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
static UINT _dpsclient_device_prop_desc_get(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG device_property,
UCHAR **device_prop_dataset,
ULONG *device_prop_dataset_length)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(device_property);
UX_PARAMETER_NOT_USED(device_prop_dataset);
UX_PARAMETER_NOT_USED(device_prop_dataset_length);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
static UINT _dpsclient_device_prop_value_get(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG device_property,
UCHAR **device_prop_value,
ULONG *device_prop_value_length)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(device_property);
UX_PARAMETER_NOT_USED(device_prop_value);
UX_PARAMETER_NOT_USED(device_prop_value_length);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
static UINT _dpsclient_device_prop_value_set(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG device_property,
UCHAR *device_prop_value,
ULONG device_prop_value_length)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(device_property);
UX_PARAMETER_NOT_USED(device_prop_value);
UX_PARAMETER_NOT_USED(device_prop_value_length);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
static UINT _dpsclient_storage_format(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima,
ULONG storage_id)
{
UX_PARAMETER_NOT_USED(pima);
UX_PARAMETER_NOT_USED(storage_id);
return(UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_pictbridge_dpsclient_start PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function starts the DPS client (usually a camera or phone) */
/* */
/* INPUT */
/* */
/* pima Pima instance associated */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* */
/* CALLED BY */
/* */
/* user application */
/* */
/**************************************************************************/
UINT _ux_pictbridge_dpsclient_start(UX_PICTBRIDGE *pictbridge)
{
UINT status;
UX_SLAVE_CLASS_PIMA_OBJECT *object_info;
/* Allocate 1 object for the host. */
pictbridge -> ux_pictbridge_object_host = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY, sizeof(UX_SLAVE_CLASS_PIMA_OBJECT));
/* Check status. */
if (pictbridge -> ux_pictbridge_object_host == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Initialize status to success for things going on. */
status = UX_SUCCESS;
/* Allocate 1 object for the client. */
pictbridge -> ux_pictbridge_object_client = (VOID *)_ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY, sizeof(UX_SLAVE_CLASS_PIMA_OBJECT));
/* Check status. */
if (pictbridge -> ux_pictbridge_object_client == UX_NULL)
status = (UX_MEMORY_INSUFFICIENT);
/* Allocate 1 object for the job. */
if (status == UX_SUCCESS)
{
pictbridge -> ux_pictbridge_jobinfo.ux_pictbridge_jobinfo_object = (VOID *)_ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY, sizeof(UX_SLAVE_CLASS_PIMA_OBJECT));
/* Check status. */
if (pictbridge -> ux_pictbridge_jobinfo.ux_pictbridge_jobinfo_object == UX_NULL)
status = (UX_MEMORY_INSUFFICIENT);
}
/* Allocate some memory for the XML objects. For the client script. */
if (status == UX_SUCCESS)
{
object_info = (UX_SLAVE_CLASS_PIMA_OBJECT *) pictbridge -> ux_pictbridge_object_client;
object_info -> ux_device_class_pima_object_buffer = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY, UX_PICTBRIDGE_MAX_PIMA_OBJECT_BUFFER);
/* Check status. */
if (object_info -> ux_device_class_pima_object_buffer == UX_NULL)
status = (UX_MEMORY_INSUFFICIENT);
}
/* Allocate some memory for the XML objects. For the host script. */
if (status == UX_SUCCESS)
{
object_info = (UX_SLAVE_CLASS_PIMA_OBJECT *) pictbridge -> ux_pictbridge_object_host;
object_info -> ux_device_class_pima_object_buffer = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY, UX_PICTBRIDGE_MAX_PIMA_OBJECT_BUFFER);
/* Check status. */
if (object_info -> ux_device_class_pima_object_buffer == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
}
/* Create a event flag group for the client to communicate with the application. */
if (status == UX_SUCCESS)
{
status = _ux_system_event_flags_create(&pictbridge -> ux_pictbridge_event_flags_group, "ux_pictbridge_client_event_flag");
/* Check status. */
if (status != UX_SUCCESS)
/* Do not proceed if error. */
status = (UX_EVENT_ERROR);
}
/* Create the semaphore to wake up the thread. */
if (status == UX_SUCCESS)
{
status = _ux_system_semaphore_create(&pictbridge -> ux_pictbridge_notification_semaphore, "ux_pictbridge_client_semaphore", 0);
if (status != UX_SUCCESS)
/* Do not proceed if error. */
status = (UX_SEMAPHORE_ERROR);
}
/* Allocate a Thread stack. */
if (status == UX_SUCCESS)
{
pictbridge -> ux_pictbridge_thread_stack =
_ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, UX_PICTBRIDGE_THREAD_STACK_SIZE);
/* Check the completion status. */
if (pictbridge -> ux_pictbridge_thread_stack == UX_NULL)
/* Do not proceed if error. */
return(UX_MEMORY_INSUFFICIENT);
}
/* Create the pictbridge class thread. */
if (status == UX_SUCCESS)
{
status = _ux_system_thread_create(&pictbridge -> ux_pictbridge_thread,
"ux_pictbridge_thread", _ux_pictbridge_dpsclient_thread,
(ULONG)(ALIGN_TYPE) pictbridge,
pictbridge -> ux_pictbridge_thread_stack,
UX_PICTBRIDGE_THREAD_STACK_SIZE,
UX_PICTBRIDGE_THREAD_PRIORITY_CLASS,
UX_PICTBRIDGE_THREAD_PRIORITY_CLASS,
UX_NO_TIME_SLICE, UX_AUTO_START);
/* Check the completion status. */
if (status != UX_SUCCESS)
/* Do not proceed if error. */
status = (UX_THREAD_ERROR);
UX_THREAD_EXTENSION_PTR_SET(&(pictbridge -> ux_pictbridge_thread), pictbridge)
}
/* Go on to next step. */
if (status == UX_SUCCESS)
{
/* Initialize the pictbridge request/response state to request expected. */
pictbridge -> ux_pictbridge_request_response = UX_PICTBRIDGE_REQUEST;
/* Set the host/client cycle to idle. */
pictbridge -> ux_pictbridge_host_client_state_machine = UX_PICTBRIDGE_STATE_MACHINE_IDLE;
/* Initialize the first XML object valid in the pictbridge instance. Initialize the handle, type and file name.
The storage handle and the object handle have a fixed value of 1 in our implementation. */
object_info = pictbridge -> ux_pictbridge_object_client;
object_info -> ux_device_class_pima_object_format = UX_DEVICE_CLASS_PIMA_OFC_SCRIPT;
object_info -> ux_device_class_pima_object_storage_id = 1;
object_info -> ux_device_class_pima_object_handle_id = 2;
_ux_utility_string_to_unicode(_ux_pictbridge_ddiscovery_name, object_info -> ux_device_class_pima_object_filename);
/* Initialize the head and tail of the notification round robin buffers.
At first, the head and tail are pointing to the beginning of the array. */
pictbridge -> ux_pictbridge_event_array_head = pictbridge -> ux_pictbridge_event_array;
pictbridge -> ux_pictbridge_event_array_tail = pictbridge -> ux_pictbridge_event_array;
pictbridge -> ux_pictbridge_event_array_end = pictbridge -> ux_pictbridge_event_array + UX_PICTBRIDGE_MAX_EVENT_NUMBER;
/* Initialize the pima device parameter. */
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_manufacturer = pictbridge -> ux_pictbridge_dpslocal.ux_pictbridge_devinfo_vendor_name;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_model = pictbridge -> ux_pictbridge_dpslocal.ux_pictbridge_devinfo_product_name;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_serial_number = pictbridge -> ux_pictbridge_dpslocal.ux_pictbridge_devinfo_serial_no;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_id = 1;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_type = UX_DEVICE_CLASS_PIMA_STC_FIXED_RAM;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_file_system_type = UX_DEVICE_CLASS_PIMA_FSTC_GENERIC_FLAT;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_access_capability = UX_DEVICE_CLASS_PIMA_AC_READ_WRITE;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_max_capacity_low = pictbridge -> ux_pictbridge_dpslocal.ux_pictbridge_devinfo_storage_size;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_max_capacity_high = 0;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_free_space_low = pictbridge -> ux_pictbridge_dpslocal.ux_pictbridge_devinfo_storage_size;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_free_space_high = 0;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_free_space_image = 0;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_description = _ux_pictbridge_volume_description;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_volume_label = _ux_pictbridge_volume_label;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_number_get = _ux_pictbridge_dpsclient_object_number_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_handles_get = _ux_pictbridge_dpsclient_object_handles_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_info_get = _ux_pictbridge_dpsclient_object_info_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_data_get = _ux_pictbridge_dpsclient_object_data_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_info_send = _ux_pictbridge_dpsclient_object_info_send;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_data_send = _ux_pictbridge_dpsclient_object_data_send;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_delete = _ux_pictbridge_dpsclient_object_delete;
#ifdef UX_PIMA_WITH_MTP_SUPPORT
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_properties_list = _dpsclient_object_prop_supported;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_prop_desc_get = _dpsclient_object_prop_desc_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_prop_value_get = _dpsclient_object_prop_value_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_prop_value_set = _dpsclient_object_prop_value_set;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_references_get = _dpsclient_object_references_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_object_references_set = _dpsclient_object_references_set;
#endif
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_device_reset = _dpsclient_device_reset;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_device_prop_desc_get = _dpsclient_device_prop_desc_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_device_prop_value_get = _dpsclient_device_prop_value_get;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_device_prop_value_set = _dpsclient_device_prop_value_set;
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_storage_format = _dpsclient_storage_format;
/* Store the instance owner. */
pictbridge -> ux_pictbridge_pima_parameter.ux_device_class_pima_parameter_application = (VOID *) pictbridge;
/* Initialize the device pima class. The class is connected with interface 0 */
status = _ux_device_stack_class_register(_ux_system_slave_class_pima_name, _ux_device_class_pima_entry,
1, 0, (VOID *)&pictbridge -> ux_pictbridge_pima_parameter);
}
/* Check status. */
if (status != UX_SUCCESS)
{
/* Free resources allocated so far. */
if (_ux_system_thread_created(&pictbridge -> ux_pictbridge_thread))
_ux_system_thread_delete(&pictbridge -> ux_pictbridge_thread);
if (pictbridge -> ux_pictbridge_thread_stack)
_ux_utility_memory_free(pictbridge -> ux_pictbridge_thread_stack);
if (_ux_system_semaphore_created(&pictbridge -> ux_pictbridge_notification_semaphore))
_ux_system_semaphore_delete(&pictbridge -> ux_pictbridge_notification_semaphore);
if (_ux_system_event_flags_created(&pictbridge -> ux_pictbridge_event_flags_group))
_ux_system_event_flags_delete(&pictbridge -> ux_pictbridge_event_flags_group);
if (pictbridge -> ux_pictbridge_jobinfo.ux_pictbridge_jobinfo_object)
{
_ux_utility_memory_free(pictbridge -> ux_pictbridge_jobinfo.ux_pictbridge_jobinfo_object);
}
if (pictbridge -> ux_pictbridge_object_client)
{
object_info = (UX_SLAVE_CLASS_PIMA_OBJECT *) pictbridge -> ux_pictbridge_object_client;
if (object_info -> ux_device_class_pima_object_buffer)
_ux_utility_memory_free(object_info -> ux_device_class_pima_object_buffer);
_ux_utility_memory_free(pictbridge -> ux_pictbridge_object_client);
}
object_info = (UX_SLAVE_CLASS_PIMA_OBJECT *) pictbridge -> ux_pictbridge_object_host;
if (object_info -> ux_device_class_pima_object_buffer)
_ux_utility_memory_free(object_info -> ux_device_class_pima_object_buffer);
_ux_utility_memory_free(pictbridge -> ux_pictbridge_object_host);
/* Do not proceed if error. */
return(status);
}
/* We are done. */
return(UX_SUCCESS);
}
|
