/* * Copyright (c) 2015 - 2016, Freescale Semiconductor, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * * o Redistributions of source code must retain the above copyright notice, this list * of conditions and the following disclaimer. * * o Redistributions in binary form must reproduce the above copyright notice, this * list of conditions and the following disclaimer in the documentation and/or * other materials provided with the distribution. * * o Neither the name of Freescale Semiconductor, Inc. nor the names of its * contributors may be used to endorse or promote products derived from this * software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include "usb_device_config.h" #include "usb.h" #include "usb_device.h" #include "usb_device_dci.h" #include "fsl_device_registers.h" #if ((defined(USB_DEVICE_CONFIG_NUM)) && (USB_DEVICE_CONFIG_NUM > 0U)) #if ((defined(USB_DEVICE_CONFIG_KHCI)) && (USB_DEVICE_CONFIG_KHCI > 0U)) #include "usb_device_khci.h" #endif #if ((defined(USB_DEVICE_CONFIG_EHCI)) && (USB_DEVICE_CONFIG_EHCI > 0U)) #include "usb_device_ehci.h" #endif #include "usb_device_ch9.h" /******************************************************************************* * Definitions ******************************************************************************/ /******************************************************************************* * Prototypes ******************************************************************************/ static usb_status_t USB_DeviceAllocateHandle(uint8_t controllerId, usb_device_struct_t **handle); static usb_status_t USB_DeviceFreeHandle(usb_device_struct_t *handle); static usb_status_t USB_DeviceGetControllerInterface( uint8_t controllerId, const usb_device_controller_interface_struct_t **controllerInterface); static usb_status_t USB_DeviceTransfer(usb_device_handle handle, uint8_t endpointAddress, uint8_t *buffer, uint32_t length); static usb_status_t USB_DeviceControl(usb_device_handle handle, usb_device_control_type_t type, void *param); static usb_status_t USB_DeviceResetNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message); #if ((defined(USB_DEVICE_CONFIG_LOW_POWER_MODE) && (USB_DEVICE_CONFIG_LOW_POWER_MODE > 0U)) || \ (defined(USB_DEVICE_CONFIG_REMOTE_WAKEUP) && (USB_DEVICE_CONFIG_REMOTE_WAKEUP > 0U))) static usb_status_t USB_DeviceSuspendNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message); static usb_status_t USB_DeviceSuspendNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message); #endif #if (defined(USB_DEVICE_CONFIG_DETACH_ENABLE) && (USB_DEVICE_CONFIG_DETACH_ENABLE > 0U)) static usb_status_t USB_DeviceDetachNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message); static usb_status_t USB_DeviceAttachNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message); #endif static usb_status_t USB_DeviceNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message); /******************************************************************************* * Variables ******************************************************************************/ USB_GLOBAL static usb_device_struct_t s_UsbDevice[USB_DEVICE_CONFIG_NUM]; /******************************************************************************* * Code ******************************************************************************/ /*! * @brief Allocate a device handle. * * This function allocates a device handle. * * @param controllerId The controller id of the USB IP. Please refer to the enumeration usb_controller_index_t. * @param handle It is out parameter, is used to return pointer of the device handle to the caller. * * @retval kStatus_USB_Success Get a device handle successfully. * @retval kStatus_USB_Busy Cannot allocate a device handle. * @retval kStatus_USB_Error The device has been initialized. */ static usb_status_t USB_DeviceAllocateHandle(uint8_t controllerId, usb_device_struct_t **handle) { uint32_t count; USB_OSA_SR_ALLOC(); USB_OSA_ENTER_CRITICAL(); /* Check the controller is initialized or not. */ for (count = 0U; count < USB_DEVICE_CONFIG_NUM; count++) { if ((NULL != s_UsbDevice[count].controllerHandle) && (controllerId == s_UsbDevice[count].controllerId)) { USB_OSA_EXIT_CRITICAL(); return kStatus_USB_Error; } } /* Get a free device handle. */ for (count = 0U; count < USB_DEVICE_CONFIG_NUM; count++) { if (NULL == s_UsbDevice[count].controllerHandle) { s_UsbDevice[count].controllerId = controllerId; *handle = &s_UsbDevice[count]; USB_OSA_EXIT_CRITICAL(); return kStatus_USB_Success; } } USB_OSA_EXIT_CRITICAL(); return kStatus_USB_Busy; } /*! * @brief Free a device handle. * * This function frees a device handle. * * @param handle The device handle. * * @retval kStatus_USB_Success Free device handle successfully. */ static usb_status_t USB_DeviceFreeHandle(usb_device_struct_t *handle) { USB_OSA_SR_ALLOC(); USB_OSA_ENTER_CRITICAL(); handle->controllerHandle = NULL; handle->controllerId = 0U; USB_OSA_EXIT_CRITICAL(); return kStatus_USB_Success; } #if ((defined(USB_DEVICE_CONFIG_KHCI)) && (USB_DEVICE_CONFIG_KHCI > 0U)) /* KHCI device driver interface */ static const usb_device_controller_interface_struct_t s_UsbDeviceKhciInterface = { USB_DeviceKhciInit, USB_DeviceKhciDeinit, USB_DeviceKhciSend, USB_DeviceKhciRecv, USB_DeviceKhciCancel, USB_DeviceKhciControl}; #endif #if ((defined(USB_DEVICE_CONFIG_EHCI)) && (USB_DEVICE_CONFIG_EHCI > 0U)) /* EHCI device driver interface */ static const usb_device_controller_interface_struct_t s_UsbDeviceEhciInterface = { USB_DeviceEhciInit, USB_DeviceEhciDeinit, USB_DeviceEhciSend, USB_DeviceEhciRecv, USB_DeviceEhciCancel, USB_DeviceEhciControl}; #endif /*! * @brief Get the controller interface handle. * * This function is used to get the controller interface handle. * * @param controllerId The controller id of the USB IP. Please refer to the enumeration usb_controller_index_t. * @param controllerInterface It is out parameter, is used to return pointer of the device controller handle to the * caller. * * @retval kStatus_USB_Success Get a device handle successfully. * @retval kStatus_USB_ControllerNotFound The controller id is invalided. */ static usb_status_t USB_DeviceGetControllerInterface( uint8_t controllerId, const usb_device_controller_interface_struct_t **controllerInterface) { usb_status_t error = kStatus_USB_ControllerNotFound; switch (controllerId) { #if ((defined(USB_DEVICE_CONFIG_KHCI)) && (USB_DEVICE_CONFIG_KHCI > 0U)) /* Get the KHCI controller driver interface */ case kUSB_ControllerKhci0: case kUSB_ControllerKhci1: *controllerInterface = (const usb_device_controller_interface_struct_t *)&s_UsbDeviceKhciInterface; error = kStatus_USB_Success; break; #endif #if ((defined(USB_DEVICE_CONFIG_EHCI)) && (USB_DEVICE_CONFIG_EHCI > 0U)) /* Get the EHCI controller driver interface */ case kUSB_ControllerEhci0: case kUSB_ControllerEhci1: error = kStatus_USB_Success; *controllerInterface = (const usb_device_controller_interface_struct_t *)&s_UsbDeviceEhciInterface; break; #endif default: break; } return error; } /*! * @brief Start a new transfer. * * This function is used to start a new transfer. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param endpointAddress Endpoint address. Bit7 is direction, 0U - USB_OUT, 1U - USB_IN. * @param buffer The memory address to be transferred, or the memory address to hold the data need to be * sent. * @param length The length of the data. * * @retval kStatus_USB_Success Get a device handle successfully. * @retval kStatus_USB_InvalidHandle The device handle is invalided. * @retval kStatus_USB_ControllerNotFound The controller interface is not found. * @retval kStatus_USB_Error The device is doing reset. */ static usb_status_t USB_DeviceTransfer(usb_device_handle handle, uint8_t endpointAddress, uint8_t *buffer, uint32_t length) { usb_device_struct_t *deviceHandle = (usb_device_struct_t *)handle; usb_status_t error = kStatus_USB_Error; if (NULL == deviceHandle) { return kStatus_USB_InvalidHandle; } if (NULL != deviceHandle->controllerInterface) { if (endpointAddress & USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_MASK) { #if (defined(USB_DEVICE_CONFIG_BUFFER_PROPERTY_CACHEABLE) && (USB_DEVICE_CONFIG_BUFFER_PROPERTY_CACHEABLE > 0U)) if (length) { USB_CacheFlushLines((void *)buffer, length); } #endif /* Call the controller send interface. */ error = deviceHandle->controllerInterface->deviceSend(deviceHandle->controllerHandle, endpointAddress, buffer, length); } else { #if (defined(USB_DEVICE_CONFIG_BUFFER_PROPERTY_CACHEABLE) && (USB_DEVICE_CONFIG_BUFFER_PROPERTY_CACHEABLE > 0U)) if (length) { USB_CacheInvalidateLines((void *)buffer, length); } #endif /* Call the controller receive interface. */ error = deviceHandle->controllerInterface->deviceRecv(deviceHandle->controllerHandle, endpointAddress, buffer, length); } } else { error = kStatus_USB_ControllerNotFound; } return error; } /*! * @brief Control the status of the selected item. * * This function is used to control the status of the selected item.. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param type The control type, please refer to the enumeration usb_device_control_type_t. * @param param The param type is determined by the selected item. * * @retval kStatus_USB_Success Get a device handle successfully. * @retval kStatus_USB_InvalidHandle The device handle is invalided. * @retval kStatus_USB_ControllerNotFound The controller interface is not found. * @retval kStatus_USB_Error Unsupport type. * Or, the param is NULL pointer. */ static usb_status_t USB_DeviceControl(usb_device_handle handle, usb_device_control_type_t type, void *param) { usb_device_struct_t *deviceHandle = (usb_device_struct_t *)handle; usb_status_t error = kStatus_USB_Error; if (NULL == deviceHandle) { return kStatus_USB_InvalidHandle; } if (NULL != deviceHandle->controllerInterface) { /* Call the controller control interface. */ error = deviceHandle->controllerInterface->deviceControl(deviceHandle->controllerHandle, type, param); } else { error = kStatus_USB_ControllerNotFound; } return error; } /*! * @brief Handle the reset notification. * * This function is used to handle the reset notification. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param message The device callback message handle. * * @retval kStatus_USB_Success Get a device handle successfully. */ static usb_status_t USB_DeviceResetNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message) { handle->isResetting = 1U; /* Set the controller to default status. */ USB_DeviceControl(handle, kUSB_DeviceControlSetDefaultStatus, NULL); handle->state = kUSB_DeviceStateDefault; handle->deviceAddress = 0U; for (uint32_t count = 0U; count < (USB_DEVICE_CONFIG_ENDPOINTS * 2U); count++) { handle->endpointCallback[count].callbackFn = (usb_device_endpoint_callback_t)NULL; handle->endpointCallback[count].callbackParam = NULL; } /* Call device callback to notify the application that the USB bus reset signal detected. */ handle->deviceCallback(handle, kUSB_DeviceEventBusReset, NULL); handle->isResetting = 0U; return kStatus_USB_Success; } #if ((defined(USB_DEVICE_CONFIG_LOW_POWER_MODE) && (USB_DEVICE_CONFIG_LOW_POWER_MODE > 0U)) || \ (defined(USB_DEVICE_CONFIG_REMOTE_WAKEUP) && (USB_DEVICE_CONFIG_REMOTE_WAKEUP > 0U))) /*! * @brief Handle the suspend notification. * * This function is used to handle the suspend notification. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param message The device callback message handle. * * @return A USB error code or kStatus_USB_Success. */ static usb_status_t USB_DeviceSuspendNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message) { /* Call device callback to notify the application that the USB bus suspend signal detected. */ return handle->deviceCallback(handle, kUSB_DeviceEventSuspend, NULL); } /*! * @brief Handle the resume notification. * * This function is used to handle the resume notification. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param message The device callback message handle. * * @return A USB error code or kStatus_USB_Success. */ static usb_status_t USB_DeviceResumeNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message) { /* Call device callback to notify the application that the USB bus resume signal detected. */ return handle->deviceCallback(handle, kUSB_DeviceEventResume, NULL); } #endif #if (defined(USB_DEVICE_CONFIG_KHCI_ERROR_HANDLING) && USB_DEVICE_CONFIG_KHCI_ERROR_HANDLING) || \ (defined(USB_DEVICE_CONFIG_EHCI_ERROR_HANDLING) && USB_DEVICE_CONFIG_EHCI_ERROR_HANDLING) usb_status_t USB_DeviceErrorNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message) { /* Call device callback to notify the application that the USB bus error signal detected. */ return handle->deviceCallback(handle, kUSB_DeviceEventError, NULL); } #endif #if (defined(USB_DEVICE_CONFIG_DETACH_ENABLE) && (USB_DEVICE_CONFIG_DETACH_ENABLE > 0U)) /*! * @brief Handle the detach notification. * * This function is used to handle the detach notification. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param message The device callback message handle. * * @return A USB error code or kStatus_USB_Success. */ static usb_status_t USB_DeviceDetachNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message) { /* Call device callback to notify the application that the device is disconnected from a host. */ return handle->deviceCallback(handle, kUSB_DeviceEventDetach, NULL); } /*! * @brief Handle the attach notification. * * This function is used to handle the attach notification. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param message The device callback message handle. * * @return A USB error code or kStatus_USB_Success. */ static usb_status_t USB_DeviceAttachNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message) { /* Call device callback to notify the application that the device is connected to a host. */ return handle->deviceCallback(handle, kUSB_DeviceEventAttach, NULL); } #endif /*! * @brief Handle the attach notification. * * This function is used to handle the attach notification. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param message The device callback message handle. * * @return A USB error code or kStatus_USB_Success. */ static usb_status_t USB_DeviceNotification(usb_device_struct_t *handle, usb_device_callback_message_struct_t *message) { uint8_t endpoint = message->code & USB_ENDPOINT_NUMBER_MASK; uint8_t direction = (message->code & USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_MASK) >> USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_SHIFT; usb_status_t error = kStatus_USB_Error; switch (message->code) { case kUSB_DeviceNotifyBusReset: error = USB_DeviceResetNotification(handle, message); break; #if ((USB_DEVICE_CONFIG_LOW_POWER_MODE) || (USB_DEVICE_CONFIG_REMOTE_WAKEUP)) case kUSB_DeviceNotifySuspend: error = USB_DeviceSuspendNotification(handle, message); break; case kUSB_DeviceNotifyResume: error = USB_DeviceResumeNotification(handle, message); break; #endif #if (defined(USB_DEVICE_CONFIG_KHCI_ERROR_HANDLING) && USB_DEVICE_CONFIG_KHCI_ERROR_HANDLING) || \ (defined(USB_DEVICE_CONFIG_EHCI_ERROR_HANDLING) && USB_DEVICE_CONFIG_EHCI_ERROR_HANDLING) case kUSB_DeviceNotifyError: error = USB_DeviceErrorNotification(handle, message); break; #endif #if USB_DEVICE_CONFIG_DETACH_ENABLE case kUSB_DeviceNotifyDetach: error = USB_DeviceDetachNotification(handle, message); break; case kUSB_DeviceNotifyAttach: error = USB_DeviceAttachNotification(handle, message); break; #endif default: if (endpoint < USB_DEVICE_CONFIG_ENDPOINTS) { if (handle->endpointCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackFn) { usb_device_endpoint_callback_message_struct_t endpointCallbackMessage; endpointCallbackMessage.buffer = message->buffer; endpointCallbackMessage.length = message->length; endpointCallbackMessage.isSetup = message->isSetup; /* Call endpoint callback */ error = handle->endpointCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackFn( handle, &endpointCallbackMessage, handle->endpointCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackParam); } } break; } return error; } /*! * @brief Notify the device that the controller status changed. * * This function is used to notify the device that the controller status changed. * * @param handle The device handle. It equals the value returned from USB_DeviceInit. * @param message The device callback message handle. * * @return A USB error code or kStatus_USB_Success. */ usb_status_t USB_DeviceNotificationTrigger(void *handle, void *msg) { usb_device_struct_t *deviceHandle = (usb_device_struct_t *)handle; usb_device_callback_message_struct_t *message = (usb_device_callback_message_struct_t *)msg; if ((NULL == msg) || (NULL == handle)) { return kStatus_USB_InvalidHandle; } /* The device callback is invalid or not. */ if (!deviceHandle->deviceCallback) { return kStatus_USB_Error; } #if USB_DEVICE_CONFIG_USE_TASK if (deviceHandle->isResetting) { if ((message->code & USB_ENDPOINT_NUMBER_MASK) && (!(message->code & 0x70U))) { return USB_DeviceNotification(deviceHandle, message); } } /* Add the message to message queue when the device task is enabled. */ if (kStatus_USB_OSA_Success != USB_OsaMsgqSend(deviceHandle->notificationQueue, (void *)message)) { return kStatus_USB_Busy; } return kStatus_USB_Success; #else /* Handle the notification by calling USB_DeviceNotification. */ return USB_DeviceNotification(deviceHandle, message); #endif } /*! * @brief Initialize the USB device stack. * * This function initializes the USB device module specified by the controllerId. * * @param controllerId The controller id of the USB IP. Please refer to the enumeration usb_controller_index_t. * @param deviceCallback Function pointer of the device callback. * @param handle It is out parameter, is used to return pointer of the device handle to the caller. * * @retval kStatus_USB_Success The device is initialized successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. * @retval kStatus_USB_Busy Cannot allocate a device handle. * @retval kStatus_USB_ControllerNotFound Cannot find the controller according to the controller id. * @retval kStatus_USB_InvalidControllerInterface The controller driver interfaces is invaild, There is an empty * interface entity. * @retval kStatus_USB_Error The macro USB_DEVICE_CONFIG_ENDPOINTS is more than IP's endpoint number. * Or, the device has been initialized. * Or, the message queue is created failed. */ usb_status_t USB_DeviceInit(uint8_t controllerId, usb_device_callback_t deviceCallback, usb_device_handle *handle) { usb_device_struct_t *deviceHandle = NULL; usb_status_t error; uint32_t count; if (NULL == handle) { return kStatus_USB_InvalidHandle; } /* Allocate a device handle by using the controller id. */ error = USB_DeviceAllocateHandle(controllerId, &deviceHandle); if (kStatus_USB_Success != error) { return error; } /* Save the device callback */ deviceHandle->deviceCallback = deviceCallback; /* Save the controller id */ deviceHandle->controllerId = controllerId; /* Clear the device address */ deviceHandle->deviceAddress = 0U; /* Clear the device reset state */ deviceHandle->isResetting = 0U; /* Initialize the enpoints */ for (count = 0U; count < (USB_DEVICE_CONFIG_ENDPOINTS * 2U); count++) { deviceHandle->endpointCallback[count].callbackFn = (usb_device_endpoint_callback_t)NULL; deviceHandle->endpointCallback[count].callbackParam = NULL; } /* Get the controller interface according to the controller id */ error = USB_DeviceGetControllerInterface(controllerId, &deviceHandle->controllerInterface); if (kStatus_USB_Success != error) { USB_DeviceFreeHandle(deviceHandle); return error; } if (NULL == deviceHandle->controllerInterface) { USB_DeviceFreeHandle(deviceHandle); return kStatus_USB_ControllerNotFound; } if (((usb_device_controller_init_t)NULL == deviceHandle->controllerInterface->deviceInit) || ((usb_device_controller_deinit_t)NULL == deviceHandle->controllerInterface->deviceDeinit) || ((usb_device_controller_send_t)NULL == deviceHandle->controllerInterface->deviceSend) || ((usb_device_controller_recv_t)NULL == deviceHandle->controllerInterface->deviceRecv) || ((usb_device_controller_cancel_t)NULL == deviceHandle->controllerInterface->deviceCancel) || ((usb_device_controller_control_t)NULL == deviceHandle->controllerInterface->deviceControl)) { USB_DeviceFreeHandle(deviceHandle); return kStatus_USB_InvalidControllerInterface; } #if USB_DEVICE_CONFIG_USE_TASK /* Create a message queue when the device handle is enabled. */ if (kStatus_USB_OSA_Success != USB_OsaMsgqCreate(&deviceHandle->notificationQueue, USB_DEVICE_CONFIG_MAX_MESSAGES, (1U + (sizeof(usb_device_callback_message_struct_t) - 1U) / sizeof(uint32_t)))) { USB_DeviceDeinit(deviceHandle); return kStatus_USB_Error; } #endif /* Initialize the controller */ error = deviceHandle->controllerInterface->deviceInit(controllerId, deviceHandle, &deviceHandle->controllerHandle); if (kStatus_USB_Success != error) { USB_DeviceDeinit(deviceHandle); return error; } /* Set the device to deafult state */ deviceHandle->state = kUSB_DeviceStateDefault; *handle = deviceHandle; return error; } /*! * @brief Enable the device functionality. * * The function enables the device functionality, so that the device can be recognized by the host when the device * detects that it has been connected to a host. * * @param handle The device handle got from USB_DeviceInit. * * @retval kStatus_USB_Success The device is run successfully. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. * @retval kStatus_USB_InvalidHandle The device handle is a NULL pointer. Or the controller handle is invalid. * */ usb_status_t USB_DeviceRun(usb_device_handle handle) { return USB_DeviceControl(handle, kUSB_DeviceControlRun, NULL); } /*! * @brief Disable the device functionality. * * The function disables the device functionality, after this function called, even the device is detached to the host, * and the device can't work. * * @param handle The device handle got from USB_DeviceInit. * * @retval kStatus_USB_Success The device is stopped successfully. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. * @retval kStatus_USB_InvalidHandle The device handle is a NULL pointer. Or the controller handle is invalid. */ usb_status_t USB_DeviceStop(usb_device_handle handle) { return USB_DeviceControl(handle, kUSB_DeviceControlStop, NULL); } /*! * @brief De-initialize the device controller. * * The function de-initializes the device controller specified by the handle. * * @param handle The device handle got from USB_DeviceInit. * * @retval kStatus_USB_Success The device is stopped successfully. * @retval kStatus_USB_InvalidHandle The device handle is a NULL pointer. Or the controller handle is invalid. */ usb_status_t USB_DeviceDeinit(usb_device_handle handle) { usb_device_struct_t *deviceHandle = (usb_device_struct_t *)handle; if (NULL == deviceHandle) { return kStatus_USB_InvalidHandle; } /* De-initialize the controller */ if (NULL != deviceHandle->controllerInterface) { deviceHandle->controllerInterface->deviceDeinit(deviceHandle->controllerHandle); deviceHandle->controllerInterface = (usb_device_controller_interface_struct_t *)NULL; } #if USB_DEVICE_CONFIG_USE_TASK /* Destroy the message queue. */ if (NULL != deviceHandle->notificationQueue) { USB_OsaMsgqDestroy(deviceHandle->notificationQueue); deviceHandle->notificationQueue = NULL; } #endif /* Free the device handle. */ USB_DeviceFreeHandle(deviceHandle); return kStatus_USB_Success; } /*! * @brief Send data through a specified endpoint. * * The function is used to send data through a specified endpoint. * * @param handle The device handle got from USB_DeviceInit. * @param endpointAddress Endpoint index. * @param buffer The memory address to hold the data need to be sent. * @param length The data length need to be sent. * * @retval kStatus_USB_Success The send request is sent successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_Busy Cannot allocate dtds for current tansfer in EHCI driver. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. * @retval kStatus_USB_Error The device is doing reset. * * @note The return value just means if the sending request is successful or not; the transfer done is notified by the * corresponding callback function. * Currently, only one transfer request can be supported for one specific endpoint. * If there is a specific requirement to support multiple transfer requests for one specific endpoint, the application * should implement a queue in the application level. * The subsequent transfer could begin only when the previous transfer is done (get notification through the endpoint * callback). */ usb_status_t USB_DeviceSendRequest(usb_device_handle handle, uint8_t endpointAddress, uint8_t *buffer, uint32_t length) { return USB_DeviceTransfer(handle, (endpointAddress & USB_ENDPOINT_NUMBER_MASK) | (USB_IN << USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_SHIFT), buffer, length); } /*! * @brief Receive data through a specified endpoint. * * The function is used to receive data through a specified endpoint. * * @param handle The device handle got from USB_DeviceInit. * @param endpointAddress Endpoint index. * @param buffer The memory address to save the received data. * @param length The data length want to be received. * * @retval kStatus_USB_Success The receive request is sent successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_Busy Cannot allocate dtds for current tansfer in EHCI driver. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. * @retval kStatus_USB_Error The device is doing reset. * * @note The return value just means if the receiving request is successful or not; the transfer done is notified by the * corresponding callback function. * Currently, only one transfer request can be supported for one specific endpoint. * If there is a specific requirement to support multiple transfer requests for one specific endpoint, the application * should implement a queue in the application level. * The subsequent transfer could begin only when the previous transfer is done (get notification through the endpoint * callback). */ usb_status_t USB_DeviceRecvRequest(usb_device_handle handle, uint8_t endpointAddress, uint8_t *buffer, uint32_t length) { return USB_DeviceTransfer(handle, (endpointAddress & USB_ENDPOINT_NUMBER_MASK) | (USB_OUT << USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_SHIFT), buffer, length); } /*! * @brief Cancel the pending transfer in a specified endpoint. * * The function is used to cancel the pending transfer in a specified endpoint. * * @param handle The device handle got from USB_DeviceInit. * @param endpointAddress Endpoint address, bit7 is the direction of endpoint, 1U - IN, abd 0U - OUT. * * @retval kStatus_USB_Success The transfer is cancelled. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. */ usb_status_t USB_DeviceCancel(usb_device_handle handle, uint8_t endpointAddress) { usb_device_struct_t *deviceHandle = (usb_device_struct_t *)handle; usb_status_t error = kStatus_USB_Error; if (NULL == deviceHandle) { return kStatus_USB_InvalidHandle; } if (NULL != deviceHandle->controllerInterface) { error = deviceHandle->controllerInterface->deviceCancel(deviceHandle->controllerHandle, endpointAddress); } else { error = kStatus_USB_ControllerNotFound; } return error; } /*! * @brief Initialize a specified endpoint. * * The function is used to initialize a specified endpoint and the corresponding endpoint callback is also initialized. * * @param handle The device handle got from USB_DeviceInit. * @param epInit Endpoint initizlization structure. Please refer to the structure usb_device_endpoint_init_struct_t. * @param endpointCallback Endpoint callback structure. Please refer to the structure * usb_device_endpoint_callback_struct_t. * * @retval kStatus_USB_Success The endpoint is initialized successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_InvalidParameter The epInit or endpointCallback is NULL pointer. Or the endpoint number is * more than USB_DEVICE_CONFIG_ENDPOINTS. * @retval kStatus_USB_Busy The endpoint is busy in EHCI driver. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. */ usb_status_t USB_DeviceInitEndpoint(usb_device_handle handle, usb_device_endpoint_init_struct_t *epInit, usb_device_endpoint_callback_struct_t *endpointCallback) { usb_device_struct_t *deviceHandle = (usb_device_struct_t *)handle; uint8_t endpoint; uint8_t direction; if (!deviceHandle) { return kStatus_USB_InvalidHandle; } if ((!epInit) || (!endpointCallback)) { return kStatus_USB_InvalidParameter; } endpoint = epInit->endpointAddress & USB_ENDPOINT_NUMBER_MASK; direction = (epInit->endpointAddress & USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_MASK) >> USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_SHIFT; if (endpoint < USB_DEVICE_CONFIG_ENDPOINTS) { deviceHandle->endpointCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackFn = endpointCallback->callbackFn; deviceHandle->endpointCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackParam = endpointCallback->callbackParam; } else { return kStatus_USB_InvalidParameter; } return USB_DeviceControl(handle, kUSB_DeviceControlEndpointInit, epInit); } /*! * @brief De-initizlize a specified endpoint. * * The function is used to de-initizlize a specified endpoint. * * @param handle The device handle got from USB_DeviceInit. * @param endpointAddress Endpoint address, bit7 is the direction of endpoint, 1U - IN, abd 0U - OUT. * * @retval kStatus_USB_Success The endpoint is de-initialized successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_InvalidParameter The endpoint number is more than USB_DEVICE_CONFIG_ENDPOINTS. * @retval kStatus_USB_Busy The endpoint is busy in EHCI driver. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. */ usb_status_t USB_DeviceDeinitEndpoint(usb_device_handle handle, uint8_t endpointAddress) { usb_device_struct_t *deviceHandle = (usb_device_struct_t *)handle; uint8_t endpoint = endpointAddress & USB_ENDPOINT_NUMBER_MASK; uint8_t direction = (endpointAddress & USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_MASK) >> USB_DESCRIPTOR_ENDPOINT_ADDRESS_DIRECTION_SHIFT; usb_status_t error = kStatus_USB_Error; if (!deviceHandle) { return kStatus_USB_InvalidHandle; } error = USB_DeviceControl(handle, kUSB_DeviceControlEndpointDeinit, &endpointAddress); if (endpoint < USB_DEVICE_CONFIG_ENDPOINTS) { deviceHandle->endpointCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackFn = (usb_device_endpoint_callback_t)NULL; deviceHandle->endpointCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackParam = NULL; } else { return kStatus_USB_InvalidParameter; } return error; } /*! * @brief Stall a specified endpoint. * * The function is used to stall a specified endpoint. * * @param handle The device handle got from USB_DeviceInit. * @param endpointAddress Endpoint address, bit7 is the direction of endpoint, 1U - IN, abd 0U - OUT. * * @retval kStatus_USB_Success The endpoint is stalled successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_InvalidParameter The endpoint number is more than USB_DEVICE_CONFIG_ENDPOINTS. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. */ usb_status_t USB_DeviceStallEndpoint(usb_device_handle handle, uint8_t endpointAddress) { if ((endpointAddress & USB_ENDPOINT_NUMBER_MASK) < USB_DEVICE_CONFIG_ENDPOINTS) { return USB_DeviceControl(handle, kUSB_DeviceControlEndpointStall, &endpointAddress); } else { return kStatus_USB_InvalidParameter; } } /*! * @brief Un-stall a specified endpoint. * * The function is used to un-stall a specified endpoint. * * @param handle The device handle got from USB_DeviceInit. * @param endpointAddress Endpoint address, bit7 is the direction of endpoint, 1U - IN, abd 0U - OUT. * * @retval kStatus_USB_Success The endpoint is un-stalled successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_InvalidParameter The endpoint number is more than USB_DEVICE_CONFIG_ENDPOINTS. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. */ usb_status_t USB_DeviceUnstallEndpoint(usb_device_handle handle, uint8_t endpointAddress) { if ((endpointAddress & USB_ENDPOINT_NUMBER_MASK) < USB_DEVICE_CONFIG_ENDPOINTS) { return USB_DeviceControl(handle, kUSB_DeviceControlEndpointUnstall, &endpointAddress); } else { return kStatus_USB_InvalidParameter; } } /*! * @brief Get the status of the selected item. * * The function is used to get the status of the selected item. * * @param handle The device handle got from USB_DeviceInit. * @param type The selected item. Please refer to the structure usb_device_status_t. * @param param The param type is determined by the selected item. * * @retval kStatus_USB_Success Get status successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_InvalidParameter The param is NULL pointer. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. * @retval kStatus_USB_Error Unsupported type. */ usb_status_t USB_DeviceGetStatus(usb_device_handle handle, usb_device_status_t type, void *param) { uint8_t *temp8; usb_status_t error = kStatus_USB_Error; if (NULL == param) { return kStatus_USB_InvalidParameter; } switch (type) { case kUSB_DeviceStatusSpeed: error = USB_DeviceControl(handle, kUSB_DeviceControlGetSpeed, param); break; case kUSB_DeviceStatusOtg: error = USB_DeviceControl(handle, kUSB_DeviceControlGetOtgStatus, param); break; case kUSB_DeviceStatusDeviceState: temp8 = (uint8_t *)param; error = kStatus_USB_Success; *temp8 = ((usb_device_struct_t *)handle)->state; break; case kUSB_DeviceStatusAddress: temp8 = (uint8_t *)param; error = kStatus_USB_Success; *temp8 = ((usb_device_struct_t *)handle)->deviceAddress; break; case kUSB_DeviceStatusDevice: error = USB_DeviceControl(handle, kUSB_DeviceControlGetDeviceStatus, param); break; case kUSB_DeviceStatusEndpoint: error = USB_DeviceControl(handle, kUSB_DeviceControlGetEndpointStatus, param); break; case kUSB_DeviceStatusSynchFrame: error = USB_DeviceControl(handle, kUSB_DeviceControlGetSynchFrame, param); break; default: break; } return error; } /*! * @brief Set the status of the selected item. * * The function is used to set the status of the selected item. * * @param handle The device handle got from USB_DeviceInit. * @param type The selected item. Please refer to the structure usb_device_status_t. * @param param The param type is determined by the selected item. * * @retval kStatus_USB_Success Set status successfully. * @retval kStatus_USB_InvalidHandle The handle is a NULL pointer. Or the controller handle is invalid. * @retval kStatus_USB_ControllerNotFound Cannot find the controller. * @retval kStatus_USB_Error Unsupported type, or the param is NULL pointer. */ usb_status_t USB_DeviceSetStatus(usb_device_handle handle, usb_device_status_t type, void *param) { usb_status_t error = kStatus_USB_Error; switch (type) { #if (defined(USB_DEVICE_CONFIG_EHCI) && (USB_DEVICE_CONFIG_EHCI > 0U)) && \ (defined(USB_DEVICE_CONFIG_EHCI_TEST_MODE) && (USB_DEVICE_CONFIG_EHCI_TEST_MODE > 0U)) case kUSB_DeviceStatusTestMode: error = USB_DeviceControl(handle, kUSB_DeviceControlSetTestMode, param); break; #endif case kUSB_DeviceStatusOtg: error = USB_DeviceControl(handle, kUSB_DeviceControlSetOtgStatus, param); break; case kUSB_DeviceStatusDeviceState: if (NULL != param) { error = kStatus_USB_Success; ((usb_device_struct_t *)handle)->state = (uint8_t)(*(uint8_t *)param); } break; case kUSB_DeviceStatusAddress: if (kUSB_DeviceStateAddressing != ((usb_device_struct_t *)handle)->state) { if (NULL != param) { error = kStatus_USB_Success; ((usb_device_struct_t *)handle)->deviceAddress = (uint8_t)(*(uint8_t *)param); ((usb_device_struct_t *)handle)->state = kUSB_DeviceStateAddressing; } } else { error = USB_DeviceControl(handle, kUSB_DeviceControlSetDeviceAddress, &((usb_device_struct_t *)handle)->deviceAddress); } break; case kUSB_DeviceStatusBus: error = USB_DeviceControl(handle, kUSB_DeviceControlResume, param); break; default: break; } return error; } #if USB_DEVICE_CONFIG_USE_TASK /*! * @brief Device task function. * * The function is used to handle controller message. * This function should not be called in applicartion directly. * * @param handle The device handle got from USB_DeviceInit. */ void USB_DeviceTaskFunction(void *deviceHandle) { usb_device_struct_t *handle = (usb_device_struct_t *)deviceHandle; static usb_device_callback_message_struct_t message; if (deviceHandle) { /* Get the message from the queue */ if (kStatus_USB_OSA_Success == USB_OsaMsgqRecv(handle->notificationQueue, (uint32_t *)&message, 0U)) { /* Handle the message */ USB_DeviceNotification(handle, &message); } } } #endif /*! * @brief Get dvice stack version function. * * The function is used to get dvice stack version. * * @param[out] version The version structure pointer to keep the device stack version. * */ void USB_DeviceGetVersion(uint32_t *version) { if (version) { *version = (uint32_t)USB_MAKE_VERSION(USB_STACK_VERSION_MAJOR, USB_STACK_VERSION_MINOR, USB_STACK_VERSION_BUGFIX); } } #endif /* USB_DEVICE_CONFIG_NUM */