]>
Commit | Line | Data |
---|---|---|
558be455 RN |
1 | /** @file\r |
2 | The header file for ISA driver\r | |
0a6f4824 LG |
3 | \r |
4 | Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
558be455 RN |
5 | This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _ISA_DRIVER_H_\r | |
16 | #define _ISA_DRIVER_H_\r | |
17 | \r | |
18 | \r | |
19 | #include <Uefi.h>\r | |
20 | \r | |
21 | #include <Protocol/PciIo.h>\r | |
22 | #include <Protocol/SuperIo.h>\r | |
23 | #include <Protocol/ComponentName.h>\r | |
24 | #include <Protocol/IsaIo.h>\r | |
25 | #include <Protocol/DevicePath.h>\r | |
26 | #include <Protocol/DriverBinding.h>\r | |
558be455 RN |
27 | #include <Guid/StatusCodeDataTypeId.h>\r |
28 | \r | |
29 | #include <Library/DebugLib.h>\r | |
30 | #include <Library/UefiDriverEntryPoint.h>\r | |
31 | #include <Library/UefiLib.h>\r | |
32 | #include <Library/DevicePathLib.h>\r | |
33 | #include <Library/BaseMemoryLib.h>\r | |
34 | #include <Library/MemoryAllocationLib.h>\r | |
35 | #include <Library/UefiBootServicesTableLib.h>\r | |
36 | #include <Library/ReportStatusCodeLib.h>\r | |
37 | #include <Library/PcdLib.h>\r | |
38 | #include <IndustryStandard/Acpi.h>\r | |
39 | \r | |
40 | #include "ComponentName.h"\r | |
41 | \r | |
42 | //\r | |
43 | // 8237 DMA registers\r | |
44 | //\r | |
45 | #define R_8237_DMA_BASE_CA_CH0 0x00\r | |
46 | #define R_8237_DMA_BASE_CA_CH1 0x02\r | |
47 | #define R_8237_DMA_BASE_CA_CH2 0x04\r | |
48 | #define R_8237_DMA_BASE_CA_CH3 0xd6\r | |
49 | #define R_8237_DMA_BASE_CA_CH5 0xc4\r | |
50 | #define R_8237_DMA_BASE_CA_CH6 0xc8\r | |
51 | #define R_8237_DMA_BASE_CA_CH7 0xcc\r | |
52 | \r | |
53 | #define R_8237_DMA_BASE_CC_CH0 0x01\r | |
54 | #define R_8237_DMA_BASE_CC_CH1 0x03\r | |
55 | #define R_8237_DMA_BASE_CC_CH2 0x05\r | |
56 | #define R_8237_DMA_BASE_CC_CH3 0xd7\r | |
57 | #define R_8237_DMA_BASE_CC_CH5 0xc6\r | |
58 | #define R_8237_DMA_BASE_CC_CH6 0xca\r | |
59 | #define R_8237_DMA_BASE_CC_CH7 0xce\r | |
60 | \r | |
61 | #define R_8237_DMA_MEM_LP_CH0 0x87\r | |
62 | #define R_8237_DMA_MEM_LP_CH1 0x83\r | |
63 | #define R_8237_DMA_MEM_LP_CH2 0x81\r | |
64 | #define R_8237_DMA_MEM_LP_CH3 0x82\r | |
65 | #define R_8237_DMA_MEM_LP_CH5 0x8B\r | |
66 | #define R_8237_DMA_MEM_LP_CH6 0x89\r | |
67 | #define R_8237_DMA_MEM_LP_CH7 0x8A\r | |
68 | \r | |
69 | \r | |
70 | #define R_8237_DMA_COMMAND_CH0_3 0x08\r | |
71 | #define R_8237_DMA_COMMAND_CH4_7 0xd0\r | |
72 | #define B_8237_DMA_COMMAND_GAP 0x10\r | |
73 | #define B_8237_DMA_COMMAND_CGE 0x04\r | |
74 | \r | |
75 | \r | |
76 | #define R_8237_DMA_STA_CH0_3 0xd8\r | |
77 | #define R_8237_DMA_STA_CH4_7 0xd0\r | |
78 | \r | |
79 | #define R_8237_DMA_WRSMSK_CH0_3 0x0a\r | |
80 | #define R_8237_DMA_WRSMSK_CH4_7 0xd4\r | |
81 | #define B_8237_DMA_WRSMSK_CMS 0x04\r | |
82 | \r | |
83 | \r | |
84 | #define R_8237_DMA_CHMODE_CH0_3 0x0b\r | |
85 | #define R_8237_DMA_CHMODE_CH4_7 0xd6\r | |
86 | #define V_8237_DMA_CHMODE_DEMAND 0x00\r | |
87 | #define V_8237_DMA_CHMODE_SINGLE 0x40\r | |
88 | #define V_8237_DMA_CHMODE_CASCADE 0xc0\r | |
89 | #define B_8237_DMA_CHMODE_DECREMENT 0x20\r | |
90 | #define B_8237_DMA_CHMODE_INCREMENT 0x00\r | |
91 | #define B_8237_DMA_CHMODE_AE 0x10\r | |
92 | #define V_8237_DMA_CHMODE_VERIFY 0\r | |
93 | #define V_8237_DMA_CHMODE_IO2MEM 0x04\r | |
94 | #define V_8237_DMA_CHMODE_MEM2IO 0x08\r | |
95 | \r | |
96 | #define R_8237_DMA_CBPR_CH0_3 0x0c\r | |
97 | #define R_8237_DMA_CBPR_CH4_7 0xd8\r | |
98 | \r | |
99 | #define R_8237_DMA_MCR_CH0_3 0x0d\r | |
100 | #define R_8237_DMA_MCR_CH4_7 0xda\r | |
101 | \r | |
102 | #define R_8237_DMA_CLMSK_CH0_3 0x0e\r | |
103 | #define R_8237_DMA_CLMSK_CH4_7 0xdc\r | |
104 | \r | |
105 | #define R_8237_DMA_WRMSK_CH0_3 0x0f\r | |
106 | #define R_8237_DMA_WRMSK_CH4_7 0xde\r | |
107 | \r | |
108 | typedef enum {\r | |
109 | IsaAccessTypeUnknown,\r | |
110 | IsaAccessTypeIo,\r | |
111 | IsaAccessTypeMem,\r | |
112 | IsaAccessTypeMaxType\r | |
113 | } ISA_ACCESS_TYPE;\r | |
114 | \r | |
115 | typedef struct {\r | |
116 | UINT8 Address;\r | |
117 | UINT8 Page;\r | |
118 | UINT8 Count;\r | |
119 | } EFI_ISA_DMA_REGISTERS;\r | |
120 | \r | |
121 | //\r | |
122 | // ISA I/O Device Structure\r | |
123 | //\r | |
124 | #define ISA_IO_DEVICE_SIGNATURE SIGNATURE_32 ('i', 's', 'a', 'i')\r | |
125 | \r | |
126 | typedef struct {\r | |
127 | UINT32 Signature;\r | |
128 | EFI_HANDLE Handle;\r | |
129 | EFI_ISA_IO_PROTOCOL IsaIo;\r | |
130 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
131 | } ISA_IO_DEVICE;\r | |
132 | \r | |
133 | #define ISA_IO_DEVICE_FROM_ISA_IO_THIS(a) CR (a, ISA_IO_DEVICE, IsaIo, ISA_IO_DEVICE_SIGNATURE)\r | |
134 | \r | |
135 | //\r | |
136 | // Mapping structure for performing ISA DMA to a buffer above 16 MB\r | |
137 | //\r | |
138 | typedef struct {\r | |
139 | EFI_ISA_IO_PROTOCOL_OPERATION Operation;\r | |
140 | UINTN NumberOfBytes;\r | |
141 | UINTN NumberOfPages;\r | |
142 | EFI_PHYSICAL_ADDRESS HostAddress;\r | |
143 | EFI_PHYSICAL_ADDRESS MappedHostAddress;\r | |
144 | } ISA_MAP_INFO;\r | |
145 | \r | |
146 | //\r | |
147 | // EFI Driver Binding Protocol Interface Functions\r | |
148 | //\r | |
149 | \r | |
0a6f4824 | 150 | /**\r |
558be455 RN |
151 | Tests to see if a controller can be managed by the ISA Driver.\r |
152 | \r | |
153 | How the Start() function of a driver is implemented can affect how the Supported() function is implemented.\r | |
154 | \r | |
0a6f4824 | 155 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r |
558be455 RN |
156 | @param[in] Controller The handle of the controller to test.\r |
157 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path.\r | |
0a6f4824 | 158 | \r |
558be455 RN |
159 | @retval EFI_SUCCESS The device is supported by this driver.\r |
160 | @retval EFI_ALREADY_STARTED The device is already being managed by this driver.\r | |
0a6f4824 | 161 | @retval EFI_ACCESS_DENIED The device is already being managed by a different driver\r |
558be455 RN |
162 | or an application that requires exclusive access.\r |
163 | @retval EFI_UNSUPPORTED The device is is not supported by this driver.\r | |
164 | \r | |
165 | **/\r | |
166 | EFI_STATUS\r | |
167 | EFIAPI\r | |
168 | IsaIoDriverSupported (\r | |
169 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
170 | IN EFI_HANDLE Controller,\r | |
171 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
172 | );\r | |
173 | \r | |
174 | /**\r | |
0a6f4824 LG |
175 | Start this driver on ControllerHandle.\r |
176 | \r | |
177 | The Start() function is designed to be invoked from the EFI boot service ConnectController().\r | |
178 | As a result, much of the error checking on the parameters to Start() has been moved into this\r | |
179 | common boot service. It is legal to call Start() from other locations, but the following calling\r | |
558be455 RN |
180 | restrictions must be followed or the system behavior will not be deterministic.\r |
181 | 1. ControllerHandle must be a valid EFI_HANDLE.\r | |
182 | 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r | |
183 | EFI_DEVICE_PATH_PROTOCOL.\r | |
184 | 3. Prior to calling Start(), the Supported() function for the driver specified by This must\r | |
0a6f4824 | 185 | have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r |
558be455 RN |
186 | \r |
187 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r | |
0a6f4824 LG |
188 | @param[in] ControllerHandle The handle of the controller to start. This handle\r |
189 | must support a protocol interface that supplies\r | |
558be455 | 190 | an I/O abstraction to the driver.\r |
0a6f4824 | 191 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path.\r |
558be455 RN |
192 | This parameter is ignored by device drivers, and is optional for bus drivers.\r |
193 | \r | |
194 | @retval EFI_SUCCESS The device was started.\r | |
195 | @retval EFI_DEVICE_ERROR The device could not be started due to a device error.\r | |
196 | Currently not implemented.\r | |
197 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
198 | @retval Others The driver failded to start the device.\r | |
199 | **/\r | |
200 | EFI_STATUS\r | |
201 | EFIAPI\r | |
202 | IsaIoDriverStart (\r | |
203 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
204 | IN EFI_HANDLE Controller,\r | |
205 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
206 | );\r | |
207 | \r | |
208 | /**\r | |
0a6f4824 LG |
209 | Stop this driver on ControllerHandle.\r |
210 | \r | |
211 | The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r | |
212 | As a result, much of the error checking on the parameters to Stop() has been moved\r | |
213 | into this common boot service. It is legal to call Stop() from other locations,\r | |
558be455 RN |
214 | but the following calling restrictions must be followed or the system behavior will not be deterministic.\r |
215 | 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r | |
216 | same driver's Start() function.\r | |
217 | 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r | |
218 | EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r | |
219 | Start() function, and the Start() function must have called OpenProtocol() on\r | |
220 | ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r | |
0a6f4824 | 221 | \r |
558be455 | 222 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r |
0a6f4824 LG |
223 | @param[in] ControllerHandle A handle to the device being stopped. The handle must\r |
224 | support a bus specific I/O protocol for the driver\r | |
558be455 RN |
225 | to use to stop the device.\r |
226 | @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r | |
0a6f4824 | 227 | @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r |
558be455 RN |
228 | if NumberOfChildren is 0.\r |
229 | \r | |
230 | @retval EFI_SUCCESS The device was stopped.\r | |
231 | @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r | |
232 | **/\r | |
233 | EFI_STATUS\r | |
234 | EFIAPI\r | |
235 | IsaIoDriverStop (\r | |
236 | IN EFI_DRIVER_BINDING_PROTOCOL * This,\r | |
237 | IN EFI_HANDLE Controller,\r | |
238 | IN UINTN NumberOfChildren,\r | |
239 | IN EFI_HANDLE * ChildHandleBuffer OPTIONAL\r | |
240 | );\r | |
241 | \r | |
242 | //\r | |
243 | // Function Prototypes\r | |
244 | //\r | |
245 | \r | |
246 | /**\r | |
247 | Initializes an ISA I/O Instance\r | |
248 | \r | |
249 | @param[in] IsaIoDevice The isa device to be initialized.\r | |
250 | @param[in] DevicePath The device path of the isa device.\r | |
251 | @param[in] Resources The ACPI resource list.\r | |
0a6f4824 | 252 | \r |
558be455 RN |
253 | **/\r |
254 | VOID\r | |
255 | InitializeIsaIoInstance (\r | |
256 | IN ISA_IO_DEVICE *IsaIoDevice,\r | |
257 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
258 | IN ACPI_RESOURCE_HEADER_PTR Resources\r | |
259 | );\r | |
260 | \r | |
261 | #endif\r | |
262 | \r |