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