132 lines
6.5 KiB
C
132 lines
6.5 KiB
C
/*
|
|
* Copyright (c) 2015, Freescale Semiconductor, Inc.
|
|
* Copyright 2016 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.
|
|
*/
|
|
|
|
#ifndef _USB_HOST_HCI_H_
|
|
#define _USB_HOST_HCI_H_
|
|
|
|
/*******************************************************************************
|
|
* Definitions
|
|
******************************************************************************/
|
|
|
|
/*! @brief USB host lock */
|
|
#define USB_HostLock() USB_OsaMutexLock(hostInstance->hostMutex)
|
|
/*! @brief USB host unlock */
|
|
#define USB_HostUnlock() USB_OsaMutexUnlock(hostInstance->hostMutex)
|
|
|
|
/*!
|
|
* @addtogroup usb_host_controller_driver
|
|
* @{
|
|
*/
|
|
|
|
/*! @brief USB host controller control code */
|
|
typedef enum _usb_host_controller_control
|
|
{
|
|
kUSB_HostCancelTransfer = 1U, /*!< Cancel transfer code */
|
|
kUSB_HostBusControl, /*!< Bus control code */
|
|
kUSB_HostGetFrameNumber, /*!< Get frame number code */
|
|
kUSB_HostUpdateControlEndpointAddress, /*!< Update control endpoint address */
|
|
kUSB_HostUpdateControlPacketSize, /*!< Update control endpoint maximum packet size */
|
|
kUSB_HostPortAttachDisable, /*!< Disable the port attach event */
|
|
kUSB_HostPortAttachEnable, /*!< Enable the port attach event */
|
|
kUSB_HostL1Config, /*!< L1 suspend Bus control code */
|
|
} usb_host_controller_control_t;
|
|
|
|
/*! @brief USB host controller bus control code */
|
|
typedef enum _usb_host_bus_control
|
|
{
|
|
kUSB_HostBusReset = 1U, /*!< Reset bus */
|
|
kUSB_HostBusRestart, /*!< Restart bus */
|
|
kUSB_HostBusEnableAttach, /*!< Enable attach */
|
|
kUSB_HostBusDisableAttach, /*!< Disable attach */
|
|
kUSB_HostBusSuspend, /*!< Suspend BUS */
|
|
kUSB_HostBusResume, /*!< Resume BUS */
|
|
kUSB_HostBusL1SuspendInit, /*!< L1 Suspend BUS */
|
|
kUSB_HostBusL1Sleep, /*!< L1 Suspend BUS */
|
|
kUSB_HostBusL1Resume, /*!< L1 Resume BUS */
|
|
} usb_host_bus_control_t;
|
|
|
|
/*! @brief USB host controller interface structure */
|
|
typedef struct _usb_host_controller_interface
|
|
{
|
|
usb_status_t (*controllerCreate)(
|
|
uint8_t controllerId,
|
|
usb_host_handle upperLayerHandle,
|
|
usb_host_controller_handle *controllerHandle); /*!< Create a controller instance function prototype*/
|
|
usb_status_t (*controllerDestory)(
|
|
usb_host_controller_handle controllerHandle); /*!< Destroy a controller instance function prototype*/
|
|
usb_status_t (*controllerOpenPipe)(usb_host_controller_handle controllerHandle,
|
|
usb_host_pipe_handle *pipeHandle,
|
|
usb_host_pipe_init_t *pipeInit); /*!< Open a controller pipe function prototype*/
|
|
usb_status_t (*controllerClosePipe)(
|
|
usb_host_controller_handle controllerHandle,
|
|
usb_host_pipe_handle pipeHandle); /*!< Close a controller pipe function prototype*/
|
|
usb_status_t (*controllerWritePipe)(usb_host_controller_handle controllerHandle,
|
|
usb_host_pipe_handle pipeHandle,
|
|
usb_host_transfer_t *transfer); /*!< Write data to a pipe function prototype*/
|
|
usb_status_t (*controllerReadPipe)(usb_host_controller_handle controllerHandle,
|
|
usb_host_pipe_handle pipeHandle,
|
|
usb_host_transfer_t *transfer); /*!< Read data from a pipe function prototype*/
|
|
usb_status_t (*controllerIoctl)(usb_host_controller_handle controllerHandle,
|
|
uint32_t ioctlEvent,
|
|
void *ioctlParam); /*!< Control a controller function prototype*/
|
|
} usb_host_controller_interface_t;
|
|
|
|
/*! @}*/
|
|
|
|
/*!
|
|
* @addtogroup usb_host_drv
|
|
* @{
|
|
*/
|
|
|
|
/*! @brief USB host instance structure */
|
|
typedef struct _usb_host_instance
|
|
{
|
|
void *controllerHandle; /*!< The low level controller handle*/
|
|
host_callback_t deviceCallback; /*!< Device attach/detach callback*/
|
|
usb_osa_mutex_handle hostMutex; /*!< Host layer mutex*/
|
|
usb_host_transfer_t transferList[USB_HOST_CONFIG_MAX_TRANSFERS]; /*!< Transfer resource*/
|
|
usb_host_transfer_t *transferHead; /*!< Idle transfer head*/
|
|
const usb_host_controller_interface_t *controllerTable; /*!< KHCI/EHCI interface*/
|
|
void *deviceList; /*!< Device list*/
|
|
#if ((defined(USB_HOST_CONFIG_LOW_POWER_MODE)) && (USB_HOST_CONFIG_LOW_POWER_MODE > 0U))
|
|
void *suspendedDevice; /*!< Suspended device handle*/
|
|
volatile uint64_t hwTick; /*!< Current hw tick(ms)*/
|
|
uint8_t sleepType; /*!< L1 LPM device handle*/
|
|
#endif
|
|
uint8_t addressBitMap[16]; /*!< Used for address allocation. The first bit is the address 1, second bit is the
|
|
address 2*/
|
|
uint8_t occupied; /*!< 0 - the instance is not occupied; 1 - the instance is occupied*/
|
|
uint8_t controllerId; /*!< The controller ID*/
|
|
} usb_host_instance_t;
|
|
|
|
/*! @}*/
|
|
|
|
#endif /* _USB_HOST_HCI_H_ */
|