QuarkSocPkg/QuarkSouthCluster/Usb/Ohci/Dxe/Descriptor.h

   1 /** @file
   2 This file contains the descriptor definination of OHCI spec
   3
   4 Copyright (c) 2013-2015 Intel Corporation.
   5
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10
  11
  12 #ifndef _DESCRIPTOR_H
  13 #define _DESCRIPTOR_H
  14
  15 #define ED_FUNC_ADD     0x0001
  16 #define ED_ENDPT_NUM    0x0002
  17 #define ED_DIR          0x0004
  18 #define ED_SPEED        0x0008
  19 #define ED_SKIP         0x0010
  20 #define ED_FORMAT       0x0020
  21 #define ED_MAX_PACKET   0x0040
  22 #define ED_TDTAIL_PTR   0x0080
  23 #define ED_HALTED       0x0100
  24 #define ED_DTTOGGLE     0x0200
  25 #define ED_TDHEAD_PTR   0x0400
  26 #define ED_NEXT_EDPTR   0x0800
  27 #define ED_PDATA        0x1000
  28 #define ED_ZERO         0x2000
  29
  30 #define TD_BUFFER_ROUND     0x0001
  31 #define TD_DIR_PID          0x0002
  32 #define TD_DELAY_INT        0x0004
  33 #define TD_DT_TOGGLE        0x0008
  34 #define TD_ERROR_CNT        0x0010
  35 #define TD_COND_CODE        0x0020
  36 #define TD_CURR_BUFFER_PTR  0x0040
  37 #define TD_NEXT_PTR         0x0080
  38 #define TD_BUFFER_END_PTR   0x0100
  39 #define TD_PDATA            0x0200
  40
  41 #define ED_FROM_TD_DIR        0x0
  42 #define ED_OUT_DIR            0x1
  43 #define ED_IN_DIR             0x2
  44 #define ED_FROM_TD_ALSO_DIR   0x3
  45
  46 #define TD_SETUP_PID          0x00
  47 #define TD_OUT_PID            0x01
  48 #define TD_IN_PID             0x02
  49 #define TD_NODATA_PID         0x03
  50
  51 #define HI_SPEED              0
  52 #define LO_SPEED              1
  53
  54 #define TD_NO_ERROR           0x00
  55 #define TD_CRC_ERROR          0x01
  56 #define TD_BITSTUFFING_ERROR  0x02
  57 #define TD_TOGGLE_ERROR       0x03
  58 #define TD_DEVICE_STALL       0x04
  59 #define TD_NO_RESPONSE        0x05
  60 #define TD_PIDCHK_FAIL        0x06
  61 #define TD_PID_UNEXPECTED     0x07
  62 #define TD_DATA_OVERRUN       0x08
  63 #define TD_DATA_UNDERRUN      0x09
  64 #define TD_BUFFER_OVERRUN     0x0C
  65 #define TD_BUFFER_UNDERRUN    0x0D
  66 #define TD_TOBE_PROCESSED     0x0E
  67 #define TD_TOBE_PROCESSED_2   0x0F
  68
  69 #define TD_NO_DELAY           0x7
  70
  71 #define TD_INT                0x1
  72 #define TD_CTL                0x2
  73 #define TD_BLK                0x3
  74
  75 typedef struct {
  76   UINT32 Reserved:18;
  77   UINT32 BufferRounding:1;
  78   UINT32 DirPID:2;
  79   UINT32 DelayInterrupt:3;
  80   UINT32 DataToggle:2;
  81   UINT32 ErrorCount:2;
  82   UINT32 ConditionCode:4;
  83 } TD_DESCRIPTOR_WORD0;
  84
  85 typedef struct _TD_DESCRIPTOR {
  86   TD_DESCRIPTOR_WORD0     Word0;
  87   UINT32                  CurrBufferPointer;          // 32-bit Physical Address of buffer
  88   UINT32                  NextTD;                     // 32-bit Physical Address of TD_DESCRIPTOR
  89   UINT32                  BufferEndPointer;           // 32-bit Physical Address of buffer
  90   UINT32                  NextTDPointer;              // 32-bit Physical Address of TD_DESCRIPTOR
  91   UINT32                  DataBuffer;                 // 32-bit Physical Address of buffer
  92   UINT32                  ActualSendLength;
  93   UINT32                  Reserved;
  94 } TD_DESCRIPTOR;
  95
  96 typedef struct {
  97   UINT32 FunctionAddress:7;
  98   UINT32 EndPointNum:4;
  99   UINT32 Direction:2;
 100   UINT32 Speed:1;
 101   UINT32 Skip:1;
 102   UINT32 Format:1;
 103   UINT32 MaxPacketSize:11;
 104   UINT32 FreeSpace:5;
 105 } ED_DESCRIPTOR_WORD0;
 106
 107 typedef struct {
 108   UINT32 Halted:1;
 109   UINT32 ToggleCarry:1;
 110   UINT32 Zero:2;
 111   UINT32 TdHeadPointer:28;
 112 } ED_DESCRIPTOR_WORD2;
 113
 114 typedef struct _ED_DESCRIPTOR {
 115   ED_DESCRIPTOR_WORD0     Word0;
 116   UINT32                  TdTailPointer;    // 32-bit Physical Address of TD_DESCRIPTOR
 117   ED_DESCRIPTOR_WORD2     Word2;
 118   UINT32                  NextED;           // 32-bit Physical Address of ED_DESCRIPTOR
 119 } ED_DESCRIPTOR;
 120
 121 #define TD_PTR(p)            ((TD_DESCRIPTOR *)(UINTN)((p) << 4))
 122 #define ED_PTR(p)            ((ED_DESCRIPTOR *)(UINTN)((p) << 4))
 123 #define RIGHT_SHIFT_4(p)     ((UINT32)(p) >> 4)
 124
 125 typedef enum {
 126   CONTROL_LIST,
 127   BULK_LIST,
 128   INTERRUPT_LIST,
 129   ISOCHRONOUS_LIST
 130 } DESCRIPTOR_LIST_TYPE;
 131
 132 #endif