]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Bus/Pci/EhciDxe/EhciUrb.h
Update the copyright notice format
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / EhciDxe / EhciUrb.h
index 7b66184a19acf2f7abcca90c843eabf4f63bb211..02e9af81be391d873d975a68ba09d70600248ca4 100644 (file)
@@ -3,8 +3,8 @@
     This file contains URB request, each request is warpped in a\r
     URB (Usb Request Block).\r
 \r
-Copyright (c) 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -22,61 +22,59 @@ typedef struct _EHC_QTD  EHC_QTD;
 typedef struct _EHC_QH   EHC_QH;\r
 typedef struct _URB      URB;\r
 \r
-typedef enum {\r
-  //\r
-  // Transfer types, used in URB to identify the transfer type\r
-  //\r
-  EHC_CTRL_TRANSFER       = 0x01,\r
-  EHC_BULK_TRANSFER       = 0x02,\r
-  EHC_INT_TRANSFER_SYNC   = 0x04,\r
-  EHC_INT_TRANSFER_ASYNC  = 0x08,\r
+//\r
+// Transfer types, used in URB to identify the transfer type\r
+//\r
+#define EHC_CTRL_TRANSFER       0x01\r
+#define EHC_BULK_TRANSFER       0x02\r
+#define EHC_INT_TRANSFER_SYNC   0x04\r
+#define EHC_INT_TRANSFER_ASYNC  0x08\r
 \r
-  EHC_QTD_SIG             = SIGNATURE_32 ('U', 'S', 'B', 'T'),\r
-  EHC_QH_SIG              = SIGNATURE_32 ('U', 'S', 'B', 'H'),\r
-  EHC_URB_SIG             = SIGNATURE_32 ('U', 'S', 'B', 'R'),\r
+#define EHC_QTD_SIG             SIGNATURE_32 ('U', 'S', 'B', 'T')\r
+#define EHC_QH_SIG              SIGNATURE_32 ('U', 'S', 'B', 'H')\r
+#define EHC_URB_SIG             SIGNATURE_32 ('U', 'S', 'B', 'R')\r
 \r
-  //\r
-  // Hardware related bit definitions\r
-  //\r
-  EHC_TYPE_ITD            = 0x00,\r
-  EHC_TYPE_QH             = 0x02,\r
-  EHC_TYPE_SITD           = 0x04,\r
-  EHC_TYPE_FSTN           = 0x06,\r
-\r
-  QH_NAK_RELOAD           = 3,\r
-  QH_HSHBW_MULTI          = 1,\r
-\r
-  QTD_MAX_ERR             = 3,\r
-  QTD_PID_OUTPUT          = 0x00,\r
-  QTD_PID_INPUT           = 0x01,\r
-  QTD_PID_SETUP           = 0x02,\r
-\r
-  QTD_STAT_DO_OUT         = 0,\r
-  QTD_STAT_DO_SS          = 0,\r
-  QTD_STAT_DO_PING        = 0x01,\r
-  QTD_STAT_DO_CS          = 0x02,\r
-  QTD_STAT_TRANS_ERR      = 0x08,\r
-  QTD_STAT_BABBLE_ERR     = 0x10,\r
-  QTD_STAT_BUFF_ERR       = 0x20,\r
-  QTD_STAT_HALTED         = 0x40,\r
-  QTD_STAT_ACTIVE         = 0x80,\r
-  QTD_STAT_ERR_MASK       = QTD_STAT_TRANS_ERR | QTD_STAT_BABBLE_ERR | QTD_STAT_BUFF_ERR,\r
-\r
-  QTD_MAX_BUFFER          = 4,\r
-  QTD_BUF_LEN             = 4096,\r
-  QTD_BUF_MASK            = 0x0FFF,\r
-\r
-  QH_MICROFRAME_0         = 0x01,\r
-  QH_MICROFRAME_1         = 0x02,\r
-  QH_MICROFRAME_2         = 0x04,\r
-  QH_MICROFRAME_3         = 0x08,\r
-  QH_MICROFRAME_4         = 0x10,\r
-  QH_MICROFRAME_5         = 0x20,\r
-  QH_MICROFRAME_6         = 0x40,\r
-  QH_MICROFRAME_7         = 0x80,\r
-\r
-  USB_ERR_SHORT_PACKET    = 0x200\r
-}EHCI_URB_FLAG_VALUE;\r
+//\r
+// Hardware related bit definitions\r
+//\r
+#define EHC_TYPE_ITD            0x00\r
+#define EHC_TYPE_QH             0x02\r
+#define EHC_TYPE_SITD           0x04\r
+#define EHC_TYPE_FSTN           0x06\r
+\r
+#define QH_NAK_RELOAD           3\r
+#define QH_HSHBW_MULTI          1\r
+\r
+#define QTD_MAX_ERR             3\r
+#define QTD_PID_OUTPUT          0x00\r
+#define QTD_PID_INPUT           0x01\r
+#define QTD_PID_SETUP           0x02\r
+\r
+#define QTD_STAT_DO_OUT         0\r
+#define QTD_STAT_DO_SS          0\r
+#define QTD_STAT_DO_PING        0x01\r
+#define QTD_STAT_DO_CS          0x02\r
+#define QTD_STAT_TRANS_ERR      0x08\r
+#define QTD_STAT_BABBLE_ERR     0x10\r
+#define QTD_STAT_BUFF_ERR       0x20\r
+#define QTD_STAT_HALTED         0x40\r
+#define QTD_STAT_ACTIVE         0x80\r
+#define QTD_STAT_ERR_MASK       (QTD_STAT_TRANS_ERR | QTD_STAT_BABBLE_ERR | QTD_STAT_BUFF_ERR)\r
+\r
+#define QTD_MAX_BUFFER          4\r
+#define QTD_BUF_LEN             4096\r
+#define QTD_BUF_MASK            0x0FFF\r
+\r
+#define QH_MICROFRAME_0         0x01\r
+#define QH_MICROFRAME_1         0x02\r
+#define QH_MICROFRAME_2         0x04\r
+#define QH_MICROFRAME_3         0x08\r
+#define QH_MICROFRAME_4         0x10\r
+#define QH_MICROFRAME_5         0x20\r
+#define QH_MICROFRAME_6         0x40\r
+#define QH_MICROFRAME_7         0x80\r
+\r
+#define USB_ERR_SHORT_PACKET    0x200\r
 \r
 //\r
 // Fill in the hardware link point: pass in a EHC_QH/QH_HW\r
