/*************************************************************************** * 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 */ /** */ /** Printer Class */ /** */ /**************************************************************************/ /**************************************************************************/ /* Include necessary system files. */ #define UX_SOURCE_CODE #include "ux_api.h" #include "ux_host_class_printer.h" #include "ux_host_stack.h" /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _ux_host_class_printer_write PORTABLE C */ /* 6.1.10 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function writes to the printer interface. The call is blocking */ /* and only returns when there is either an error or when the transfer */ /* is complete. */ /* */ /* INPUT */ /* */ /* printer Pointer to printer class */ /* data_pointer Pointer to data to write */ /* requested_length Length of data to write */ /* actual_length Actual length of data written */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_host_stack_transfer_request Process transfer request */ /* _ux_host_stack_transfer_request_abort Abort transfer request */ /* _ux_host_semaphore_get Get protection semaphore */ /* _ux_host_semaphore_put Release protection semaphore */ /* */ /* CALLED BY */ /* */ /* Application */ /* */ /**************************************************************************/ UINT _ux_host_class_printer_write(UX_HOST_CLASS_PRINTER *printer, UCHAR * data_pointer, ULONG requested_length, ULONG *actual_length) { #if defined(UX_HOST_STANDALONE) UX_INTERRUPT_SAVE_AREA ULONG transfer_flags; #endif UX_TRANSFER *transfer_request; UINT status; ULONG transfer_request_length; /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PRINTER_WRITE, printer, data_pointer, requested_length, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0) /* Ensure the instance is valid. */ if (printer -> ux_host_class_printer_state != UX_HOST_CLASS_INSTANCE_LIVE) { /* 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, printer, 0, 0, UX_TRACE_ERRORS, 0, 0) return(UX_HOST_CLASS_INSTANCE_UNKNOWN); } #if defined(UX_HOST_STANDALONE) UX_DISABLE if (printer -> ux_host_class_printer_flags & UX_HOST_CLASS_PRINTER_FLAG_LOCK) { UX_RESTORE return(UX_BUSY); } printer -> ux_host_class_printer_flags |= UX_HOST_CLASS_PRINTER_FLAG_LOCK; UX_RESTORE #else /* Protect thread reentry to this instance. */ status = _ux_host_semaphore_get(&printer -> ux_host_class_printer_semaphore, UX_WAIT_FOREVER); if (status != UX_SUCCESS) /* Return error. */ return(status); #endif /* Start by resetting the actual length of the transfer. */ *actual_length = 0; /* Get the pointer to the bulk out endpoint transfer request. */ transfer_request = &printer -> ux_host_class_printer_bulk_out_endpoint -> ux_endpoint_transfer_request; #if defined(UX_HOST_STANDALONE) /* Enable blocking transfer flags. */ transfer_flags = transfer_request -> ux_transfer_request_flags; transfer_request -> ux_transfer_request_flags |= UX_TRANSFER_FLAG_AUTO_WAIT; #endif /* Perform a transfer on the bulk out endpoint until either the transfer is completed or when there is an error. */ do { /* Program the maximum authorized length for this transfer_request. */ if (requested_length > transfer_request -> ux_transfer_request_maximum_length) transfer_request_length = transfer_request -> ux_transfer_request_maximum_length; else transfer_request_length = requested_length; /* Initialize the transfer_request. */ transfer_request -> ux_transfer_request_data_pointer = data_pointer; transfer_request -> ux_transfer_request_requested_length = transfer_request_length; /* Perform the transfer. */ status = _ux_host_stack_transfer_request(transfer_request); /* If the transfer is successful, we need to wait for the transfer request to be completed. */ if (status == UX_SUCCESS) { #if !defined(UX_HOST_STANDALONE) /* Wait for the completion of the transfer request. */ status = _ux_host_semaphore_get(&transfer_request -> ux_transfer_request_semaphore, UX_MS_TO_TICK(UX_HOST_CLASS_PRINTER_CLASS_TRANSFER_TIMEOUT)); /* If the semaphore did not succeed we probably have a time out. */ if (status != UX_SUCCESS) { /* All transfers pending need to abort. There may have been a partial transfer. */ _ux_host_stack_transfer_request_abort(transfer_request); /* Update the length of the actual data transferred. We do this after the abort of the transfer_request in case some data actually went out. */ *actual_length += transfer_request -> ux_transfer_request_actual_length; /* Unprotect thread reentry to this instance. */ _ux_host_class_printer_unlock(printer); /* Set the completion code. */ transfer_request -> ux_transfer_request_completion_code = UX_TRANSFER_TIMEOUT; /* Error trap. */ _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_TRANSFER_TIMEOUT); /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_TRANSFER_TIMEOUT, transfer_request, 0, 0, UX_TRACE_ERRORS, 0, 0) /* There was an error, return to the caller. */ return(UX_TRANSFER_TIMEOUT); } #endif } else { #if defined(UX_HOST_STANDALONE) /* Restore transfer options. */ transfer_request -> ux_transfer_request_flags = transfer_flags; #endif /* Unprotect thread reentry to this instance. */ _ux_host_class_printer_unlock(printer); /* There was a non transfer error, no partial transfer to be checked */ return(status); } /* Update the length of the transfer. Normally all the data has to be sent. */ *actual_length += transfer_request -> ux_transfer_request_actual_length; /* Check for completion of transfer. If the transfer is partial, return to caller. The transfer is marked as successful but the caller will need to check the length actually sent and determine if a partial transfer is OK. */ if (transfer_request_length != transfer_request -> ux_transfer_request_actual_length) { #if defined(UX_HOST_STANDALONE) /* Restore transfer options. */ transfer_request -> ux_transfer_request_flags = transfer_flags; #endif /* Unprotect thread reentry to this instance. */ _ux_host_class_printer_unlock(printer); /* Return success. */ return(UX_SUCCESS); } /* Update the data pointer for next transfer. */ data_pointer += transfer_request_length; /* Update what is left to send out. */ requested_length -= transfer_request_length; } while (requested_length); #if defined(UX_HOST_STANDALONE) /* Restore transfer options. */ transfer_request -> ux_transfer_request_flags = transfer_flags; #endif /* Unprotect thread reentry to this instance. */ _ux_host_class_printer_unlock(printer); /* We get here when all the transfers went through without errors. */ return(UX_SUCCESS); } /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _uxe_host_class_printer_write PORTABLE C */ /* 6.3.0 */ /* AUTHOR */ /* */ /* Yajun Xia, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function checks errors in printer write function call. */ /* */ /* INPUT */ /* */ /* printer Pointer to printer class */ /* data_pointer Pointer to data to write */ /* requested_length Length of data to write */ /* actual_length Actual length of data written */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_host_class_printer_write Printer write */ /* */ /* CALLED BY */ /* */ /* Application */ /* */ /**************************************************************************/ UINT _uxe_host_class_printer_write(UX_HOST_CLASS_PRINTER *printer, UCHAR * data_pointer, ULONG requested_length, ULONG *actual_length) { /* Sanity checks. */ if ((printer == UX_NULL) || ((data_pointer == UX_NULL) && (requested_length > 0)) || (actual_length == UX_NULL)) { return(UX_INVALID_PARAMETER); } /* Call the actual printer write function. */ return(_ux_host_class_printer_write(printer, data_pointer, requested_length, actual_length)); }