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