@@ -102,7 +100,7 @@ typedef struct {
   UINT32                  Pid          : 2;\r
   UINT32                  ErrCnt       : 2;\r
   UINT32                  CurPage      : 3;\r
-  UINT32                  IOC          : 1;\r
+  UINT32                  Ioc          : 1;\r
   UINT32                  TotalBytes   : 15;\r
   UINT32                  DataToggle   : 1;\r
 \r
@@ -142,7 +140,7 @@ typedef struct {
   UINT32                  Pid          : 2;\r
   UINT32                  ErrCnt       : 2;\r
   UINT32                  CurPage      : 3;\r
-  UINT32                  IOC          : 1;\r
+  UINT32                  Ioc          : 1;\r
   UINT32                  TotalBytes   : 15;\r
   UINT32                  DataToggle   : 1;\r
 \r
@@ -244,7 +242,8 @@ struct _URB {
   Create a single QTD to hold the data.\r
 \r
   @param  Ehc        The EHCI device.\r
-  @param  Data       Current data not associated with a QTD.\r
+  @param  Data       The cpu memory address of current data not associated with a QTD.\r
+  @param  DataPhy    The pci bus address of current data not associated with a QTD.\r
   @param  DataLen    The length of the data.\r
   @param  PktId      Packet ID to use in the QTD.\r
   @param  Toggle     Data toggle to use in the QTD.\r
@@ -257,6 +256,7 @@ EHC_QTD *
 EhcCreateQtd (\r
   IN USB2_HC_DEV          *Ehc,\r
   IN UINT8                *Data,\r
+  IN UINT8                *DataPhy,\r
   IN UINTN                DataLen,\r
   IN UINT8                PktId,\r
   IN UINT8                Toggle,\r
@@ -287,8 +287,6 @@ EhcCreateQh (
   @param  Ehc        The EHCI device.\r
   @param  Urb        The URB to free.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EhcFreeUrb (\r