/*************************************************************************** * 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 */ /** */ /** PIMA Class */ /** */ /**************************************************************************/ /**************************************************************************/ /* Include necessary system files. */ #define UX_SOURCE_CODE #include "ux_api.h" #include "ux_host_class_pima.h" #include "ux_host_stack.h" /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _ux_host_class_pima_device_info_get PORTABLE C */ /* 6.3.0 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function gets the device information block. */ /* */ /* INPUT */ /* */ /* pima Pointer to pima class */ /* pima_device Device structure to fill */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_host_class_pima_command Pima command function */ /* _ux_utility_descriptor_parse Unpack descriptor */ /* _ux_utility_memory_allocate Allocate memory */ /* _ux_utility_memory_copy Copy memory */ /* _ux_utility_memory_free Free allocated memory */ /* _ux_utility_short_get Get 16-bit value */ /* _ux_utility_long_get Get 32-bit value */ /* */ /* CALLED BY */ /* */ /* USB application */ /* */ /**************************************************************************/ UINT _ux_host_class_pima_device_info_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_DEVICE *pima_device) { UX_HOST_CLASS_PIMA_COMMAND command; UCHAR *device_buffer; UCHAR *device_pointer; ULONG unicode_string_length; ULONG array_length = 0; UINT status; /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PIMA_DEVICE_INFO_GET, pima, pima_device, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0) /* Issue command to get the device info. no parameter. */ command.ux_host_class_pima_command_nb_parameters = 0; /* Other parameters unused. */ command.ux_host_class_pima_command_parameter_1 = 0; command.ux_host_class_pima_command_parameter_2 = 0; command.ux_host_class_pima_command_parameter_3 = 0; command.ux_host_class_pima_command_parameter_4 = 0; command.ux_host_class_pima_command_parameter_5 = 0; /* Then set the command to GET_DEVICE_INFO. */ command.ux_host_class_pima_command_operation_code = UX_HOST_CLASS_PIMA_OC_GET_DEVICE_INFO; /* Allocate some DMA safe memory for receiving the device info block. */ device_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_HOST_CLASS_PIMA_DEVICE_MAX_LENGTH); if (device_buffer == UX_NULL) return(UX_MEMORY_INSUFFICIENT); /* Issue the command. */ status = _ux_host_class_pima_command(pima, &command, UX_HOST_CLASS_PIMA_DATA_PHASE_IN , device_buffer, UX_HOST_CLASS_PIMA_DEVICE_MAX_LENGTH, UX_HOST_CLASS_PIMA_DEVICE_MAX_LENGTH); /* Check the result. If the result is OK, the device info block was read properly. */ if (status == UX_SUCCESS) { /* Read and store the Standard Version field (2). */ pima_device -> ux_host_class_pima_device_standard_version = _ux_utility_short_get(device_buffer + UX_HOST_CLASS_PIMA_DEVICE_STANDARD_VERSION); /* Read and store the Vendor Extension ID (4). */ pima_device -> ux_host_class_pima_device_vendor_extension_id = _ux_utility_long_get(device_buffer + UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_ID); /* Read and store the Vendor Extension Version (2). */ pima_device -> ux_host_class_pima_device_vendor_extension_version = _ux_utility_long_get(device_buffer + UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_VERSION); /* Copy the vendor extension descriptor (String). */ device_pointer = device_buffer + UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_DESC; /* Get the unicode string length in chars. */ unicode_string_length = (ULONG) *device_pointer; /* Check if the string can fit in our buffer. */ if (unicode_string_length > UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH / 2) /* Return error. */ status = UX_MEMORY_INSUFFICIENT; /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy that unicode string (with null ending) into the object description field. */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_vendor_extension_desc, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */ /* Point to the next field. */ device_pointer += 1 + (unicode_string_length << 1); /* Read and store the Functional Mode (2). */ pima_device -> ux_host_class_pima_device_functional_mode = _ux_utility_short_get(device_pointer); /* Point to the next field (OperationsSupported OperationCode Array of 16-bit). */ device_pointer += sizeof(USHORT); /* Get the number of elements in array and compute total length. */ array_length = _ux_utility_long_get(device_pointer); if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2) status = UX_MEMORY_INSUFFICIENT; else { array_length <<= 1; array_length += (ULONG)sizeof(ULONG); } } /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy the array of supported operations (OperationCode). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_operations_supported, device_pointer, array_length); /* Use case of memcpy is verified. */ /* Point to the next field (EventsSupported EventCode Array of 16-bit). */ device_pointer += array_length; /* Get the number of elements in array and compute total length. */ array_length = _ux_utility_long_get(device_pointer); if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2) status = UX_MEMORY_INSUFFICIENT; else { array_length <<= 1; array_length += (ULONG)sizeof(ULONG); } } /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy the array of events supported (EventCode). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_events_supported, device_pointer, array_length); /* Use case of memcpy is verified. */ /* Point to the next field (DevicePropertiesSupported DevicePropCode Array of 16-bit). */ device_pointer += array_length; /* Get the number of elements in array and compute total length. */ array_length = _ux_utility_long_get(device_pointer); if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2) status = UX_MEMORY_INSUFFICIENT; else { array_length <<= 1; array_length += (ULONG)sizeof(ULONG); } } /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy the array of device properties (DevicePropCode). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_properties_supported, device_pointer, array_length); /* Use case of memcpy is verified. */ /* Point to the next field (CaptureFormats ObjectFormatCode Array of 16-bit). */ device_pointer += array_length; /* Get the number of elements in array and compute total length. */ array_length = _ux_utility_long_get(device_pointer); if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2) status = UX_MEMORY_INSUFFICIENT; else { array_length <<= 1; array_length += (ULONG)sizeof(ULONG); } } /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy the array of capture formats (CaptureFormats ObjectFormatCode). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_capture_formats, device_pointer, array_length); /* Use case of memcpy is verified. */ /* Point to the next field (ImageFormats ObjectFormatCode Array of 16-bit). */ device_pointer += array_length; /* Get the number of elements in array and compute total length. */ array_length = _ux_utility_long_get(device_pointer); if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2) status = UX_MEMORY_INSUFFICIENT; else { array_length <<= 1; array_length += (ULONG)sizeof(ULONG); } } /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy the array of supported operations (ImageFormats ObjectFormatCode). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_image_formats, device_pointer, array_length); /* Use case of memcpy is verified. */ /* Point to the next field (Manufacturer String). */ device_pointer += array_length; /* Get the unicode string length. */ unicode_string_length = (ULONG) *device_pointer; /* Ensure the string can fit in our buffer. */ if (unicode_string_length > UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH / 2) /* Return overflow error. */ status = UX_MEMORY_INSUFFICIENT; } /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy that string into the manufacturer field (Manufacturer String). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_manufacturer, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */ /* Point to the next field (Model String). */ device_pointer += (unicode_string_length << 1) + 1; /* Get the unicode string length. */ unicode_string_length = (ULONG) *device_pointer ; /* Ensure the string can fit in our buffer. */ if (unicode_string_length > UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH / 2) /* Return overflow error. */ status = UX_MEMORY_INSUFFICIENT; } /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy that string into the model date field (Model String). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_model, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */ /* Point to the next field (DeviceVersion String). */ device_pointer += (unicode_string_length << 1) + 1; /* Get the unicode string length. */ unicode_string_length = (ULONG) *device_pointer ; /* Ensure the string can fit in our buffer. */ if (unicode_string_length > UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH / 2) /* Return overflow error. */ status = UX_MEMORY_INSUFFICIENT; } /* Is there enough space? */ if (status == UX_SUCCESS) { /* Copy that string into the version field (DeviceVersion String). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_version, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */ /* Point to the next field (SerialNumber String). */ device_pointer += (unicode_string_length << 1) + 1; /* Get the unicode string length. */ unicode_string_length = (ULONG) *device_pointer ; /* Ensure the string can fit in our buffer. */ if (unicode_string_length > UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH / 2) /* Return overflow error. */ status = UX_MEMORY_INSUFFICIENT; } /* Is there enough space? */ if (status == UX_SUCCESS) /* Copy that string into the serial number field (SerialNumber String). */ _ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_serial_number, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */ else { /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_MEMORY_INSUFFICIENT, 0, 0, 0, UX_TRACE_ERRORS, 0, 0) /* Report error to application. */ _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_MEMORY_INSUFFICIENT); } } /* Free the original object info buffer. */ _ux_utility_memory_free(device_buffer); /* Return completion status. */ return(status); } /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _uxe_host_class_pima_device_info_get PORTABLE C */ /* 6.3.0 */ /* AUTHOR */ /* */ /* Yajun Xia, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function checks errors in pima device info get function call. */ /* */ /* INPUT */ /* */ /* pima Pointer to pima class */ /* pima_device Device structure to fill */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_host_class_pima_device_info_get Get pima device info */ /* */ /* CALLED BY */ /* */ /* USB application */ /* */ /**************************************************************************/ UINT _uxe_host_class_pima_device_info_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_DEVICE *pima_device) { /* Sanity Checks. */ if ((pima == UX_NULL) || (pima_device == UX_NULL)) return(UX_INVALID_PARAMETER); /* Call the actual pima device info get function. */ return(_ux_host_class_pima_device_info_get(pima, pima_device)); }