/*************************************************************************** * 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 */ /** */ /** Host Stack */ /** */ /**************************************************************************/ /**************************************************************************/ /* Include necessary system files. */ #define UX_SOURCE_CODE #include "ux_api.h" #include "ux_host_stack.h" /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _ux_host_stack_class_register PORTABLE C */ /* 6.1 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function registers a USB class to the USB stack. The Class */ /* must specify an entry point for the USB stack to send commands */ /* such as: */ /* */ /* UX_HOST_CLASS_COMMAND_QUERY */ /* UX_HOST_CLASS_COMMAND_ACTIVATE */ /* UX_HOST_CLASS_COMMAND_DESTROY */ /* */ /* Note: The C string of class_name must be NULL-terminated and the */ /* length of it (without the NULL-terminator itself) must be no larger */ /* than UX_MAX_CLASS_NAME_LENGTH. */ /* */ /* INPUT */ /* */ /* class_name Name of class */ /* class_entry_function Entry function of the class */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_utility_string_length_check Check C string and return */ /* length if null-terminated */ /* _ux_utility_memory_copy Copy memory block */ /* */ /* CALLED BY */ /* */ /* Application */ /* USBX Components */ /* */ /**************************************************************************/ UINT _ux_host_stack_class_register(UCHAR *class_name, UINT (*class_entry_function)(struct UX_HOST_CLASS_COMMAND_STRUCT *)) { UX_HOST_CLASS *class_inst; #if !defined(UX_NAME_REFERENCED_BY_POINTER) UINT status; UINT class_name_length = 0; #endif #if UX_MAX_CLASS_DRIVER > 1 ULONG class_index; #endif /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_STACK_CLASS_REGISTER, class_name, class_entry_function, 0, 0, UX_TRACE_HOST_STACK_EVENTS, 0, 0) #if !defined(UX_NAME_REFERENCED_BY_POINTER) /* Get the length of the class name (exclude null-terminator). */ status = _ux_utility_string_length_check(class_name, &class_name_length, UX_MAX_CLASS_NAME_LENGTH); if (status) return(status); #endif /* Get first class. */ class_inst = _ux_system_host -> ux_system_host_class_array; #if UX_MAX_CLASS_DRIVER > 1 /* We need to parse the class table to find an empty spot. */ for (class_index = 0; class_index < _ux_system_host -> ux_system_host_max_class; class_index++) { #endif /* Check if this class is already used. */ if (class_inst -> ux_host_class_status == UX_UNUSED) { #if defined(UX_NAME_REFERENCED_BY_POINTER) class_inst -> ux_host_class_name = (const UCHAR *) class_name; #else /* We have found a free container for the class. Copy the name (with null-terminator). */ _ux_utility_memory_copy(class_inst -> ux_host_class_name, class_name, class_name_length + 1); /* Use case of memcpy is verified. */ #endif /* Memorize the entry function of this class. */ class_inst -> ux_host_class_entry_function = class_entry_function; /* Mark it as used. */ class_inst -> ux_host_class_status = UX_USED; /* Return successful completion. */ return(UX_SUCCESS); } /* Do a sanity check to make sure the class is not already installed by mistake. To verify this, we simple check for the class entry point. */ else { /* Check for an already installed class entry function. */ if(class_inst -> ux_host_class_entry_function == class_entry_function) { /* Error trap. */ _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_INIT, UX_HOST_CLASS_ALREADY_INSTALLED); /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_ALREADY_INSTALLED, class_name, 0, 0, UX_TRACE_ERRORS, 0, 0) /* Yes, return an error. */ return(UX_HOST_CLASS_ALREADY_INSTALLED); } } #if UX_MAX_CLASS_DRIVER > 1 /* Move to the next class. */ class_inst ++; } #endif /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_MEMORY_ARRAY_FULL, class_name, 0, 0, UX_TRACE_ERRORS, 0, 0) /* Error trap. */ _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_INIT, UX_MEMORY_ARRAY_FULL); /* No more entries in the class table. */ return(UX_MEMORY_ARRAY_FULL); } /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _uxe_host_stack_class_register PORTABLE C */ /* 6.3.0 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function checks errors in host stack class register function */ /* call. */ /* */ /* INPUT */ /* */ /* class_name Name of class */ /* class_entry_function Entry function of the class */ /* */ /* OUTPUT */ /* */ /* None */ /* */ /* CALLS */ /* */ /* _ux_host_stack_class_instance_get Host stack class instance get */ /* */ /* CALLED BY */ /* */ /* Application */ /* */ /**************************************************************************/ UINT _uxe_host_stack_class_register(UCHAR *class_name, UINT (*class_entry_function)(struct UX_HOST_CLASS_COMMAND_STRUCT *)) { /* Sanity checks. */ if ((class_name == UX_NULL) || (class_entry_function == UX_NULL)) return(UX_INVALID_PARAMETER); /* Invoke class register function. */ return(_ux_host_stack_class_register(class_name, class_entry_function)); }