135 lines
5.3 KiB
C
135 lines
5.3 KiB
C
/*
|
|
* Copyright (c) 2015, Freescale Semiconductor, Inc.
|
|
* Copyright 2016 NXP
|
|
* All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef __USB_H__
|
|
#define __USB_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
#include "fsl_common.h"
|
|
#include "fsl_os_abstraction.h"
|
|
#include "usb_misc.h"
|
|
#include "usb_spec.h"
|
|
|
|
/*!
|
|
* @addtogroup usb_drv
|
|
* @{
|
|
*/
|
|
|
|
/*******************************************************************************
|
|
* Definitions
|
|
******************************************************************************/
|
|
/*! @brief Defines USB stack major version */
|
|
#define USB_STACK_VERSION_MAJOR (2UL)
|
|
/*! @brief Defines USB stack minor version */
|
|
#define USB_STACK_VERSION_MINOR (7UL)
|
|
/*! @brief Defines USB stack bugfix version */
|
|
#define USB_STACK_VERSION_BUGFIX (0U)
|
|
|
|
/*! @brief USB stack version definition */
|
|
#define USB_MAKE_VERSION(major, minor, bugfix) (((major) << 16) | ((minor) << 8) | (bugfix))
|
|
|
|
#define MAKE_VERSION(major, minor, bugfix) (((major) << 16) | ((minor) << 8) | (bugfix))
|
|
|
|
/*! @brief USB stack component version definition, changed with component in yaml together */
|
|
#define USB_STACK_COMPONENT_VERSION \
|
|
MAKE_VERSION(USB_STACK_VERSION_MAJOR, USB_STACK_VERSION_MINOR, USB_STACK_VERSION_BUGFIX)
|
|
|
|
/*
|
|
* Component ID used by tools
|
|
*
|
|
* FSL_COMPONENT_ID "middleware.usb.stack_common"
|
|
*/
|
|
|
|
/*! @brief USB error code */
|
|
typedef enum _usb_status
|
|
{
|
|
kStatus_USB_Success = 0x00U, /*!< Success */
|
|
kStatus_USB_Error, /*!< Failed */
|
|
|
|
kStatus_USB_Busy, /*!< Busy */
|
|
kStatus_USB_InvalidHandle, /*!< Invalid handle */
|
|
kStatus_USB_InvalidParameter, /*!< Invalid parameter */
|
|
kStatus_USB_InvalidRequest, /*!< Invalid request */
|
|
kStatus_USB_ControllerNotFound, /*!< Controller cannot be found */
|
|
kStatus_USB_InvalidControllerInterface, /*!< Invalid controller interface */
|
|
|
|
kStatus_USB_NotSupported, /*!< Configuration is not supported */
|
|
kStatus_USB_Retry, /*!< Enumeration get configuration retry */
|
|
kStatus_USB_TransferStall, /*!< Transfer stalled */
|
|
kStatus_USB_TransferFailed, /*!< Transfer failed */
|
|
kStatus_USB_AllocFail, /*!< Allocation failed */
|
|
kStatus_USB_LackSwapBuffer, /*!< Insufficient swap buffer for KHCI */
|
|
kStatus_USB_TransferCancel, /*!< The transfer cancelled */
|
|
kStatus_USB_BandwidthFail, /*!< Allocate bandwidth failed */
|
|
kStatus_USB_MSDStatusFail, /*!< For MSD, the CSW status means fail */
|
|
kStatus_USB_EHCIAttached,
|
|
kStatus_USB_EHCIDetached,
|
|
kStatus_USB_DataOverRun, /*!< The amount of data returned by the endpoint exceeded
|
|
either the size of the maximum data packet allowed
|
|
from the endpoint or the remaining buffer size. */
|
|
} usb_status_t;
|
|
|
|
/*! @brief USB host handle type define */
|
|
typedef void *usb_host_handle;
|
|
|
|
/*! @brief USB device handle type define. For device stack it is the whole device handle; for host stack it is the
|
|
* attached device instance handle*/
|
|
typedef void *usb_device_handle;
|
|
|
|
/*! @brief USB OTG handle type define */
|
|
typedef void *usb_otg_handle;
|
|
|
|
/*! @brief USB controller ID */
|
|
typedef enum _usb_controller_index
|
|
{
|
|
kUSB_ControllerKhci0 = 0U, /*!< KHCI 0U */
|
|
kUSB_ControllerKhci1 = 1U, /*!< KHCI 1U, Currently, there are no platforms which have two KHCI IPs, this is reserved
|
|
to be used in the future. */
|
|
kUSB_ControllerEhci0 = 2U, /*!< EHCI 0U */
|
|
kUSB_ControllerEhci1 = 3U, /*!< EHCI 1U, Currently, there are no platforms which have two EHCI IPs, this is reserved
|
|
to be used in the future. */
|
|
|
|
kUSB_ControllerLpcIp3511Fs0 = 4U, /*!< LPC USB IP3511 FS controller 0 */
|
|
kUSB_ControllerLpcIp3511Fs1 = 5U, /*!< LPC USB IP3511 FS controller 1, there are no platforms which have two IP3511
|
|
IPs, this is reserved to be used in the future. */
|
|
|
|
kUSB_ControllerLpcIp3511Hs0 = 6U, /*!< LPC USB IP3511 HS controller 0 */
|
|
kUSB_ControllerLpcIp3511Hs1 = 7U, /*!< LPC USB IP3511 HS controller 1, there are no platforms which have two IP3511
|
|
IPs, this is reserved to be used in the future. */
|
|
|
|
kUSB_ControllerOhci0 = 8U, /*!< OHCI 0U */
|
|
kUSB_ControllerOhci1 = 9U, /*!< OHCI 1U, Currently, there are no platforms which have two OHCI IPs, this is reserved
|
|
to be used in the future. */
|
|
|
|
kUSB_ControllerIp3516Hs0 = 10U, /*!< IP3516HS 0U */
|
|
kUSB_ControllerIp3516Hs1 = 11U, /*!< IP3516HS 1U, Currently, there are no platforms which have two IP3516HS IPs,
|
|
this is reserved to be used in the future. */
|
|
kUSB_ControllerDwc30 = 12U, /*!< DWC3 0U */
|
|
kUSB_ControllerDwc31 = 13U, /*!< DWC3 1U Currently, there are no platforms which have two Dwc IPs, this is reserved
|
|
to be used in the future.*/
|
|
} usb_controller_index_t;
|
|
|
|
/**
|
|
* @brief USB stack version fields
|
|
*/
|
|
typedef struct _usb_version
|
|
{
|
|
uint8_t major; /*!< Major */
|
|
uint8_t minor; /*!< Minor */
|
|
uint8_t bugfix; /*!< Bug fix */
|
|
} usb_version_t;
|
|
|
|
/*******************************************************************************
|
|
* API
|
|
******************************************************************************/
|
|
|
|
/*! @} */
|
|
|
|
#endif /* __USB_H__ */
|