1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462 |
- /*
- * Copyright (c) 2015 - 2016, Freescale Semiconductor, Inc.
- * Copyright 2016 - 2017 NXP
- *
- * 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 the copyright holder 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/include/usb_device_config.h>
- #include <usb/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
- #if (((defined(USB_DEVICE_CONFIG_LPCIP3511FS)) && (USB_DEVICE_CONFIG_LPCIP3511FS > 0U)) || \
- ((defined(USB_DEVICE_CONFIG_LPCIP3511HS)) && (USB_DEVICE_CONFIG_LPCIP3511HS > 0U)))
- #include "usb_device_lpcip3511.h"
- #endif
- #if (defined(USB_DEVICE_CONFIG_BUFFER_PROPERTY_CACHEABLE) && (USB_DEVICE_CONFIG_BUFFER_PROPERTY_CACHEABLE > 0U))
- #include "fsl_cache.h"
- #endif
- /*******************************************************************************
- * 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))
- static usb_status_t USB_DeviceSuspendNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message);
- static usb_status_t USB_DeviceResumeNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message);
- #if (defined(USB_DEVICE_CONFIG_LPM_L1) && (USB_DEVICE_CONFIG_LPM_L1 > 0U))
- static usb_status_t USB_DeviceSleepNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message);
- #endif
- #endif /* USB_DEVICE_CONFIG_LOW_POWER_MODE */
- #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
- #if (((defined(USB_DEVICE_CONFIG_LPCIP3511FS)) && (USB_DEVICE_CONFIG_LPCIP3511FS > 0U)) || \
- ((defined(USB_DEVICE_CONFIG_LPCIP3511HS)) && (USB_DEVICE_CONFIG_LPCIP3511HS > 0U)))
- /* EHCI device driver interface */
- static const usb_device_controller_interface_struct_t s_UsbDeviceLpc3511IpInterface = {
- USB_DeviceLpc3511IpInit, USB_DeviceLpc3511IpDeinit, USB_DeviceLpc3511IpSend,
- USB_DeviceLpc3511IpRecv, USB_DeviceLpc3511IpCancel, USB_DeviceLpc3511IpControl
- };
- #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
- #if (((defined(USB_DEVICE_CONFIG_LPCIP3511FS)) && (USB_DEVICE_CONFIG_LPCIP3511FS > 0U)) || \
- ((defined(USB_DEVICE_CONFIG_LPCIP3511HS)) && (USB_DEVICE_CONFIG_LPCIP3511HS > 0U)))
- /* Get the EHCI controller driver interface */
- case kUSB_ControllerLpcIp3511Fs0:
- case kUSB_ControllerLpcIp3511Fs1:
- case kUSB_ControllerLpcIp3511Hs0:
- case kUSB_ControllerLpcIp3511Hs1:
- error = kStatus_USB_Success;
- *controllerInterface = (const usb_device_controller_interface_struct_t *)&s_UsbDeviceLpc3511IpInterface;
- 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;
- 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_OSA_SR_ALLOC();
- if (NULL == deviceHandle)
- {
- return kStatus_USB_InvalidHandle;
- }
- if (NULL != deviceHandle->controllerInterface)
- {
- if (deviceHandle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].isBusy)
- {
- return kStatus_USB_Busy;
- }
- USB_OSA_ENTER_CRITICAL();
- deviceHandle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].isBusy = 1U;
- USB_OSA_EXIT_CRITICAL();
- 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)
- {
- DCACHE_CleanByRange((uint32_t)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)
- {
- DCACHE_CleanInvalidateByRange((uint32_t)buffer, length);
- }
- #endif
- /* Call the controller receive interface. */
- error = deviceHandle->controllerInterface->deviceRecv(deviceHandle->controllerHandle, endpointAddress,
- buffer, length);
- }
- if (kStatus_USB_Success != error)
- {
- USB_OSA_ENTER_CRITICAL();
- deviceHandle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].isBusy = 0U;
- USB_OSA_EXIT_CRITICAL();
- }
- }
- 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)
- {
- #if (defined(USB_DEVICE_CONFIG_USE_TASK) && (USB_DEVICE_CONFIG_USE_TASK > 0U))
- USB_OSA_SR_ALLOC();
- #endif
- handle->isResetting = 1U;
- #if ((defined(USB_DEVICE_CONFIG_REMOTE_WAKEUP)) && (USB_DEVICE_CONFIG_REMOTE_WAKEUP > 0U))
- /* Clear remote wakeup feature */
- handle->remotewakeup = 0U;
- #endif
- #if (defined(USB_DEVICE_CONFIG_USE_TASK) && (USB_DEVICE_CONFIG_USE_TASK > 0U))
- USB_OSA_ENTER_CRITICAL();
- handle->epCallbackDirectly = 1;
- USB_OSA_EXIT_CRITICAL();
- #endif
- /* Set the controller to default status. */
- USB_DeviceControl(handle, kUSB_DeviceControlSetDefaultStatus, NULL);
- #if (defined(USB_DEVICE_CONFIG_USE_TASK) && (USB_DEVICE_CONFIG_USE_TASK > 0U))
- USB_OSA_ENTER_CRITICAL();
- handle->epCallbackDirectly = 0;
- USB_OSA_EXIT_CRITICAL();
- #endif
- handle->state = kUSB_DeviceStateDefault;
- handle->deviceAddress = 0U;
- for (uint32_t count = 0U; count < (USB_DEVICE_CONFIG_ENDPOINTS * 2U); count++)
- {
- handle->epCallback[count].callbackFn = (usb_device_endpoint_callback_t)NULL;
- handle->epCallback[count].callbackParam = NULL;
- handle->epCallback[count].isBusy = 0U;
- }
- /* 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))
- /*!
- * @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);
- }
- #if (defined(USB_DEVICE_CONFIG_LPM_L1) && (USB_DEVICE_CONFIG_LPM_L1 > 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_DeviceSleepNotification(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_DeviceEventSleeped, NULL);
- }
- #endif
- /*!
- * @brief Handle the remotewakeup notification.
- *
- * This function is used to handle the remotewakeup notification.
- *
- * @param handle The device handle. It equals the value returned from USB_DeviceInit.
- * @param flag The buffer pointer to store remotewakeup flag.
- *
- * @return A USB error code or kStatus_USB_Success.
- */
- usb_status_t USB_DeviceGetRemoteWakeUp(usb_device_struct_t *handle, uint8_t **flag)
- {
- /* Call device callback to notify the application that the USB bus suspend signal detected. */
- return USB_DeviceControl(handle, kUSB_DeviceControlGetRemoteWakeUp, flag);
- }
- #endif /* USB_DEVICE_CONFIG_LOW_POWER_MODE */
- #if (defined(USB_DEVICE_CONFIG_ERROR_HANDLING) && (USB_DEVICE_CONFIG_ERROR_HANDLING > 0U))
- 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 /* USB_DEVICE_CONFIG_ERROR_HANDLING */
- #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
- #if (defined(USB_DEVICE_CHARGER_DETECT_ENABLE) && (USB_DEVICE_CHARGER_DETECT_ENABLE > 0U)) && \
- ((defined(FSL_FEATURE_SOC_USBDCD_COUNT) && (FSL_FEATURE_SOC_USBDCD_COUNT > 0U)) || \
- (defined(FSL_FEATURE_SOC_USBHSDCD_COUNT) && (FSL_FEATURE_SOC_USBHSDCD_COUNT > 0U)))
- /*!
- * @brief Handle the dcd module timeout notification.
- *
- * This function is used to handle the dcd module timeout 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_DeviceDcdTimeOutNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message)
- {
- /* Call device callback to notify the application that the device charger detect timeout happened. */
- return handle->deviceCallback(handle, kUSB_DeviceEventDcdTimeOut, NULL);
- }
- /*!
- * @brief Handle the dcd module unknown port type notification.
- *
- * This function is used to handle the dcd module unknown port type 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_DeviceDcdUnknownPortTypeNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message)
- {
- /* Call device callback to notify the application that the device charger detect unknown port type happened. */
- return handle->deviceCallback(handle, kUSB_DeviceEventDcdUnknownType, NULL);
- }
- /*!
- * @brief Handle the SDP facility is detected notification.
- *
- * This function is used to handle the SDP facility is detectednotification.
- *
- * @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_DeviceDcdSDPDetectNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message)
- {
- /* Call device callback to notify the application that the SDP facility is detected. */
- return handle->deviceCallback(handle, kUSB_DeviceEventSDPDetected, NULL);
- }
- /*!
- * @brief Handle the charging port is detected notification.
- *
- * This function is used to handle the charging port is detectednotification.
- *
- * @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_DeviceDcdChargingPortDetectNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message)
- {
- /* Call device callback to notify the application that the charing port is detected. */
- return handle->deviceCallback(handle, kUSB_DeviceEventChargingPortDetected, NULL);
- }
- /*!
- * @brief Handle the CDP facility is detected notification.
- *
- * This function is used to handle the CDP facility is detectednotification.
- *
- * @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_DeviceDcdChargingHostDetectNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message)
- {
- /* Call device callback to notify the application that the CDP facility is detected. */
- return handle->deviceCallback(handle, kUSB_DeviceEventChargingHostDetected, NULL);
- }
- /*!
- * @brief Handle the DCP facility is detected notification.
- *
- * This function is used to handle the DCP facility is detectednotification.
- *
- * @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_DeviceDcdDedicatedChargerDetectNotification(usb_device_struct_t *handle,
- usb_device_callback_message_struct_t *message)
- {
- /* Call device callback to notify the application that the DCP facility is detected. */
- return handle->deviceCallback(handle, kUSB_DeviceEventDedicatedChargerDetected, 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 (defined(USB_DEVICE_CONFIG_LOW_POWER_MODE) && (USB_DEVICE_CONFIG_LOW_POWER_MODE > 0U))
- case kUSB_DeviceNotifySuspend:
- error = USB_DeviceSuspendNotification(handle, message);
- break;
- case kUSB_DeviceNotifyResume:
- error = USB_DeviceResumeNotification(handle, message);
- break;
- #if (defined(USB_DEVICE_CONFIG_LPM_L1) && (USB_DEVICE_CONFIG_LPM_L1 > 0U))
- case kUSB_DeviceNotifyLPMSleep:
- error = USB_DeviceSleepNotification(handle, message);
- break;
- #endif
- #endif
- #if (defined(USB_DEVICE_CONFIG_ERROR_HANDLING) && (USB_DEVICE_CONFIG_ERROR_HANDLING > 0U))
- 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
- #if (defined(USB_DEVICE_CHARGER_DETECT_ENABLE) && (USB_DEVICE_CHARGER_DETECT_ENABLE > 0U)) && \
- ((defined(FSL_FEATURE_SOC_USBDCD_COUNT) && (FSL_FEATURE_SOC_USBDCD_COUNT > 0U)) || \
- (defined(FSL_FEATURE_SOC_USBHSDCD_COUNT) && (FSL_FEATURE_SOC_USBHSDCD_COUNT > 0U)))
- case kUSB_DeviceNotifyDcdTimeOut:
- error = USB_DeviceDcdTimeOutNotification(handle, message);
- break;
- case kUSB_DeviceNotifyDcdUnknownPortType:
- error = USB_DeviceDcdUnknownPortTypeNotification(handle, message);
- break;
- case kUSB_DeviceNotifySDPDetected:
- error = USB_DeviceDcdSDPDetectNotification(handle, message);
- break;
- case kUSB_DeviceNotifyChargingPortDetected:
- error = USB_DeviceDcdChargingPortDetectNotification(handle, message);
- break;
- case kUSB_DeviceNotifyChargingHostDetected:
- error = USB_DeviceDcdChargingHostDetectNotification(handle, message);
- break;
- case kUSB_DeviceNotifyDedicatedChargerDetected:
- error = USB_DeviceDcdDedicatedChargerDetectNotification(handle, message);
- break;
- #endif
- default:
- if (endpoint < USB_DEVICE_CONFIG_ENDPOINTS)
- {
- if (handle->epCallback[(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;
- if (message->isSetup)
- {
- handle->epCallback[0].isBusy = 0U;
- handle->epCallback[1].isBusy = 0U;
- }
- else
- {
- handle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].isBusy = 0U;
- }
- /* Call endpoint callback */
- error = handle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackFn(
- handle, &endpointCallbackMessage,
- handle->epCallback[(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 (defined(USB_DEVICE_CONFIG_USE_TASK) && (USB_DEVICE_CONFIG_USE_TASK > 0U))
- if (deviceHandle->epCallbackDirectly)
- {
- 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->epCallback[count].callbackFn = (usb_device_endpoint_callback_t)NULL;
- deviceHandle->epCallback[count].callbackParam = NULL;
- deviceHandle->epCallback[count].isBusy = 0U;
- }
- /* 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
- *handle = deviceHandle;
- /* Initialize the controller */
- error = deviceHandle->controllerInterface->deviceInit(controllerId, deviceHandle, &deviceHandle->controllerHandle);
- if (kStatus_USB_Success != error)
- {
- USB_DeviceDeinit(deviceHandle);
- *handle = NULL;
- return error;
- }
- /* Set the device to deafult state */
- deviceHandle->state = kUSB_DeviceStateDefault;
- 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 epCallback 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 epCallback 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 *epCallback)
- {
- usb_device_struct_t *deviceHandle = (usb_device_struct_t *)handle;
- uint8_t endpoint;
- uint8_t direction;
- if (!deviceHandle)
- {
- return kStatus_USB_InvalidHandle;
- }
- if ((!epInit) || (!epCallback))
- {
- 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->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackFn = epCallback->callbackFn;
- deviceHandle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackParam =
- epCallback->callbackParam;
- deviceHandle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].isBusy = 0U;
- }
- 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 (defined(USB_DEVICE_CONFIG_USE_TASK) && (USB_DEVICE_CONFIG_USE_TASK > 0U))
- USB_OSA_SR_ALLOC();
- #endif
- if (!deviceHandle)
- {
- return kStatus_USB_InvalidHandle;
- }
- #if (defined(USB_DEVICE_CONFIG_USE_TASK) && (USB_DEVICE_CONFIG_USE_TASK > 0U))
- USB_OSA_ENTER_CRITICAL();
- deviceHandle->epCallbackDirectly = 1;
- USB_OSA_EXIT_CRITICAL();
- #endif
- error = USB_DeviceControl(handle, kUSB_DeviceControlEndpointDeinit, &endpointAddress);
- #if (defined(USB_DEVICE_CONFIG_USE_TASK) && (USB_DEVICE_CONFIG_USE_TASK > 0U))
- USB_OSA_ENTER_CRITICAL();
- deviceHandle->epCallbackDirectly = 0;
- USB_OSA_EXIT_CRITICAL();
- #endif
- if (endpoint < USB_DEVICE_CONFIG_ENDPOINTS)
- {
- deviceHandle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackFn =
- (usb_device_endpoint_callback_t)NULL;
- deviceHandle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].callbackParam = NULL;
- deviceHandle->epCallback[(uint8_t)((uint32_t)endpoint << 1U) | direction].isBusy = 0U;
- }
- 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;
- #if ((defined(USB_DEVICE_CONFIG_REMOTE_WAKEUP)) && (USB_DEVICE_CONFIG_REMOTE_WAKEUP > 0U))
- case kUSB_DeviceStatusRemoteWakeup:
- temp8 = (uint8_t *)param;
- error = kStatus_USB_Success;
- *temp8 = ((usb_device_struct_t *)handle)->remotewakeup;
- break;
- #endif
- 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_LPCIP3511HS) && (USB_DEVICE_CONFIG_LPCIP3511HS > 0U))) && \
- (defined(USB_DEVICE_CONFIG_USB20_TEST_MODE) && (USB_DEVICE_CONFIG_USB20_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_DeviceStatusBusResume:
- error = USB_DeviceControl(handle, kUSB_DeviceControlResume, param);
- break;
- case kUSB_DeviceStatusBusSleepResume:
- error = USB_DeviceControl(handle, kUSB_DeviceControlSleepResume, param);
- break;
- #if ((defined(USB_DEVICE_CONFIG_REMOTE_WAKEUP)) && (USB_DEVICE_CONFIG_REMOTE_WAKEUP > 0U))
- case kUSB_DeviceStatusRemoteWakeup:
- if (NULL != param)
- {
- error = kStatus_USB_Success;
- ((usb_device_struct_t *)handle)->remotewakeup = (uint8_t)(*(uint8_t *)param);
- }
- break;
- #endif
- case kUSB_DeviceStatusBusSuspend:
- error = USB_DeviceControl(handle, kUSB_DeviceControlSuspend, param);
- break;
- case kUSB_DeviceStatusBusSleep:
- error = USB_DeviceControl(handle, kUSB_DeviceControlSleep, param);
- break;
- default:
- break;
- }
- return error;
- }
- #if (defined(USB_DEVICE_CHARGER_DETECT_ENABLE) && (USB_DEVICE_CHARGER_DETECT_ENABLE > 0U)) && \
- ((defined(FSL_FEATURE_SOC_USBDCD_COUNT) && (FSL_FEATURE_SOC_USBDCD_COUNT > 0U)) || \
- (defined(FSL_FEATURE_SOC_USBHSDCD_COUNT) && (FSL_FEATURE_SOC_USBHSDCD_COUNT > 0U)))
- /*!
- * @brief Initializes the device dcd module.
- *
- * The function initializes the device dcd module.
- *
- * @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_DeviceDcdInitModule(usb_device_handle handle, void *time_param)
- {
- return USB_DeviceControl(handle, kUSB_DeviceControlDcdInitModule, time_param);
- }
- /*!
- * @brief De-initializes the device dcd module.
- *
- * The function de-intializes the device dcd module.
- *
- * @param handle The device handle got from USB_DeviceInit.
- *
- * @retval kStatus_USB_Success The device is run successfully.
- * @retval kStatus_USB_InvalidHandle The device handle is a NULL pointer. Or the controller handle is invalid.
- *
- */
- usb_status_t USB_DeviceDcdDeinitModule(usb_device_handle handle)
- {
- return USB_DeviceControl(handle, kUSB_DeviceControlDcdDeinitModule, NULL);
- }
- #endif
- #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);
- }
- }
- #if ((defined(USB_DEVICE_CONFIG_REMOTE_WAKEUP)) && (USB_DEVICE_CONFIG_REMOTE_WAKEUP > 0U))
- /*!
- * @brief Update the hardware tick.
- *
- * The function is used to update the hardware tick.
- *
- * @param[in] handle The device handle got from #USB_DeviceInit.
- * @param[in] tick Current hardware tick.
- *
- */
- usb_status_t USB_DeviceUpdateHwTick(usb_device_handle handle, uint64_t tick)
- {
- usb_device_struct_t *deviceHandle;
- usb_status_t status = kStatus_USB_Success;
- if (handle == NULL)
- {
- return kStatus_USB_InvalidHandle;
- }
- deviceHandle = (usb_device_struct_t *)handle;
- deviceHandle->hwTick = tick;
- return status;
- }
- #endif
- #endif /* USB_DEVICE_CONFIG_NUM */
|