git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_R5_UltraScale_MPSoC/RTOSDemo_R5_bsp/psu_cortexr5_0/libsrc/usbpsu_v1_4/src/xusb_wrapper.h

   1 /******************************************************************************
   2  *
   3  * Copyright (C) 2017 Xilinx, Inc.  All rights reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * Use of the Software is limited solely to applications:
  16  * (a) running on a Xilinx device, or
  17  * (b) that interact with a Xilinx device through a bus or interconnect.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  22  * XILINX  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  24  * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  *
  27  * Except as contained in this notice, the name of the Xilinx shall not be used
  28  * in advertising or otherwise to promote the sale, use or other dealings in
  29  * this Software without prior written authorization from Xilinx.
  30  *
  31  ******************************************************************************/
  32 /*****************************************************************************/
  33 /**
  34  *
  35  * @file xusb_wrapper.h
  36  *
  37  * This file contains declarations for USBPSU Driver wrappers.
  38  *
  39  * <pre>
  40  * MODIFICATION HISTORY:
  41  *
  42  * Ver   Who    Date     Changes
  43  * ----- ----   -------- -------------------------------------------------------
  44  *  1.0  BK     12/01/18 First release
  45  *       MYK    12/01/18 Added hibernation support for device mode
  46  *       vak    22/01/18 Added Microblaze support for usbpsu driver
  47  *       vak    13/03/18 Moved the setup interrupt system calls from driver to
  48  *                       example.
  49  *
  50  * </pre>
  51  *
  52  *****************************************************************************/
  53
  54 #ifndef XUSB_WRAPPER_H  /* Prevent circular inclusions */
  55 #define XUSB_WRAPPER_H  /* by using protection macros  */
  56
  57 #ifdef __cplusplus
  58 extern "C" {
  59 #endif
  60
  61 /***************************** Include Files ********************************/
  62 #include "xusbpsu.h"
  63
  64 /************************** Constant Definitions ****************************/
  65 #define USB_DEVICE_ID           XPAR_XUSBPSU_0_DEVICE_ID
  66
  67 #define USB_EP_DIR_IN           XUSBPSU_EP_DIR_IN
  68 #define USB_EP_DIR_OUT          XUSBPSU_EP_DIR_OUT
  69
  70 #define USB_DIR_OUT                             0U              /* to device */
  71 #define USB_DIR_IN                              0x80U   /* to host */
  72
  73 /**
  74  * @name Endpoint Address
  75  * @{
  76  */
  77 #define USB_EP1_IN              0x81
  78 #define USB_EP1_OUT             0x01
  79 #define USB_EP2_IN              0x82
  80 #define USB_EP2_OUT             0x02
  81 /* @} */
  82
  83 /**
  84  * @name Endpoint Type
  85  * @{
  86  */
  87 #define USB_EP_TYPE_CONTROL                     XUSBPSU_ENDPOINT_XFER_CONTROL
  88 #define USB_EP_TYPE_ISOCHRONOUS         XUSBPSU_ENDPOINT_XFER_ISOC
  89 #define USB_EP_TYPE_BULK                        XUSBPSU_ENDPOINT_XFER_BULK
  90 #define USB_EP_TYPE_INTERRUPT           XUSBPSU_ENDPOINT_XFER_INT
  91 /* @} */
  92
  93 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
  94 #define USB_ENDPOINT_DIR_MASK           0x80
  95
  96 /*
  97  * Device States
  98  */
  99 #define         USB_STATE_ATTACHED              XUSBPSU_STATE_ATTACHED
 100 #define         USB_STATE_POWERED               XUSBPSU_STATE_POWERED
 101 #define         USB_STATE_DEFAULT               XUSBPSU_STATE_DEFAULT
 102 #define         USB_STATE_ADDRESS               XUSBPSU_STATE_ADDRESS
 103 #define         USB_STATE_CONFIGURED    XUSBPSU_STATE_CONFIGURED
 104 #define         USB_STATE_SUSPENDED             XUSBPSU_STATE_SUSPENDED
 105
 106 #define XUSBPSU_REQ_REPLY_LEN       1024        /**< Max size of reply buffer. */
 107 #define USB_REQ_REPLY_LEN                       XUSBPSU_REQ_REPLY_LEN
 108
 109 /*
 110  * Device Speeds
 111  */
 112 #define USB_SPEED_UNKNOWN               XUSBPSU_SPEED_UNKNOWN
 113 #define USB_SPEED_LOW                   XUSBPSU_SPEED_LOW
 114 #define USB_SPEED_FULL                  XUSBPSU_SPEED_FULL
 115 #define USB_SPEED_HIGH                  XUSBPSU_SPEED_HIGH
 116 #define USB_SPEED_SUPER                 XUSBPSU_SPEED_SUPER
 117
 118 /* Device Configuration Speed */
 119 #define USB_DCFG_SPEED_MASK             XUSBPSU_DCFG_SPEED_MASK
 120 #define USB_DCFG_SUPERSPEED             XUSBPSU_DCFG_SUPERSPEED
 121 #define USB_DCFG_HIGHSPEED              XUSBPSU_DCFG_HIGHSPEED
 122 #define USB_DCFG_FULLSPEED2             XUSBPSU_DCFG_FULLSPEED2
 123 #define USB_DCFG_LOWSPEED               XUSBPSU_DCFG_LOWSPEED
 124 #define USB_DCFG_FULLSPEED1             XUSBPSU_DCFG_FULLSPEED1
 125
 126 #define USB_TEST_J                              XUSBPSU_TEST_J
 127 #define USB_TEST_K                              XUSBPSU_TEST_K
 128 #define USB_TEST_SE0_NAK                XUSBPSU_TEST_SE0_NAK
 129 #define USB_TEST_PACKET                 XUSBPSU_TEST_PACKET
 130 #define USB_TEST_FORCE_ENABLE   XUSBPSU_TEST_FORCE_ENABLE
 131
 132 /* TODO: If we enable this macro, reconnection is failed with 2017.3 */
 133 #define USB_LPM_MODE                    XUSBPSU_LPM_MODE
 134
 135 /*
 136  * return Physical EP number as dwc3 mapping
 137  */
 138 #define PhysicalEp(epnum, direction)    (((epnum) << 1 ) | (direction))
 139
 140 /**************************** Type Definitions ******************************/
 141
 142 /************************** Variable Definitions *****************************/
 143 struct XUsbPsu PrivateData;
 144
 145 /***************** Macros (Inline Functions) Definitions *********************/
 146 Usb_Config* LookupConfig(u16 DeviceId);
 147 void CacheInit(void);
 148 s32 CfgInitialize(struct Usb_DevData *InstancePtr,
 149                         Usb_Config *ConfigPtr, u32 BaseAddress);
 150 void Set_Ch9Handler(void *InstancePtr,
 151                                 void (*func)(struct Usb_DevData *, SetupPacket *));
 152 void Set_RstHandler(void *InstancePtr, void (*func)(struct Usb_DevData *));
 153 void Set_Disconnect(void *InstancePtr, void (*func)(struct Usb_DevData *));
 154 void EpConfigure(void *UsbInstance, u8 EndpointNo, u8 dir, u32 Type);
 155 s32 ConfigureDevice(void *UsbInstance, u8 *MemPtr, u32 memSize);
 156 void SetEpHandler(void *InstancePtr, u8 Epnum,
 157                         u8 Dir, void (*Handler)(void *, u32, u32));
 158 s32 Usb_Start(void *InstancePtr);
 159 void *Get_DrvData(void *InstancePtr);
 160 void Set_DrvData(void *InstancePtr, void *data);
 161 s32 IsEpStalled(void *InstancePtr, u8 Epnum, u8 Dir);
 162 void EpClearStall(void *InstancePtr, u8 Epnum, u8 Dir);
 163 s32 EpBufferSend(void *InstancePtr, u8 UsbEp,
 164                         u8 *BufferPtr, u32 BufferLen);
 165 s32 EpBufferRecv(void *InstancePtr, u8 UsbEp,
 166                                 u8 *BufferPtr, u32 Length);
 167 void EpSetStall(void *InstancePtr, u8 Epnum, u8 Dir);
 168 void SetBits(void *InstancePtr, u32 TestSel);
 169 s32 SetDeviceAddress(void *InstancePtr, u16 Addr);
 170 s32 SetU1SleepTimeout(void *InstancePtr, u8 Sleep);
 171 s32 SetU2SleepTimeout(void *InstancePtr, u8 Sleep);
 172 s32 AcceptU1U2Sleep(void *InstancePtr);
 173 s32 U1SleepEnable(void *InstancePtr);
 174 s32 U2SleepEnable(void *InstancePtr);
 175 s32 U1SleepDisable(void *InstancePtr);
 176 s32 U2SleepDisable(void *InstancePtr);
 177 s32 EpEnable(void *InstancePtr, u8 UsbEpNum, u8 Dir, u16 Maxsize, u8 Type);
 178 s32 EpDisable(void *InstancePtr, u8 UsbEpNum, u8 Dir);
 179 void Usb_SetSpeed(void *InstancePtr, u32 Speed);
 180 s32 IsSuperSpeed(struct Usb_DevData *InstancePtr);
 181 void SetConfigDone(void *InstancePtr, u8 Flag);
 182 u8 GetConfigDone(void *InstancePtr);
 183 void Ep0StallRestart(void *InstancePtr);
 184 void SetEpInterval(void *InstancePtr, u8 UsbEpNum, u8 Dir, u32 Interval);
 185 void StopTransfer(void *InstancePtr, u8 EpNum, u8 Dir);
 186 s32 StreamOn(void *InstancePtr, u8 EpNum, u8 Dir, u8 *BufferPtr);
 187 void StreamOff(void *InstancePtr, u8 EpNum, u8 Dir);
 188
 189 #endif  /* End of protection macro. */
 190 /** @} */