[Description]:
[people/mcb30/edk2.git] / edk2 / MdeModulePkg / Bus / Usb / UsbMassStorageDxe / UsbMass.h
1 /** @file\r
2 \r
3 Copyright (c) 2007 - 2008, Intel Corporation\r
4 All rights reserved. This program and the accompanying materials\r
5 are licensed and made available under the terms and conditions of the BSD License\r
6 which accompanies this distribution.  The full text of the license may be found at\r
7 http://opensource.org/licenses/bsd-license.php\r
8 \r
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11 \r
12 Module Name:\r
13 \r
14   UsbMass.h\r
15 \r
16 Abstract:\r
17 \r
18   Defination for the USB mass storage class driver. The USB mass storage\r
19   class is specified in two layers: the bottom layer is the transportation\r
20   protocol. The top layer is the command set. The transportation layer\r
21   provides the transportation of the command, data and result. The command\r
22   set defines what the command, data and result. The Bulk-Only-Transport and\r
23   Control/Bulk/Interrupt transport are two transportation protocol. USB mass\r
24   storage class adopts various industrial standard as its command set.\r
25 \r
26 Revision History\r
27 \r
28 \r
29 **/\r
30 \r
31 #ifndef _EFI_USBMASS_H_\r
32 #define _EFI_USBMASS_H_\r
33 \r
34 \r
35 #include <PiDxe.h>\r
36 \r
37 #include <Protocol/BlockIo.h>\r
38 #include <Protocol/UsbIo.h>\r
39 #include <Protocol/DevicePath.h>\r
40 \r
41 #include <Library/DebugLib.h>\r
42 #include <Library/BaseMemoryLib.h>\r
43 #include <Library/UefiDriverEntryPoint.h>\r
44 #include <Library/UefiBootServicesTableLib.h>\r
45 #include <Library/UefiLib.h>\r
46 #include <Library/MemoryAllocationLib.h>\r
47 #include <Library/DevicePathLib.h>\r
48 \r
49 #define USB_IS_IN_ENDPOINT(EndPointAddr)      (((EndPointAddr) & 0x80) == 0x80)\r
50 #define USB_IS_OUT_ENDPOINT(EndPointAddr)     (((EndPointAddr) & 0x80) == 0)\r
51 #define USB_IS_BULK_ENDPOINT(Attribute)       (((Attribute) & 0x03) == 0x02)\r
52 #define USB_IS_INTERRUPT_ENDPOINT(Attribute)  (((Attribute) & 0x03) == 0x03)\r
53 #define USB_IS_ERROR(Result, Error)           (((Result) & (Error)) != 0)\r
54 \r
55 enum {\r
56   //\r
57   // Usb mass storage class code\r
58   //\r
59   USB_MASS_STORE_CLASS    = 0x08,\r
60 \r
61   //\r
62   // Usb mass storage subclass code, specify the command set used.\r
63   //\r
64   USB_MASS_STORE_RBC      = 0x01, // Reduced Block Commands\r
65   USB_MASS_STORE_8020I    = 0x02, // SFF-8020i, typically a CD/DVD device\r
66   USB_MASS_STORE_QIC      = 0x03, // Typically a tape device\r
67   USB_MASS_STORE_UFI      = 0x04, // Typically a floppy disk driver device\r
68   USB_MASS_STORE_8070I    = 0x05, // SFF-8070i, typically a floppy disk driver device.\r
69   USB_MASS_STORE_SCSI     = 0x06, // SCSI transparent command set\r
70 \r
71   //\r
72   // Usb mass storage protocol code, specify the transport protocol\r
73   //\r
74   USB_MASS_STORE_CBI0     = 0x00, // CBI protocol with command completion interrupt\r
75   USB_MASS_STORE_CBI1     = 0x01, // CBI protocol without command completion interrupt\r
76   USB_MASS_STORE_BOT      = 0x50, // Bulk-Only Transport\r
77 \r
78   USB_MASS_1_MILLISECOND  = 1000,\r
79   USB_MASS_1_SECOND       = 1000 * USB_MASS_1_MILLISECOND,\r
80 \r
81   USB_MASS_CMD_SUCCESS    = 0,\r
82   USB_MASS_CMD_FAIL,\r
83   USB_MASS_CMD_PERSISTENT\r
84 };\r
85 \r
86 typedef\r
87 EFI_STATUS\r
88 (*USB_MASS_INIT_TRANSPORT) (\r
89   IN  EFI_USB_IO_PROTOCOL     *Usb,\r
90   OUT VOID                    **Context    OPTIONAL\r
91   );\r
92 \r
93 typedef\r
94 EFI_STATUS\r
95 (*USB_MASS_EXEC_COMMAND) (\r
96   IN  VOID                    *Context,\r
97   IN  VOID                    *Cmd,\r
98   IN  UINT8                   CmdLen,\r
99   IN  EFI_USB_DATA_DIRECTION  DataDir,\r
100   IN  VOID                    *Data,\r
101   IN  UINT32                  DataLen,\r
102   IN  UINT8                   Lun,\r
103   IN  UINT32                  Timeout,\r
104   OUT UINT32                  *CmdStatus\r
105   );\r
106 \r
107 typedef\r
108 EFI_STATUS\r
109 (*USB_MASS_RESET) (\r
110   IN  VOID                    *Context,\r
111   IN  BOOLEAN                 ExtendedVerification\r
112   );\r
113 \r
114 typedef\r
115 EFI_STATUS\r
116 (*USB_MASS_GET_MAX_LUN) (\r
117   IN  VOID                    *Context,\r
118   IN  UINT8                   *MaxLun\r
119   );\r
120 \r
121 typedef\r
122 EFI_STATUS\r
123 (*USB_MASS_FINI) (\r
124   IN  VOID                    *Context\r
125   );\r
126 \r
127 //\r
128 // This structure contains information necessary to select the\r
129 // proper transport protocol. The mass storage class defines\r
130 // two transport protocols. One is the CBI, and the other is BOT.\r
131 // CBI is being obseleted. The design is made modular by this\r
132 // structure so that the CBI protocol can be easily removed when\r
133 // it is no longer necessary.\r
134 //\r
135 typedef struct {\r
136   UINT8                   Protocol;\r
137   USB_MASS_INIT_TRANSPORT Init;        // Initialize the mass storage transport protocol\r
138   USB_MASS_EXEC_COMMAND   ExecCommand; // Transport command to the device then get result\r
139   USB_MASS_RESET          Reset;       // Reset the device\r
140   USB_MASS_GET_MAX_LUN    GetMaxLun;   // Get max lun, only for bot\r
141   USB_MASS_FINI           Fini;        // Clean up the resources.\r
142 } USB_MASS_TRANSPORT;\r
143 \r
144 \r
145 EFI_STATUS\r
146 UsbClearEndpointStall (\r
147   IN EFI_USB_IO_PROTOCOL      *UsbIo,\r
148   IN UINT8                    EndpointAddress\r
149   );\r
150 \r
151 #endif\r