/*************************************************************************** * 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 */ /** */ /** Video Class */ /** */ /**************************************************************************/ /**************************************************************************/ /* Include necessary system files. */ #define UX_SOURCE_CODE #include "ux_api.h" #include "ux_host_class_video.h" #include "ux_host_stack.h" /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _ux_host_class_video_control_value_get PORTABLE C */ /* 6.1.11 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function obtains the current values for a single video control.*/ /* */ /* INPUT */ /* */ /* video Pointer to video class */ /* video_control Pointer to video control */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_host_stack_class_instance_verify Verify instance is valid */ /* _ux_host_stack_transfer_request Process transfer request */ /* _ux_host_semaphore_get Get semaphore */ /* _ux_host_semaphore_put Release semaphore */ /* _ux_utility_memory_allocate Allocate memory block */ /* _ux_utility_memory_free Release memory block */ /* _ux_utility_short_get Read 16-bit value */ /* _ux_system_error_handler Log system error */ /* */ /* CALLED BY */ /* */ /* Application */ /* Video Class */ /* */ /**************************************************************************/ UINT _ux_host_class_video_control_value_get(UX_HOST_CLASS_VIDEO *video, UX_HOST_CLASS_VIDEO_CONTROL *video_control) { UX_ENDPOINT *control_endpoint; UX_TRANSFER *transfer_request; UINT status; UCHAR * control_buffer; /* Ensure the instance is valid. */ if (_ux_host_stack_class_instance_verify(_ux_system_host_class_video_name, (VOID *) video) != UX_SUCCESS) { /* Error trap. */ _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_INSTANCE_UNKNOWN); /* If trace is enabled, insert this event into the trace buffer. */ //UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_INSTANCE_UNKNOWN, video, 0, 0, UX_TRACE_ERRORS, 0, 0) return(UX_HOST_CLASS_INSTANCE_UNKNOWN); } /* Protect thread reentry to this instance. */ status = _ux_host_semaphore_get(&video -> ux_host_class_video_semaphore, UX_WAIT_FOREVER); if (status != UX_SUCCESS) return(status); /* We need to get the default control endpoint transfer request pointer. */ control_endpoint = &video -> ux_host_class_video_device -> ux_device_control_endpoint; transfer_request = &control_endpoint -> ux_endpoint_transfer_request; /* Need to allocate memory for the control buffer. */ control_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, 2); if (control_buffer == UX_NULL) { /* Unprotect thread reentry to this instance. */ _ux_host_semaphore_put(&video -> ux_host_class_video_semaphore); /* Return an error. */ return(UX_MEMORY_INSUFFICIENT); } /* Protect the control endpoint semaphore here. It will be unprotected in the transfer request function. */ status = _ux_host_semaphore_get(&video -> ux_host_class_video_device -> ux_device_protection_semaphore, UX_WAIT_FOREVER); /* Check for status. */ if (status != UX_SUCCESS) /* Something went wrong. */ return(status); /* Create a transfer request for the GET_MIN request. */ transfer_request -> ux_transfer_request_data_pointer = control_buffer; transfer_request -> ux_transfer_request_requested_length = 2; transfer_request -> ux_transfer_request_function = UX_HOST_CLASS_VIDEO_GET_CUR; transfer_request -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE; transfer_request -> ux_transfer_request_value = (video_control -> ux_host_class_video_control << 8); transfer_request -> ux_transfer_request_index = video -> ux_host_class_video_control_interface_number | (video -> ux_host_class_video_feature_unit_id << 8); /* Send request to HCD layer. */ status = _ux_host_stack_transfer_request(transfer_request); /* Check for correct transfer and entire control buffer returned. */ if ((status == UX_SUCCESS) && (transfer_request -> ux_transfer_request_actual_length == 2)) { /* Update the MIN static value for the caller. */ video_control -> ux_host_class_video_control_cur = (LONG)(SHORT)_ux_utility_short_get(control_buffer); } else { /* Free the previous control buffer. */ _ux_utility_memory_free(control_buffer); /* Unprotect thread reentry to this instance. */ _ux_host_semaphore_put(&video -> ux_host_class_video_semaphore); /* Return completion status. */ return(UX_TRANSFER_ERROR); } /* Free all used resources. */ _ux_utility_memory_free(control_buffer); /* Unprotect thread reentry to this instance. */ _ux_host_semaphore_put(&video -> ux_host_class_video_semaphore); /* Return completion status. */ return(status); } /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _uxe_host_class_video_control_value_get PORTABLE C */ /* 6.3.0 */ /* AUTHOR */ /* */ /* Yajun Xia, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function checks errors in video control value get function */ /* call. */ /* */ /* INPUT */ /* */ /* video Pointer to video class */ /* video_control Pointer to video control */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_host_class_video_control_value_get */ /* Get the video control value */ /* */ /* CALLED BY */ /* */ /* Application */ /* Video Class */ /* */ /**************************************************************************/ UINT _uxe_host_class_video_control_value_get(UX_HOST_CLASS_VIDEO *video, UX_HOST_CLASS_VIDEO_CONTROL *video_control) { /* Sanity Checks. */ if ((video == UX_NULL) || (video_control == UX_NULL)) return(UX_INVALID_PARAMETER); /* Call the actual video control value get function. */ return(_ux_host_class_video_control_value_get(video, video_control)); }