/*************************************************************************** * 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_transfer_buffers_add PORTABLE C */ /* 6.3.0 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function adds buffers for video transfer requests. */ /* */ /* Usually it's the very first step to start a video stream on a high */ /* bandwidth isochronous endpoint. Since adding new buffer while */ /* the prepared buffers in progress helps to improve performance. */ /* */ /* Note the maximum number of transfers could be buffered is */ /* UX_HOST_CLASS_VIDEO_TRANSFER_REQUEST_COUNT - 1. */ /* */ /* Note check ux_host_class_video_max_payload_get to see minimum */ /* recommended buffer size. */ /* */ /* INPUT */ /* */ /* video Pointer to video class */ /* buffers Pointer to data buffer */ /* pointers array */ /* num_buffers Number of data buffers */ /* */ /* 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_system_error_handler Log system error */ /* */ /* CALLED BY */ /* */ /* Application */ /* */ /**************************************************************************/ UINT _ux_host_class_video_transfer_buffers_add(UX_HOST_CLASS_VIDEO *video, UCHAR** buffers, ULONG num_buffers) { UINT status; UX_TRANSFER *transfer_request; UX_TRANSFER *previous_transfer; UX_ENDPOINT *endpoint; ULONG transfer_index; ULONG packet_size; UINT i; /* 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); 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); /* Get endpoint. */ endpoint = video -> ux_host_class_video_isochronous_endpoint; /* Ensure we have a selected interface that allows isoch transmission. */ if ((endpoint == UX_NULL) || (endpoint -> ux_endpoint_descriptor.wMaxPacketSize == 0)) { /* Unprotect thread reentry to this instance. */ _ux_host_semaphore_put(&video -> ux_host_class_video_semaphore); /* Error trap. */ _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_VIDEO_WRONG_INTERFACE); /* Return error status. */ return(UX_HOST_CLASS_VIDEO_WRONG_INTERFACE); } /* Check if there is enough requests available. */ if (video -> ux_host_class_video_transfer_request_start_index >= video -> ux_host_class_video_transfer_request_end_index) { if (video -> ux_host_class_video_transfer_request_start_index + num_buffers >= video -> ux_host_class_video_transfer_request_end_index + UX_HOST_CLASS_VIDEO_TRANSFER_REQUEST_COUNT) status = (UX_MEMORY_ARRAY_FULL); } else { if (video -> ux_host_class_video_transfer_request_start_index + num_buffers >= video -> ux_host_class_video_transfer_request_end_index) status = (UX_MEMORY_ARRAY_FULL); } /* Check error. */ if (status != UX_SUCCESS) { /* Unprotect thread reentry to this instance. */ _ux_host_semaphore_put(&video -> ux_host_class_video_semaphore); /* Return error status. */ return(status); } /* Calculate packet size. */ packet_size = video -> ux_host_class_video_current_max_payload_size; /* Add buffers one by one. */ for (i = 0, transfer_index = video -> ux_host_class_video_transfer_request_start_index, previous_transfer = UX_NULL; i < num_buffers; i ++) { transfer_request = &video->ux_host_class_video_transfer_requests[transfer_index]; /* Select the direction. We do this by taking the endpoint direction. */ transfer_request -> ux_transfer_request_type = endpoint -> ux_endpoint_descriptor.bEndpointAddress & UX_REQUEST_DIRECTION; /* Fill the transfer request with all the required fields. */ transfer_request -> ux_transfer_request_endpoint = endpoint; transfer_request -> ux_transfer_request_data_pointer = buffers[i]; transfer_request -> ux_transfer_request_requested_length = packet_size; transfer_request -> ux_transfer_request_completion_function = _ux_host_class_video_transfer_request_callback; transfer_request -> ux_transfer_request_class_instance = video; /* Confirm the transfer request is single one. */ transfer_request -> ux_transfer_request_next_transfer_request = UX_NULL; /* Link to transfer request tail. */ if (previous_transfer) previous_transfer -> ux_transfer_request_next_transfer_request = transfer_request; /* Save as previous request. */ previous_transfer = transfer_request; /* Move to next transfer request. */ transfer_index ++; if (transfer_index >= UX_HOST_CLASS_VIDEO_TRANSFER_REQUEST_COUNT) transfer_index = 0; } /* Get request list head. */ transfer_request = &video -> ux_host_class_video_transfer_requests[video->ux_host_class_video_transfer_request_start_index]; /* Move request index. */ video -> ux_host_class_video_transfer_request_start_index = transfer_index; /* Set endpoint to pending state, for callback and abort to check. */ endpoint -> ux_endpoint_transfer_request.ux_transfer_request_completion_code = UX_TRANSFER_STATUS_PENDING; /* Transfer the transfer request (list). */ status = _ux_host_stack_transfer_request(transfer_request); /* 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_transfer_buffers_add PORTABLE C */ /* 6.3.0 */ /* AUTHOR */ /* */ /* Yajun Xia, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function checks errors in video transfer buffers add function */ /* call. */ /* */ /* INPUT */ /* */ /* video Pointer to video class */ /* buffers Pointer to data buffer */ /* pointers array */ /* num_buffers Number of data buffers */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_host_class_video_transfer_buffers_add */ /* video transfer buffers add */ /* */ /* CALLED BY */ /* */ /* Application */ /* */ /**************************************************************************/ UINT _uxe_host_class_video_transfer_buffers_add(UX_HOST_CLASS_VIDEO *video, UCHAR** buffers, ULONG num_buffers) { /* Sanity checks. */ if ((video == UX_NULL) || (buffers == UX_NULL) || (num_buffers == 0)) return(UX_INVALID_PARAMETER); /* Call the actual video transfer buffers add function. */ return(_ux_host_class_video_transfer_buffers_add(video, buffers, num_buffers)); }