]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
Enhance IdeBusDxe to check the class code for IDE mode only.
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / IdeBusDxe / IdeBus.c
CommitLineData
563c9c8a 1/** @file\r
630d580d 2 This file implement UEFI driver for IDE Bus which includes device identification, \r
3 Child device(Disk, CDROM, etc) enumeration and child handler installation, and \r
563c9c8a 4 driver stop.\r
630d580d 5 \r
180a5a35
HT
6 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
7 This program and the accompanying materials\r
563c9c8a 8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php\r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15 @par Revision Reference:\r
16 This module is modified from DXE\IDE module for Ide Contriller Init support\r
17\r
18**/\r
19\r
20#include "IdeBus.h"\r
21\r
22#define PCI_CLASS_MASS_STORAGE 0x01\r
23#define PCI_SUB_CLASS_IDE 0x01\r
24\r
25\r
26//\r
27// IDE Bus Driver Binding Protocol Instance\r
28//\r
29EFI_DRIVER_BINDING_PROTOCOL gIDEBusDriverBinding = {\r
30 IDEBusDriverBindingSupported,\r
31 IDEBusDriverBindingStart,\r
32 IDEBusDriverBindingStop,\r
33 0xa,\r
34 NULL,\r
35 NULL\r
36};\r
37/**\r
38 Deregister an IDE device and free resources\r
39\r
40 @param This Protocol instance pointer.\r
41 @param Controller Ide device handle\r
42 @param Handle Handle of device to deregister driver on\r
43\r
44 @retval EFI_SUCCESS Deregiter a specific IDE device successfully\r
45\r
46\r
47**/\r
48EFI_STATUS\r
49DeRegisterIdeDevice (\r
50 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
51 IN EFI_HANDLE Controller,\r
52 IN EFI_HANDLE Handle\r
53 )\r
54{\r
55 EFI_STATUS Status;\r
56 EFI_BLOCK_IO_PROTOCOL *BlkIo;\r
57 IDE_BLK_IO_DEV *IdeBlkIoDevice;\r
58 EFI_PCI_IO_PROTOCOL *PciIo;\r
59 UINTN Index;\r
60\r
61 Status = gBS->OpenProtocol (\r
62 Handle,\r
63 &gEfiBlockIoProtocolGuid,\r
64 (VOID **) &BlkIo,\r
65 This->DriverBindingHandle,\r
66 Controller,\r
67 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
68 );\r
69 if (EFI_ERROR (Status)) {\r
70 return Status;\r
71 }\r
72\r
73 IdeBlkIoDevice = IDE_BLOCK_IO_DEV_FROM_THIS (BlkIo);\r
74\r
75 //\r
76 // Report Status code: Device disabled\r
77 //\r
78 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
79 EFI_PROGRESS_CODE,\r
80 (EFI_IO_BUS_ATA_ATAPI | EFI_P_PC_DISABLE),\r
81 IdeBlkIoDevice->DevicePath\r
82 );\r
83\r
84 //\r
85 // Close the child handle\r
86 //\r
87 Status = gBS->CloseProtocol (\r
88 Controller,\r
89 &gEfiPciIoProtocolGuid,\r
90 This->DriverBindingHandle,\r
91 Handle\r
92 );\r
93\r
94 Status = gBS->UninstallMultipleProtocolInterfaces (\r
95 Handle,\r
96 &gEfiDevicePathProtocolGuid,\r
97 IdeBlkIoDevice->DevicePath,\r
98 &gEfiBlockIoProtocolGuid,\r
99 &IdeBlkIoDevice->BlkIo,\r
100 &gEfiDiskInfoProtocolGuid,\r
101 &IdeBlkIoDevice->DiskInfo,\r
102 NULL\r
103 );\r
104\r
105 if (EFI_ERROR (Status)) {\r
106 gBS->OpenProtocol (\r
107 Controller,\r
108 &gEfiPciIoProtocolGuid,\r
109 (VOID **) &PciIo,\r
110 This->DriverBindingHandle,\r
111 Handle,\r
112 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
113 );\r
114 return Status;\r
115 }\r
116\r
117 //\r
118 // Release allocated resources\r
119 //\r
120 Index = IdeBlkIoDevice->Channel * 2 + IdeBlkIoDevice->Device;\r
121 if (Index < MAX_IDE_DEVICE) {\r
122 IdeBlkIoDevice->IdeBusDriverPrivateData->HaveScannedDevice[Index] = FALSE;\r
123 }\r
124 ReleaseIdeResources (IdeBlkIoDevice);\r
125\r
126 return EFI_SUCCESS;\r
127}\r
128/**\r
129 Supported function of Driver Binding protocol for this driver.\r
130\r
131 @param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
132 @param ControllerHandle The handle of the controller to test.\r
133 @param RemainingDevicePath A pointer to the remaining portion of a device path.\r
134\r
135 @retval EFI_SUCCESS Driver loaded.\r
136 @retval other Driver not loaded.\r
137\r
138**/\r
139EFI_STATUS\r
140EFIAPI\r
141IDEBusDriverBindingSupported (\r
142 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
143 IN EFI_HANDLE Controller,\r
144 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
145 )\r
146{\r
147 EFI_STATUS Status;\r
148 EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
149 EFI_DEV_PATH *Node;\r
150 EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeInit;\r
e519401b
SZ
151 EFI_PCI_IO_PROTOCOL *PciIo;\r
152 PCI_TYPE00 PciData;\r
563c9c8a 153\r
154 if (RemainingDevicePath != NULL) {\r
155 Node = (EFI_DEV_PATH *) RemainingDevicePath;\r
2277ab96 156 //\r
157 // Check if RemainingDevicePath is the End of Device Path Node, \r
158 // if yes, go on checking other conditions\r
159 //\r
160 if (!IsDevicePathEnd (Node)) {\r
161 //\r
162 // If RemainingDevicePath isn't the End of Device Path Node,\r
163 // check its validation\r
164 //\r
165 if (Node->DevPath.Type != MESSAGING_DEVICE_PATH ||\r
166 Node->DevPath.SubType != MSG_ATAPI_DP ||\r
167 DevicePathNodeLength(&Node->DevPath) != sizeof(ATAPI_DEVICE_PATH)) {\r
168 return EFI_UNSUPPORTED;\r
169 }\r
563c9c8a 170 }\r
171 }\r
172\r
173 //\r
2277ab96 174 // Verify the Ide Controller Init Protocol, which installed by the\r
175 // IdeController module.\r
563c9c8a 176 //\r
177 Status = gBS->OpenProtocol (\r
178 Controller,\r
2277ab96 179 &gEfiIdeControllerInitProtocolGuid,\r
180 (VOID **) &IdeInit,\r
563c9c8a 181 This->DriverBindingHandle,\r
182 Controller,\r
183 EFI_OPEN_PROTOCOL_BY_DRIVER\r
184 );\r
2277ab96 185\r
563c9c8a 186 if (Status == EFI_ALREADY_STARTED) {\r
187 return EFI_SUCCESS;\r
188 }\r
189\r
9d0ece87 190 if (EFI_ERROR (Status)) {\r
191 return Status;\r
192 }\r
193 \r
563c9c8a 194 //\r
af4a6385 195 // Close the I/O Abstraction(s) used to perform the supported test\r
563c9c8a 196 //\r
197 gBS->CloseProtocol (\r
198 Controller,\r
2277ab96 199 &gEfiIdeControllerInitProtocolGuid,\r
563c9c8a 200 This->DriverBindingHandle,\r
201 Controller\r
202 );\r
203\r
204 //\r
2277ab96 205 // Open the EFI Device Path protocol needed to perform the supported test\r
563c9c8a 206 //\r
207 Status = gBS->OpenProtocol (\r
208 Controller,\r
2277ab96 209 &gEfiDevicePathProtocolGuid,\r
210 (VOID **) &ParentDevicePath,\r
563c9c8a 211 This->DriverBindingHandle,\r
212 Controller,\r
213 EFI_OPEN_PROTOCOL_BY_DRIVER\r
214 );\r
563c9c8a 215 if (Status == EFI_ALREADY_STARTED) {\r
216 return EFI_SUCCESS;\r
217 }\r
218\r
219 //\r
2277ab96 220 // Close protocol, don't use device path protocol in the Support() function\r
563c9c8a 221 //\r
222 gBS->CloseProtocol (\r
223 Controller,\r
2277ab96 224 &gEfiDevicePathProtocolGuid,\r
563c9c8a 225 This->DriverBindingHandle,\r
226 Controller\r
227 );\r
228\r
e519401b
SZ
229 //\r
230 // Get the EfiPciIoProtocol\r
231 //\r
232 Status = gBS->OpenProtocol (\r
233 Controller,\r
234 &gEfiPciIoProtocolGuid,\r
235 (VOID **) &PciIo,\r
236 This->DriverBindingHandle,\r
237 Controller,\r
238 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
239 );\r
240 \r
241 if (EFI_ERROR (Status)) {\r
242 return Status;\r
243 }\r
244 \r
245 //\r
246 // Now further check the PCI header: Base class (offset 0x0B) and\r
247 // Sub Class (offset 0x0A). This controller should be an IDE controller\r
248 //\r
249 Status = PciIo->Pci.Read (\r
250 PciIo,\r
251 EfiPciIoWidthUint8,\r
252 0,\r
253 sizeof (PciData),\r
254 &PciData\r
255 );\r
256\r
257 if (!EFI_ERROR (Status)) {\r
258 //\r
259 // Examine if it is IDE mode by class code\r
260 //\r
261 if ((PciData.Hdr.ClassCode[2] != PCI_CLASS_MASS_STORAGE) || (PciData.Hdr.ClassCode[1] != PCI_SUB_CLASS_IDE)) { \r
262 Status = EFI_UNSUPPORTED;\r
263 } else { \r
264 Status = EFI_SUCCESS;\r
265 } \r
266 }\r
267\r
563c9c8a 268 return Status;\r
269}\r
270\r
271\r
272/**\r
273 Start function of Driver binding protocol which start this driver on Controller\r
274 by detecting all disks and installing BlockIo protocol on them.\r
275\r
276 @param This Protocol instance pointer.\r
277 @param Controller Handle of device to bind driver to.\r
278 @param RemainingDevicePath produce all possible children.\r
279\r
280 @retval EFI_SUCCESS This driver is added to ControllerHandle.\r
281 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.\r
282 @retval other This driver does not support this device.\r
283\r
284**/\r
285EFI_STATUS\r
286EFIAPI\r
287IDEBusDriverBindingStart (\r
288 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
289 IN EFI_HANDLE Controller,\r
290 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
291 )\r
292{\r
293 EFI_STATUS Status;\r
294 EFI_STATUS SavedStatus;\r
295 EFI_PCI_IO_PROTOCOL *PciIo;\r
296 EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
297 EFI_DEV_PATH *Node;\r
298 UINT8 IdeChannel;\r
299 UINT8 BeginningIdeChannel;\r
300 UINT8 EndIdeChannel;\r
301 UINT8 IdeDevice;\r
302 UINT8 BeginningIdeDevice;\r
303 UINT8 EndIdeDevice;\r
304 IDE_BLK_IO_DEV *IdeBlkIoDevice[IdeMaxChannel][IdeMaxDevice];\r
305 IDE_BLK_IO_DEV *IdeBlkIoDevicePtr;\r
306 IDE_REGISTERS_BASE_ADDR IdeRegsBaseAddr[IdeMaxChannel];\r
307 ATA_TRANSFER_MODE TransferMode;\r
308 ATA_DRIVE_PARMS DriveParameters;\r
309 EFI_DEV_PATH NewNode;\r
310 UINT8 ConfigurationOptions;\r
311 UINT16 CommandBlockBaseAddr;\r
312 UINT16 ControlBlockBaseAddr;\r
313 UINTN DataSize;\r
314 IDE_BUS_DRIVER_PRIVATE_DATA *IdeBusDriverPrivateData;\r
315 UINT64 Supports;\r
316\r
317 //\r
318 // Local variables declaration for IdeControllerInit support\r
319 //\r
320 EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeInit;\r
321 BOOLEAN EnumAll;\r
322 BOOLEAN ChannelEnabled;\r
323 UINT8 MaxDevices;\r
324 EFI_IDENTIFY_DATA IdentifyData;\r
325 EFI_ATA_COLLECTIVE_MODE *SupportedModes;\r
326\r
327 IdeBusDriverPrivateData = NULL;\r
328 SupportedModes = NULL;\r
329\r
330 //\r
331 // Perform IdeBus initialization\r
332 //\r
333 Status = gBS->OpenProtocol (\r
334 Controller,\r
335 &gEfiDevicePathProtocolGuid,\r
336 (VOID **) &ParentDevicePath,\r
337 This->DriverBindingHandle,\r
338 Controller,\r
339 EFI_OPEN_PROTOCOL_BY_DRIVER\r
340 );\r
341 if ((EFI_ERROR (Status)) && (Status != EFI_ALREADY_STARTED)) {\r
342 return Status;\r
343 }\r
344\r
345 //\r
346 // Now open the IDE_CONTROLLER_INIT protocol. Step7.1\r
347 //\r
348 Status = gBS->OpenProtocol (\r
349 Controller,\r
350 &gEfiIdeControllerInitProtocolGuid,\r
351 (VOID **) &IdeInit,\r
352 This->DriverBindingHandle,\r
353 Controller,\r
354 EFI_OPEN_PROTOCOL_BY_DRIVER\r
355 );\r
356\r
357 //\r
358 // The following OpenProtocol function with _GET_PROTOCOL attribute and\r
359 // will not return EFI_ALREADY_STARTED, so save it for now\r
360 //\r
361 SavedStatus = Status;\r
362\r
363 if ((EFI_ERROR (Status)) && (Status != EFI_ALREADY_STARTED)) {\r
364 DEBUG ((EFI_D_ERROR, "Open Init, Status=%x", Status));\r
365 //\r
366 // open protocol is not SUCCESS or not ALREADY_STARTED, error exit\r
367 //\r
368 goto ErrorExit;\r
369 }\r
370\r
371 //\r
372 // Save Enumall. Step7.2\r
373 //\r
374 EnumAll = IdeInit->EnumAll;\r
375\r
376 //\r
377 // Consume PCI I/O protocol. Note that the OpenProtocol with _GET_PROTOCOL\r
378 // attribute will not return EFI_ALREADY_STARTED\r
379 //\r
380 Status = gBS->OpenProtocol (\r
381 Controller,\r
382 &gEfiPciIoProtocolGuid,\r
383 (VOID **) &PciIo,\r
384 This->DriverBindingHandle,\r
385 Controller,\r
386 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
387 );\r
388 if (EFI_ERROR (Status)) {\r
389 DEBUG ((EFI_D_ERROR, "Open PciIo, Status=%x", Status));\r
390 goto ErrorExit;\r
391 }\r
392\r
393 //\r
394 // We must check EFI_ALREADY_STARTED because many ATAPI devices are removable\r
395 //\r
396 if (SavedStatus != EFI_ALREADY_STARTED) {\r
397 IdeBusDriverPrivateData = AllocatePool (sizeof (IDE_BUS_DRIVER_PRIVATE_DATA));\r
398 if (IdeBusDriverPrivateData == NULL) {\r
399 Status = EFI_OUT_OF_RESOURCES;\r
400 goto ErrorExit;\r
401 }\r
402\r
403 ZeroMem (IdeBusDriverPrivateData, sizeof (IDE_BUS_DRIVER_PRIVATE_DATA));\r
404 Status = gBS->InstallMultipleProtocolInterfaces (\r
405 &Controller,\r
406 &gEfiCallerIdGuid,\r
407 IdeBusDriverPrivateData,\r
408 NULL\r
409 );\r
410 if (EFI_ERROR (Status)) {\r
411 goto ErrorExit;\r
412 }\r
413\r
414 } else {\r
415 Status = gBS->OpenProtocol (\r
416 Controller,\r
417 &gEfiCallerIdGuid,\r
418 (VOID **) &IdeBusDriverPrivateData,\r
419 This->DriverBindingHandle,\r
420 Controller,\r
421 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
422 );\r
423 if (EFI_ERROR (Status)) {\r
424 IdeBusDriverPrivateData = NULL;\r
425 goto ErrorExit;\r
426 }\r
427 }\r
428\r
429 Status = PciIo->Attributes (\r
430 PciIo,\r
431 EfiPciIoAttributeOperationSupported,\r
432 0,\r
433 &Supports\r
434 );\r
435 if (!EFI_ERROR (Status)) {\r
436 Supports &= EFI_PCI_DEVICE_ENABLE;\r
437 Status = PciIo->Attributes (\r
438 PciIo,\r
439 EfiPciIoAttributeOperationEnable,\r
440 Supports,\r
441 NULL\r
442 );\r
443 }\r
444\r
445 if (EFI_ERROR (Status)) {\r
446 goto ErrorExit;\r
447 }\r
448\r
449 //\r
450 // Read the environment variable that contains the IDEBus Driver's\r
451 // Config options that were set by the Driver Configuration Protocol\r
452 //\r
453 DataSize = sizeof (ConfigurationOptions);\r
454 Status = gRT->GetVariable (\r
455 (CHAR16 *) L"Configuration",\r
456 &gEfiCallerIdGuid,\r
457 NULL,\r
458 &DataSize,\r
459 &ConfigurationOptions\r
460 );\r
461 if (EFI_ERROR (Status)) {\r
462 ConfigurationOptions = 0x0f;\r
463 }\r
464\r
2277ab96 465 if (EnumAll || RemainingDevicePath == NULL) {\r
563c9c8a 466 //\r
2277ab96 467 // If IdeInit->EnumAll is TRUE or RemainingDevicePath is NULL, \r
af4a6385 468 // must enumerate all IDE devices anyway\r
563c9c8a 469 //\r
470 BeginningIdeChannel = IdePrimary;\r
471 EndIdeChannel = IdeSecondary;\r
472 BeginningIdeDevice = IdeMaster;\r
473 EndIdeDevice = IdeSlave;\r
2277ab96 474\r
475 } else if (!IsDevicePathEnd (RemainingDevicePath)) {\r
563c9c8a 476 //\r
af4a6385 477 // If RemainingDevicePath isn't the End of Device Path Node, \r
478 // only scan the specified device by RemainingDevicePath\r
563c9c8a 479 //\r
480 Node = (EFI_DEV_PATH *) RemainingDevicePath;\r
481 BeginningIdeChannel = Node->Atapi.PrimarySecondary;\r
482 EndIdeChannel = BeginningIdeChannel;\r
483 BeginningIdeDevice = Node->Atapi.SlaveMaster;\r
484 EndIdeDevice = BeginningIdeDevice;\r
485 if (BeginningIdeChannel >= IdeMaxChannel || EndIdeChannel >= IdeMaxChannel) {\r
486 Status = EFI_INVALID_PARAMETER;\r
487 goto ErrorExit;\r
488 }\r
489 if (BeginningIdeDevice >= IdeMaxDevice|| EndIdeDevice >= IdeMaxDevice) {\r
490 Status = EFI_INVALID_PARAMETER;\r
491 goto ErrorExit;\r
492 }\r
2277ab96 493\r
494 } else {\r
495 //\r
af4a6385 496 // If RemainingDevicePath is the End of Device Path Node,\r
2277ab96 497 // skip enumerate any device and return EFI_SUCESSS\r
498 // \r
499 BeginningIdeChannel = IdeMaxChannel;\r
500 EndIdeChannel = IdeMaxChannel - 1;\r
501 BeginningIdeDevice = IdeMaxDevice;\r
502 EndIdeDevice = IdeMaxDevice - 1;\r
563c9c8a 503 }\r
504\r
505 //\r
506 // Obtain IDE IO port registers' base addresses\r
507 //\r
508 Status = GetIdeRegistersBaseAddr (PciIo, IdeRegsBaseAddr);\r
509 if (EFI_ERROR (Status)) {\r
510 goto ErrorExit;\r
511 }\r
512\r
513 //\r
514 // Report status code: begin IdeBus initialization\r
515 //\r
516 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
517 EFI_PROGRESS_CODE,\r
518 (EFI_IO_BUS_ATA_ATAPI | EFI_IOB_PC_RESET),\r
519 ParentDevicePath\r
520 );\r
521\r
522 //\r
523 // Strictly follow the enumeration based on IDE_CONTROLLER_INIT protocol\r
524 //\r
525 for (IdeChannel = BeginningIdeChannel; IdeChannel <= EndIdeChannel; IdeChannel++) {\r
526\r
527 IdeInit->NotifyPhase (IdeInit, EfiIdeBeforeChannelEnumeration, IdeChannel);\r
528\r
529 //\r
530 // now obtain channel information fron IdeControllerInit protocol. Step9\r
531 //\r
532 Status = IdeInit->GetChannelInfo (\r
533 IdeInit,\r
534 IdeChannel,\r
535 &ChannelEnabled,\r
536 &MaxDevices\r
537 );\r
538 if (EFI_ERROR (Status)) {\r
539 DEBUG ((EFI_D_ERROR, "[GetChannel, Status=%x]", Status));\r
540 continue;\r
541 }\r
542\r
543 if (!ChannelEnabled) {\r
544 continue;\r
545 }\r
546\r
547 EndIdeDevice = (UINT8) MIN ((MaxDevices - 1), EndIdeDevice);\r
548 ASSERT (EndIdeDevice < IdeMaxDevice);\r
549 //\r
550 // Now inform the IDE Controller Init Module. Sept10\r
551 //\r
552 IdeInit->NotifyPhase (IdeInit, EfiIdeBeforeChannelReset, IdeChannel);\r
553\r
554 //\r
555 // No reset channel function implemented. Sept11\r
556 //\r
557 IdeInit->NotifyPhase (IdeInit, EfiIdeAfterChannelReset, IdeChannel);\r
558\r
559 //\r
560 // Step13\r
561 //\r
562 IdeInit->NotifyPhase (\r
563 IdeInit,\r
564 EfiIdeBusBeforeDevicePresenceDetection,\r
565 IdeChannel\r
566 );\r
567\r
568 //\r
569 // Prepare to detect IDE device of this channel\r
570 //\r
571 InitializeIDEChannelData ();\r
572\r
573 //\r
574 // -- 1st inner loop --- Master/Slave ------------ Step14\r
575 //\r
576 for (IdeDevice = BeginningIdeDevice; IdeDevice <= EndIdeDevice; IdeDevice++) {\r
577 //\r
578 // Check whether the configuration options allow this device\r
579 //\r
580 if ((ConfigurationOptions & (1 << (IdeChannel * 2 + IdeDevice))) == 0) {\r
581 continue;\r
582 }\r
583\r
584 //\r
585 // The device has been scanned in another Start(), No need to scan it again\r
586 // for perf optimization.\r
587 //\r
588 if (IdeBusDriverPrivateData->HaveScannedDevice[IdeChannel * 2 + IdeDevice]) {\r
589 continue;\r
590 }\r
591\r
592 //\r
593 // create child handle for the detected device.\r
594 //\r
595 IdeBlkIoDevice[IdeChannel][IdeDevice] = AllocatePool (sizeof (IDE_BLK_IO_DEV));\r
596 if (IdeBlkIoDevice[IdeChannel][IdeDevice] == NULL) {\r
597 continue;\r
598 }\r
599\r
600 IdeBlkIoDevicePtr = IdeBlkIoDevice[IdeChannel][IdeDevice];\r
601\r
602 ZeroMem (IdeBlkIoDevicePtr, sizeof (IDE_BLK_IO_DEV));\r
603\r
604 IdeBlkIoDevicePtr->Signature = IDE_BLK_IO_DEV_SIGNATURE;\r
605 IdeBlkIoDevicePtr->Channel = (EFI_IDE_CHANNEL) IdeChannel;\r
606 IdeBlkIoDevicePtr->Device = (EFI_IDE_DEVICE) IdeDevice;\r
607\r
608 //\r
609 // initialize Block IO interface's Media pointer\r
610 //\r
611 IdeBlkIoDevicePtr->BlkIo.Media = &IdeBlkIoDevicePtr->BlkMedia;\r
612\r
613 //\r
614 // Initialize IDE IO port addresses, including Command Block registers\r
615 // and Control Block registers\r
616 //\r
617 IdeBlkIoDevicePtr->IoPort = AllocatePool (sizeof (IDE_BASE_REGISTERS));\r
618 if (IdeBlkIoDevicePtr->IoPort == NULL) {\r
619 continue;\r
620 }\r
621\r
622 ZeroMem (IdeBlkIoDevicePtr->IoPort, sizeof (IDE_BASE_REGISTERS));\r
623 CommandBlockBaseAddr = IdeRegsBaseAddr[IdeChannel].CommandBlockBaseAddr;\r
624 ControlBlockBaseAddr = IdeRegsBaseAddr[IdeChannel].ControlBlockBaseAddr;\r
625\r
626 IdeBlkIoDevicePtr->IoPort->Data = CommandBlockBaseAddr;\r
627 (*(UINT16 *) &IdeBlkIoDevicePtr->IoPort->Reg1) = (UINT16) (CommandBlockBaseAddr + 0x01);\r
628 IdeBlkIoDevicePtr->IoPort->SectorCount = (UINT16) (CommandBlockBaseAddr + 0x02);\r
629 IdeBlkIoDevicePtr->IoPort->SectorNumber = (UINT16) (CommandBlockBaseAddr + 0x03);\r
630 IdeBlkIoDevicePtr->IoPort->CylinderLsb = (UINT16) (CommandBlockBaseAddr + 0x04);\r
631 IdeBlkIoDevicePtr->IoPort->CylinderMsb = (UINT16) (CommandBlockBaseAddr + 0x05);\r
632 IdeBlkIoDevicePtr->IoPort->Head = (UINT16) (CommandBlockBaseAddr + 0x06);\r
633 (*(UINT16 *) &IdeBlkIoDevicePtr->IoPort->Reg) = (UINT16) (CommandBlockBaseAddr + 0x07);\r
634\r
635 (*(UINT16 *) &IdeBlkIoDevicePtr->IoPort->Alt) = ControlBlockBaseAddr;\r
636 IdeBlkIoDevicePtr->IoPort->DriveAddress = (UINT16) (ControlBlockBaseAddr + 0x01);\r
637\r
638 IdeBlkIoDevicePtr->IoPort->MasterSlave = (UINT16) ((IdeDevice == IdeMaster) ? 1 : 0);\r
639\r
640 IdeBlkIoDevicePtr->PciIo = PciIo;\r
641 IdeBlkIoDevicePtr->IdeBusDriverPrivateData = IdeBusDriverPrivateData;\r
642 IdeBlkIoDevicePtr->IoPort->BusMasterBaseAddr = IdeRegsBaseAddr[IdeChannel].BusMasterBaseAddr;\r
643\r
644 //\r
645 // Report Status code: is about to detect IDE drive\r
646 //\r
647 REPORT_STATUS_CODE_EX (\r
648 EFI_PROGRESS_CODE,\r
649 (EFI_IO_BUS_ATA_ATAPI | EFI_P_PC_PRESENCE_DETECT),\r
650 0,\r
651 &gEfiCallerIdGuid,\r
652 NULL,\r
653 NULL,\r
654 0\r
655 );\r
656\r
657 //\r
658 // Discover device, now!\r
659 //\r
660 PERF_START (NULL, "DiscoverIdeDevice", "IDE", 0);\r
661 Status = DiscoverIdeDevice (IdeBlkIoDevicePtr);\r
662 PERF_END (NULL, "DiscoverIdeDevice", "IDE", 0);\r
663\r
664 IdeBusDriverPrivateData->HaveScannedDevice[IdeChannel * 2 + IdeDevice] = TRUE;\r
665 IdeBusDriverPrivateData->DeviceProcessed[IdeChannel * 2 + IdeDevice] = FALSE;\r
666\r
667 if (!EFI_ERROR (Status)) {\r
668 //\r
669 // Set Device Path\r
670 //\r
671 ZeroMem (&NewNode, sizeof (NewNode));\r
672 NewNode.DevPath.Type = MESSAGING_DEVICE_PATH;\r
673 NewNode.DevPath.SubType = MSG_ATAPI_DP;\r
674 SetDevicePathNodeLength (&NewNode.DevPath, sizeof (ATAPI_DEVICE_PATH));\r
675\r
676 NewNode.Atapi.PrimarySecondary = (UINT8) IdeBlkIoDevicePtr->Channel;\r
677 NewNode.Atapi.SlaveMaster = (UINT8) IdeBlkIoDevicePtr->Device;\r
678 NewNode.Atapi.Lun = IdeBlkIoDevicePtr->Lun;\r
679 IdeBlkIoDevicePtr->DevicePath = AppendDevicePathNode (\r
680 ParentDevicePath,\r
681 &NewNode.DevPath\r
682 );\r
683 if (IdeBlkIoDevicePtr->DevicePath == NULL) {\r
684 ReleaseIdeResources (IdeBlkIoDevicePtr);\r
685 continue;\r
686 }\r
687\r
688 //\r
689 // Submit identify data to IDE controller init driver\r
690 //\r
691 CopyMem (&IdentifyData, IdeBlkIoDevicePtr->IdData, sizeof (IdentifyData));\r
692 IdeBusDriverPrivateData->DeviceFound[IdeChannel * 2 + IdeDevice] = TRUE;\r
693 IdeInit->SubmitData (IdeInit, IdeChannel, IdeDevice, &IdentifyData);\r
694 } else {\r
695 //\r
696 // Device detection failed\r
697 //\r
698 IdeBusDriverPrivateData->DeviceFound[IdeChannel * 2 + IdeDevice] = FALSE;\r
699 IdeInit->SubmitData (IdeInit, IdeChannel, IdeDevice, NULL);\r
700 ReleaseIdeResources (IdeBlkIoDevicePtr);\r
701 IdeBlkIoDevicePtr = NULL;\r
702 }\r
703 //\r
704 // end of 1st inner loop ---\r
705 //\r
706 }\r
707 //\r
708 // end of 1st outer loop =========\r
709 //\r
710 }\r
711\r
712 //\r
713 // = 2nd outer loop == Primary/Secondary =================\r
714 //\r
715 for (IdeChannel = BeginningIdeChannel; IdeChannel <= EndIdeChannel; IdeChannel++) {\r
716\r
717 //\r
718 // -- 2nd inner loop --- Master/Slave --------\r
719 //\r
720 for (IdeDevice = BeginningIdeDevice; IdeDevice <= EndIdeDevice; IdeDevice++) {\r
721\r
722 if (IdeBusDriverPrivateData->DeviceProcessed[IdeChannel * 2 + IdeDevice]) {\r
723 continue;\r
724 }\r
725\r
726 if (!IdeBusDriverPrivateData->DeviceFound[IdeChannel * 2 + IdeDevice]) {\r
727 continue;\r
728 }\r
729\r
730 Status = IdeInit->CalculateMode (\r
731 IdeInit,\r
732 IdeChannel,\r
733 IdeDevice,\r
734 &SupportedModes\r
735 );\r
736 if (EFI_ERROR (Status)) {\r
737 DEBUG ((EFI_D_ERROR, "[bStStp20S=%x]", Status));\r
738 continue;\r
739 }\r
740\r
741 IdeBlkIoDevicePtr = IdeBlkIoDevice[IdeChannel][IdeDevice];\r
742\r
743 //\r
744 // Set best supported PIO mode on this IDE device\r
745 //\r
746 if (SupportedModes->PioMode.Mode <= AtaPioMode2) {\r
747 TransferMode.ModeCategory = ATA_MODE_CATEGORY_DEFAULT_PIO;\r
748 } else {\r
749 TransferMode.ModeCategory = ATA_MODE_CATEGORY_FLOW_PIO;\r
750 }\r
751\r
752 TransferMode.ModeNumber = (UINT8) (SupportedModes->PioMode.Mode);\r
753\r
754 if (SupportedModes->ExtModeCount == 0){\r
755 Status = SetDeviceTransferMode (IdeBlkIoDevicePtr, &TransferMode);\r
756\r
757 if (EFI_ERROR (Status)) {\r
758 IdeBusDriverPrivateData->DeviceFound[IdeChannel * 2 + IdeDevice] = FALSE;\r
759 ReleaseIdeResources (IdeBlkIoDevicePtr);\r
760 IdeBlkIoDevicePtr = NULL;\r
761 continue;\r
762 }\r
763 }\r
764\r
765 //\r
766 // Set supported DMA mode on this IDE device. Note that UDMA & MDMA cann't\r
767 // be set together. Only one DMA mode can be set to a device. If setting\r
768 // DMA mode operation fails, we can continue moving on because we only use\r
769 // PIO mode at boot time. DMA modes are used by certain kind of OS booting\r
770 //\r
771 if (SupportedModes->UdmaMode.Valid) {\r
772\r
773 TransferMode.ModeCategory = ATA_MODE_CATEGORY_UDMA;\r
774 TransferMode.ModeNumber = (UINT8) (SupportedModes->UdmaMode.Mode);\r
775 Status = SetDeviceTransferMode (IdeBlkIoDevicePtr, &TransferMode);\r
776\r
777 if (EFI_ERROR (Status)) {\r
778 IdeBusDriverPrivateData->DeviceFound[IdeChannel * 2 + IdeDevice] = FALSE;\r
779 ReleaseIdeResources (IdeBlkIoDevicePtr);\r
780 IdeBlkIoDevicePtr = NULL;\r
781 continue;\r
782 }\r
783 //\r
784 // Record Udma Mode\r
785 //\r
786 IdeBlkIoDevicePtr->UdmaMode.Valid = TRUE;\r
787 IdeBlkIoDevicePtr->UdmaMode.Mode = SupportedModes->UdmaMode.Mode;\r
788 EnableInterrupt (IdeBlkIoDevicePtr);\r
789 } else if (SupportedModes->MultiWordDmaMode.Valid) {\r
790\r
791 TransferMode.ModeCategory = ATA_MODE_CATEGORY_MDMA;\r
792 TransferMode.ModeNumber = (UINT8) SupportedModes->MultiWordDmaMode.Mode;\r
793 Status = SetDeviceTransferMode (IdeBlkIoDevicePtr, &TransferMode);\r
794\r
795 if (EFI_ERROR (Status)) {\r
796 IdeBusDriverPrivateData->DeviceFound[IdeChannel * 2 + IdeDevice] = FALSE;\r
797 ReleaseIdeResources (IdeBlkIoDevicePtr);\r
798 IdeBlkIoDevicePtr = NULL;\r
799 continue;\r
800 }\r
801\r
802 EnableInterrupt (IdeBlkIoDevicePtr);\r
803 }\r
804 //\r
805 // Init driver parameters\r
806 //\r
a7ddec11 807 DriveParameters.Sector = (UINT8) ((ATA5_IDENTIFY_DATA *) IdeBlkIoDevicePtr->IdData)->sectors_per_track;\r
808 DriveParameters.Heads = (UINT8) (((ATA5_IDENTIFY_DATA *) IdeBlkIoDevicePtr->IdData)->heads - 1);\r
563c9c8a 809 DriveParameters.MultipleSector = (UINT8) IdeBlkIoDevicePtr->IdData->AtaData.multi_sector_cmd_max_sct_cnt;\r
810 //\r
811 // Set Parameters for the device:\r
812 // 1) Init\r
813 // 2) Establish the block count for READ/WRITE MULTIPLE (EXT) command\r
814 //\r
815 if ((IdeBlkIoDevicePtr->Type == IdeHardDisk) || (IdeBlkIoDevicePtr->Type == Ide48bitAddressingHardDisk)) {\r
816 Status = SetDriveParameters (IdeBlkIoDevicePtr, &DriveParameters);\r
817 }\r
818\r
819 //\r
820 // Record PIO mode used in private data\r
821 //\r
822 IdeBlkIoDevicePtr->PioMode = (ATA_PIO_MODE) SupportedModes->PioMode.Mode;\r
823\r
824 //\r
825 // Set IDE controller Timing Blocks in the PCI Configuration Space\r
826 //\r
827 IdeInit->SetTiming (IdeInit, IdeChannel, IdeDevice, SupportedModes);\r
828\r
829 //\r
830 // Add Component Name for the IDE/ATAPI device that was discovered.\r
831 //\r
832 IdeBlkIoDevicePtr->ControllerNameTable = NULL;\r
833 ADD_IDE_ATAPI_NAME (IdeBlkIoDevicePtr);\r
834\r
835 Status = gBS->InstallMultipleProtocolInterfaces (\r
836 &IdeBlkIoDevicePtr->Handle,\r
837 &gEfiDevicePathProtocolGuid,\r
838 IdeBlkIoDevicePtr->DevicePath,\r
839 &gEfiBlockIoProtocolGuid,\r
840 &IdeBlkIoDevicePtr->BlkIo,\r
841 &gEfiDiskInfoProtocolGuid,\r
842 &IdeBlkIoDevicePtr->DiskInfo,\r
843 NULL\r
844 );\r
845\r
846 if (EFI_ERROR (Status)) {\r
847 ReleaseIdeResources (IdeBlkIoDevicePtr);\r
848 }\r
849\r
850 gBS->OpenProtocol (\r
851 Controller,\r
852 &gEfiPciIoProtocolGuid,\r
853 (VOID **) &PciIo,\r
854 This->DriverBindingHandle,\r
855 IdeBlkIoDevicePtr->Handle,\r
856 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
857 );\r
858\r
859 IdeBusDriverPrivateData->DeviceProcessed[IdeChannel * 2 + IdeDevice] = TRUE;\r
860\r
861 //\r
862 // Report status code: device eanbled!\r
863 //\r
864 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
865 EFI_PROGRESS_CODE,\r
866 (EFI_IO_BUS_ATA_ATAPI | EFI_P_PC_ENABLE),\r
867 IdeBlkIoDevicePtr->DevicePath\r
868 );\r
869\r
870 //\r
871 // Create event to clear pending IDE interrupt\r
872 //\r
873 Status = gBS->CreateEventEx (\r
874 EVT_NOTIFY_SIGNAL,\r
875 TPL_NOTIFY,\r
876 ClearInterrupt,\r
877 IdeBlkIoDevicePtr,\r
878 &gEfiEventExitBootServicesGuid,\r
879 &IdeBlkIoDevicePtr->ExitBootServiceEvent\r
880 );\r
881\r
882 //\r
883 // end of 2nd inner loop ----\r
884 //\r
885 }\r
886 //\r
887 // end of 2nd outer loop ==========\r
888 //\r
889 }\r
890\r
891 //\r
892 // All configurations done! Notify IdeController to do post initialization\r
893 // work such as saving IDE controller PCI settings for S3 resume\r
894 //\r
895 IdeInit->NotifyPhase (IdeInit, EfiIdeBusPhaseMaximum, 0);\r
896\r
897 if (SupportedModes != NULL) {\r
2277ab96 898 FreePool (SupportedModes);\r
563c9c8a 899 }\r
900\r
901 PERF_START (NULL, "Finish IDE detection", "IDE", 1);\r
902 PERF_END (NULL, "Finish IDE detection", "IDE", 0);\r
903\r
904 return EFI_SUCCESS;\r
905\r
906ErrorExit:\r
907\r
908 //\r
909 // Report error code: controller error\r
910 //\r
911 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
912 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
913 (EFI_IO_BUS_ATA_ATAPI | EFI_IOB_EC_CONTROLLER_ERROR),\r
914 ParentDevicePath\r
915 );\r
916\r
917 gBS->CloseProtocol (\r
918 Controller,\r
919 &gEfiIdeControllerInitProtocolGuid,\r
920 This->DriverBindingHandle,\r
921 Controller\r
922 );\r
923\r
924 gBS->UninstallMultipleProtocolInterfaces (\r
925 Controller,\r
926 &gEfiCallerIdGuid,\r
927 IdeBusDriverPrivateData,\r
928 NULL\r
929 );\r
930\r
931 if (IdeBusDriverPrivateData != NULL) {\r
932 gBS->FreePool (IdeBusDriverPrivateData);\r
933 }\r
934\r
935 if (SupportedModes != NULL) {\r
936 gBS->FreePool (SupportedModes);\r
937 }\r
938\r
939 gBS->CloseProtocol (\r
940 Controller,\r
941 &gEfiPciIoProtocolGuid,\r
942 This->DriverBindingHandle,\r
943 Controller\r
944 );\r
945\r
946 gBS->CloseProtocol (\r
947 Controller,\r
948 &gEfiDevicePathProtocolGuid,\r
949 This->DriverBindingHandle,\r
950 Controller\r
951 );\r
952\r
953 return Status;\r
954\r
955}\r
956/**\r
957 Stop function of Driver Binding Protocol which is to stop the driver on Controller Handle and all\r
958 child handle attached to the controller handle if there are.\r
959\r
960 @param This Protocol instance pointer.\r
961 @param Controller Handle of device to stop driver on\r
962 @param NumberOfChildren Not used\r
963 @param ChildHandleBuffer Not used\r
964\r
965 @retval EFI_SUCCESS This driver is removed DeviceHandle\r
966 @retval other This driver was not removed from this device\r
967\r
968**/\r
969EFI_STATUS\r
970EFIAPI\r
971IDEBusDriverBindingStop (\r
972 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
973 IN EFI_HANDLE Controller,\r
974 IN UINTN NumberOfChildren,\r
975 IN EFI_HANDLE *ChildHandleBuffer\r
976 )\r
977{\r
978 EFI_STATUS Status;\r
979 EFI_PCI_IO_PROTOCOL *PciIo;\r
980 BOOLEAN AllChildrenStopped;\r
981 UINTN Index;\r
982 IDE_BUS_DRIVER_PRIVATE_DATA *IdeBusDriverPrivateData;\r
983 UINT64 Supports;\r
984\r
985 IdeBusDriverPrivateData = NULL;\r
986\r
987 if (NumberOfChildren == 0) {\r
988\r
989 Status = gBS->OpenProtocol (\r
990 Controller,\r
991 &gEfiPciIoProtocolGuid,\r
992 (VOID **) &PciIo,\r
993 This->DriverBindingHandle,\r
994 Controller,\r
995 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
996 );\r
997 if (!EFI_ERROR (Status)) {\r
998 Status = PciIo->Attributes (\r
999 PciIo,\r
1000 EfiPciIoAttributeOperationSupported,\r
1001 0,\r
1002 &Supports\r
1003 );\r
1004 if (!EFI_ERROR (Status)) {\r
1005 Supports &= EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO | EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO | EFI_PCI_DEVICE_ENABLE;\r
1006 PciIo->Attributes (\r
1007 PciIo,\r
1008 EfiPciIoAttributeOperationDisable,\r
1009 Supports,\r
1010 NULL\r
1011 );\r
1012 }\r
1013 }\r
1014\r
1015 gBS->OpenProtocol (\r
1016 Controller,\r
1017 &gEfiCallerIdGuid,\r
1018 (VOID **) &IdeBusDriverPrivateData,\r
1019 This->DriverBindingHandle,\r
1020 Controller,\r
1021 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
1022 );\r
1023\r
1024 gBS->UninstallMultipleProtocolInterfaces (\r
1025 Controller,\r
1026 &gEfiCallerIdGuid,\r
1027 IdeBusDriverPrivateData,\r
1028 NULL\r
1029 );\r
1030\r
1031 if (IdeBusDriverPrivateData != NULL) {\r
1032 gBS->FreePool (IdeBusDriverPrivateData);\r
1033 }\r
1034 //\r
1035 // Close the bus driver\r
1036 //\r
1037 gBS->CloseProtocol (\r
1038 Controller,\r
1039 &gEfiIdeControllerInitProtocolGuid,\r
1040 This->DriverBindingHandle,\r
1041 Controller\r
1042 );\r
1043 gBS->CloseProtocol (\r
1044 Controller,\r
1045 &gEfiPciIoProtocolGuid,\r
1046 This->DriverBindingHandle,\r
1047 Controller\r
1048 );\r
1049 gBS->CloseProtocol (\r
1050 Controller,\r
1051 &gEfiDevicePathProtocolGuid,\r
1052 This->DriverBindingHandle,\r
1053 Controller\r
1054 );\r
1055\r
1056 return EFI_SUCCESS;\r
1057 }\r
1058\r
1059 AllChildrenStopped = TRUE;\r
1060\r
1061 for (Index = 0; Index < NumberOfChildren; Index++) {\r
1062\r
1063 Status = DeRegisterIdeDevice (This, Controller, ChildHandleBuffer[Index]);\r
1064\r
1065 if (EFI_ERROR (Status)) {\r
1066 AllChildrenStopped = FALSE;\r
1067 }\r
1068 }\r
1069\r
1070 if (!AllChildrenStopped) {\r
1071 return EFI_DEVICE_ERROR;\r
1072 }\r
1073\r
1074 return EFI_SUCCESS;\r
1075}\r
1076\r
1077/**\r
1078 issue ATA or ATAPI command to reset a block IO device.\r
1079 @param This Block IO protocol instance pointer.\r
1080 @param ExtendedVerification If FALSE,for ATAPI device, driver will only invoke ATAPI reset method\r
1081 If TRUE, for ATAPI device, driver need invoke ATA reset method after\r
1082 invoke ATAPI reset method\r
1083\r
1084 @retval EFI_DEVICE_ERROR When the device is neighther ATA device or ATAPI device.\r
1085 @retval EFI_SUCCESS The device reset successfully\r
1086\r
1087**/\r
1088EFI_STATUS\r
1089EFIAPI\r
1090IDEBlkIoReset (\r
1091 IN EFI_BLOCK_IO_PROTOCOL *This,\r
1092 IN BOOLEAN ExtendedVerification\r
1093 )\r
1094{\r
1095 IDE_BLK_IO_DEV *IdeBlkIoDevice;\r
1096 EFI_STATUS Status;\r
1097 EFI_TPL OldTpl;\r
1098\r
1099 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1100\r
1101 IdeBlkIoDevice = IDE_BLOCK_IO_DEV_FROM_THIS (This);\r
1102 //\r
1103 // Requery IDE IO resources in case of the switch of native and legacy modes\r
1104 //\r
1105 ReassignIdeResources (IdeBlkIoDevice);\r
1106\r
1107 //\r
1108 // for ATA device, using ATA reset method\r
1109 //\r
1110 if (IdeBlkIoDevice->Type == IdeHardDisk ||\r
1111 IdeBlkIoDevice->Type == Ide48bitAddressingHardDisk) {\r
1112 Status = AtaSoftReset (IdeBlkIoDevice);\r
1113 goto Done;\r
1114 }\r
1115\r
1116 if (IdeBlkIoDevice->Type == IdeUnknown) {\r
1117 Status = EFI_DEVICE_ERROR;\r
1118 goto Done;\r
1119 }\r
1120\r
1121 //\r
1122 // for ATAPI device, using ATAPI reset method\r
1123 //\r
1124 Status = AtapiSoftReset (IdeBlkIoDevice);\r
1125 if (ExtendedVerification) {\r
1126 Status = AtaSoftReset (IdeBlkIoDevice);\r
1127 }\r
1128\r
1129Done:\r
1130 gBS->RestoreTPL (OldTpl);\r
1131 return Status;\r
1132}\r
1133\r
1134/**\r
1135 Read data from a block IO device\r
1136\r
1137 @param This Block IO protocol instance pointer.\r
1138 @param MediaId The media ID of the device\r
cd57e888 1139 @param Lba Starting LBA address to read data\r
563c9c8a 1140 @param BufferSize The size of data to be read\r
1141 @param Buffer Caller supplied buffer to save data\r
1142\r
1143 @retval EFI_DEVICE_ERROR unknown device type\r
1144 @retval other read data status.\r
1145\r
1146**/\r
1147EFI_STATUS\r
1148EFIAPI\r
1149IDEBlkIoReadBlocks (\r
1150 IN EFI_BLOCK_IO_PROTOCOL *This,\r
1151 IN UINT32 MediaId,\r
cd57e888 1152 IN EFI_LBA Lba,\r
563c9c8a 1153 IN UINTN BufferSize,\r
1154 OUT VOID *Buffer\r
1155 )\r
1156{\r
1157 IDE_BLK_IO_DEV *IdeBlkIoDevice;\r
1158 EFI_STATUS Status;\r
1159 EFI_TPL OldTpl;\r
1160\r
1161 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1162\r
1163 IdeBlkIoDevice = IDE_BLOCK_IO_DEV_FROM_THIS (This);\r
1164\r
1165 //\r
1166 // Requery IDE IO resources in case of the switch of native and legacy modes\r
1167 //\r
1168 ReassignIdeResources (IdeBlkIoDevice);\r
1169\r
1170 //\r
1171 // For ATA compatible device, use ATA read block's mechanism\r
1172 //\r
1173 if (IdeBlkIoDevice->Type == IdeHardDisk ||\r
1174 IdeBlkIoDevice->Type == Ide48bitAddressingHardDisk) {\r
1175 Status = AtaBlkIoReadBlocks (\r
1176 IdeBlkIoDevice,\r
1177 MediaId,\r
cd57e888 1178 Lba,\r
563c9c8a 1179 BufferSize,\r
1180 Buffer\r
1181 );\r
1182 goto Done;\r
1183 }\r
1184\r
1185 if (IdeBlkIoDevice->Type == IdeUnknown) {\r
1186 Status = EFI_DEVICE_ERROR;\r
1187 goto Done;\r
1188 }\r
1189\r
1190 //\r
1191 // for ATAPI device, using ATAPI read block's mechanism\r
1192 //\r
1193 Status = AtapiBlkIoReadBlocks (\r
1194 IdeBlkIoDevice,\r
1195 MediaId,\r
cd57e888 1196 Lba,\r
563c9c8a 1197 BufferSize,\r
1198 Buffer\r
1199 );\r
1200\r
1201Done:\r
1202 gBS->RestoreTPL (OldTpl);\r
1203\r
1204 return Status;\r
1205}\r
1206\r
1207/**\r
cd57e888 1208 Write data to block io device.\r
563c9c8a 1209\r
1210 @param This Protocol instance pointer.\r
1211 @param MediaId The media ID of the device\r
cd57e888 1212 @param Lba Starting LBA address to write data\r
563c9c8a 1213 @param BufferSize The size of data to be written\r
1214 @param Buffer Caller supplied buffer to save data\r
1215\r
1216 @retval EFI_DEVICE_ERROR unknown device type\r
1217 @retval other write data status\r
1218\r
1219**/\r
1220EFI_STATUS\r
1221EFIAPI\r
1222IDEBlkIoWriteBlocks (\r
1223 IN EFI_BLOCK_IO_PROTOCOL *This,\r
1224 IN UINT32 MediaId,\r
cd57e888 1225 IN EFI_LBA Lba,\r
563c9c8a 1226 IN UINTN BufferSize,\r
1227 IN VOID *Buffer\r
1228 )\r
1229{\r
1230 IDE_BLK_IO_DEV *IdeBlkIoDevice;\r
1231 EFI_STATUS Status;\r
1232 EFI_TPL OldTpl;\r
1233\r
1234 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
1235\r
1236 IdeBlkIoDevice = IDE_BLOCK_IO_DEV_FROM_THIS (This);\r
1237 //\r
1238 // Requery IDE IO resources in case of the switch of native and legacy modes\r
1239 //\r
1240 ReassignIdeResources (IdeBlkIoDevice);\r
1241\r
1242 //\r
1243 // for ATA device, using ATA write block's mechanism\r
1244 //\r
1245 if (IdeBlkIoDevice->Type == IdeHardDisk ||\r
1246 IdeBlkIoDevice->Type == Ide48bitAddressingHardDisk) {\r
1247\r
1248 Status = AtaBlkIoWriteBlocks (\r
1249 IdeBlkIoDevice,\r
1250 MediaId,\r
cd57e888 1251 Lba,\r
563c9c8a 1252 BufferSize,\r
1253 Buffer\r
1254 );\r
1255 goto Done;\r
1256 }\r
1257\r
1258 if (IdeBlkIoDevice->Type == IdeUnknown) {\r
1259 Status = EFI_DEVICE_ERROR;\r
1260 goto Done;\r
1261 }\r
1262\r
1263 //\r
1264 // for ATAPI device, using ATAPI write block's mechanism\r
1265 //\r
1266 Status = AtapiBlkIoWriteBlocks (\r
1267 IdeBlkIoDevice,\r
1268 MediaId,\r
cd57e888 1269 Lba,\r
563c9c8a 1270 BufferSize,\r
1271 Buffer\r
1272 );\r
1273\r
1274Done:\r
1275 gBS->RestoreTPL (OldTpl);\r
1276 return Status;\r
1277}\r
1278/**\r
1279 Flushes all modified data to a physical block devices\r
1280\r
1281 @param This Indicates a pointer to the calling context which to sepcify a\r
1282 sepcific block device\r
1283\r
1284 @retval EFI_SUCCESS Always return success.\r
1285**/\r
1286EFI_STATUS\r
1287EFIAPI\r
1288IDEBlkIoFlushBlocks (\r
1289 IN EFI_BLOCK_IO_PROTOCOL *This\r
1290 )\r
1291{\r
1292 //\r
1293 // return directly\r
1294 //\r
1295 return EFI_SUCCESS;\r
1296}\r
1297\r
1298/**\r
bab0c17a 1299 This function is used by the IDE bus driver to get inquiry data. \r
1300 Data format of Identify data is defined by the Interface GUID.\r
563c9c8a 1301\r
bab0c17a 1302 @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
1303 @param InquiryData Pointer to a buffer for the inquiry data.\r
1304 @param InquiryDataSize Pointer to the value for the inquiry data size.\r
563c9c8a 1305\r
bab0c17a 1306 @retval EFI_SUCCESS The command was accepted without any errors.\r
1307 @retval EFI_NOT_FOUND Device does not support this data class \r
1308 @retval EFI_DEVICE_ERROR Error reading InquiryData from device \r
1309 @retval EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough \r
563c9c8a 1310\r
1311**/\r
1312EFI_STATUS\r
1313EFIAPI\r
1314IDEDiskInfoInquiry (\r
1315 IN EFI_DISK_INFO_PROTOCOL *This,\r
1316 IN OUT VOID *InquiryData,\r
1317 IN OUT UINT32 *InquiryDataSize\r
1318 )\r
1319{\r
1320 IDE_BLK_IO_DEV *IdeBlkIoDevice;\r
1321\r
1322 IdeBlkIoDevice = IDE_BLOCK_IO_DEV_FROM_DISK_INFO_THIS (This);\r
1323\r
1324 if (*InquiryDataSize < sizeof (ATAPI_INQUIRY_DATA)) {\r
1325 *InquiryDataSize = sizeof (ATAPI_INQUIRY_DATA);\r
1326 return EFI_BUFFER_TOO_SMALL;\r
1327 }\r
1328\r
1329 if (IdeBlkIoDevice->InquiryData == NULL) {\r
1330 return EFI_NOT_FOUND;\r
1331 }\r
1332\r
1333 gBS->CopyMem (InquiryData, IdeBlkIoDevice->InquiryData, sizeof (ATAPI_INQUIRY_DATA));\r
1334 *InquiryDataSize = sizeof (ATAPI_INQUIRY_DATA);\r
1335\r
1336 return EFI_SUCCESS;\r
1337}\r
1338\r
1339/**\r
bab0c17a 1340 This function is used by the IDE bus driver to get identify data. \r
563c9c8a 1341 Data format of Identify data is defined by the Interface GUID.\r
1342\r
bab0c17a 1343 @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
1344 @param IdentifyData Pointer to a buffer for the identify data.\r
1345 @param IdentifyDataSize Pointer to the value for the identify data size.\r
563c9c8a 1346\r
bab0c17a 1347 @retval EFI_SUCCESS The command was accepted without any errors.\r
1348 @retval EFI_NOT_FOUND Device does not support this data class \r
1349 @retval EFI_DEVICE_ERROR Error reading IdentifyData from device \r
1350 @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough \r
563c9c8a 1351\r
1352**/\r
1353EFI_STATUS\r
1354EFIAPI\r
1355IDEDiskInfoIdentify (\r
1356 IN EFI_DISK_INFO_PROTOCOL *This,\r
1357 IN OUT VOID *IdentifyData,\r
1358 IN OUT UINT32 *IdentifyDataSize\r
1359 )\r
1360{\r
1361 IDE_BLK_IO_DEV *IdeBlkIoDevice;\r
1362\r
1363 IdeBlkIoDevice = IDE_BLOCK_IO_DEV_FROM_DISK_INFO_THIS (This);\r
1364\r
1365 if (*IdentifyDataSize < sizeof (EFI_IDENTIFY_DATA)) {\r
1366 *IdentifyDataSize = sizeof (EFI_IDENTIFY_DATA);\r
1367 return EFI_BUFFER_TOO_SMALL;\r
1368 }\r
1369\r
1370 if (IdeBlkIoDevice->IdData == NULL) {\r
1371 return EFI_NOT_FOUND;\r
1372 }\r
1373\r
1374 gBS->CopyMem (IdentifyData, IdeBlkIoDevice->IdData, sizeof (EFI_IDENTIFY_DATA));\r
1375 *IdentifyDataSize = sizeof (EFI_IDENTIFY_DATA);\r
1376\r
1377 return EFI_SUCCESS;\r
1378}\r
1379\r
1380/**\r
bab0c17a 1381 This function is used by the IDE bus driver to get sense data. \r
563c9c8a 1382 Data format of Sense data is defined by the Interface GUID.\r
1383\r
bab0c17a 1384 @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
1385 @param SenseData Pointer to the SenseData. \r
1386 @param SenseDataSize Size of SenseData in bytes. \r
1387 @param SenseDataNumber Pointer to the value for the identify data size.\r
563c9c8a 1388\r
bab0c17a 1389 @retval EFI_SUCCESS The command was accepted without any errors.\r
1390 @retval EFI_NOT_FOUND Device does not support this data class \r
1391 @retval EFI_DEVICE_ERROR Error reading InquiryData from device \r
1392 @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough \r
563c9c8a 1393\r
1394**/\r
1395EFI_STATUS\r
1396EFIAPI\r
1397IDEDiskInfoSenseData (\r
1398 IN EFI_DISK_INFO_PROTOCOL *This,\r
1399 IN OUT VOID *SenseData,\r
1400 IN OUT UINT32 *SenseDataSize,\r
1401 OUT UINT8 *SenseDataNumber\r
1402 )\r
1403{\r
1404 return EFI_NOT_FOUND;\r
1405}\r
1406\r
1407/**\r
bab0c17a 1408 This function is used by the IDE bus driver to get controller information.\r
563c9c8a 1409\r
bab0c17a 1410 @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
1411 @param IdeChannel Pointer to the Ide Channel number. Primary or secondary.\r
1412 @param IdeDevice Pointer to the Ide Device number. Master or slave.\r
563c9c8a 1413\r
bab0c17a 1414 @retval EFI_SUCCESS IdeChannel and IdeDevice are valid \r
1415 @retval EFI_UNSUPPORTED This is not an IDE device \r
563c9c8a 1416\r
1417**/\r
1418EFI_STATUS\r
1419EFIAPI\r
1420IDEDiskInfoWhichIde (\r
1421 IN EFI_DISK_INFO_PROTOCOL *This,\r
1422 OUT UINT32 *IdeChannel,\r
1423 OUT UINT32 *IdeDevice\r
1424 )\r
1425{\r
1426 IDE_BLK_IO_DEV *IdeBlkIoDevice;\r
1427\r
1428 IdeBlkIoDevice = IDE_BLOCK_IO_DEV_FROM_DISK_INFO_THIS (This);\r
1429 *IdeChannel = IdeBlkIoDevice->Channel;\r
1430 *IdeDevice = IdeBlkIoDevice->Device;\r
1431\r
1432 return EFI_SUCCESS;\r
1433}\r
1434\r
1435/**\r
1436 The is an event(generally the event is exitBootService event) call back function.\r
1437 Clear pending IDE interrupt before OS loader/kernel take control of the IDE device.\r
1438\r
1439 @param Event Pointer to this event\r
1440 @param Context Event hanlder private data\r
1441\r
1442**/\r
1443VOID\r
1444EFIAPI\r
1445ClearInterrupt (\r
1446 IN EFI_EVENT Event,\r
1447 IN VOID *Context\r
1448 )\r
1449{\r
1450 EFI_STATUS Status;\r
1451 UINT64 IoPortForBmis;\r
1452 UINT8 RegisterValue;\r
1453 IDE_BLK_IO_DEV *IdeDev;\r
1454\r
1455 //\r
1456 // Get our context\r
1457 //\r
1458 IdeDev = (IDE_BLK_IO_DEV *) Context;\r
1459\r
1460 //\r
1461 // Obtain IDE IO port registers' base addresses\r
1462 //\r
1463 Status = ReassignIdeResources (IdeDev);\r
1464 if (EFI_ERROR (Status)) {\r
1465 return;\r
1466 }\r
1467\r
1468 //\r
1469 // Check whether interrupt is pending\r
1470 //\r
1471\r
1472 //\r
1473 // Reset IDE device to force it de-assert interrupt pin\r
1474 // Note: this will reset all devices on this IDE channel\r
1475 //\r
1476 AtaSoftReset (IdeDev);\r
1477 if (EFI_ERROR (Status)) {\r
1478 return;\r
1479 }\r
1480\r
1481 //\r
1482 // Get base address of IDE Bus Master Status Regsiter\r
1483 //\r
1484 if (IdePrimary == IdeDev->Channel) {\r
1485 IoPortForBmis = IdeDev->IoPort->BusMasterBaseAddr + BMISP_OFFSET;\r
1486 } else {\r
1487 if (IdeSecondary == IdeDev->Channel) {\r
1488 IoPortForBmis = IdeDev->IoPort->BusMasterBaseAddr + BMISS_OFFSET;\r
1489 } else {\r
1490 return;\r
1491 }\r
1492 }\r
1493 //\r
1494 // Read BMIS register and clear ERROR and INTR bit\r
1495 //\r
1496 IdeDev->PciIo->Io.Read (\r
1497 IdeDev->PciIo,\r
1498 EfiPciIoWidthUint8,\r
1499 EFI_PCI_IO_PASS_THROUGH_BAR,\r
1500 IoPortForBmis,\r
1501 1,\r
1502 &RegisterValue\r
1503 );\r
1504\r
1505 RegisterValue |= (BMIS_INTERRUPT | BMIS_ERROR);\r
1506\r
1507 IdeDev->PciIo->Io.Write (\r
1508 IdeDev->PciIo,\r
1509 EfiPciIoWidthUint8,\r
1510 EFI_PCI_IO_PASS_THROUGH_BAR,\r
1511 IoPortForBmis,\r
1512 1,\r
1513 &RegisterValue\r
1514 );\r
1515\r
1516 //\r
1517 // Select the other device on this channel to ensure this device to release the interrupt pin\r
1518 //\r
1519 if (IdeDev->Device == 0) {\r
1520 RegisterValue = (1 << 4) | 0xe0;\r
1521 } else {\r
1522 RegisterValue = (0 << 4) | 0xe0;\r
1523 }\r
1524 IDEWritePortB (\r
1525 IdeDev->PciIo,\r
1526 IdeDev->IoPort->Head,\r
1527 RegisterValue\r
1528 );\r
1529\r
1530}\r
1531\r
1532/**\r
1533 The user Entry Point for module IdeBus. The user code starts with this function.\r
1534\r
1535 @param[in] ImageHandle The firmware allocated handle for the EFI image.\r
1536 @param[in] SystemTable A pointer to the EFI System Table.\r
1537\r
1538 @retval EFI_SUCCESS The entry point is executed successfully.\r
1539 @retval other Some error occurs when executing this entry point.\r
1540\r
1541**/\r
1542EFI_STATUS\r
1543EFIAPI\r
1544InitializeIdeBus(\r
1545 IN EFI_HANDLE ImageHandle,\r
1546 IN EFI_SYSTEM_TABLE *SystemTable\r
1547 )\r
1548{\r
1549 EFI_STATUS Status;\r
1550\r
1551 //\r
1552 // Install driver model protocol(s).\r
1553 //\r
1554 Status = EfiLibInstallAllDriverProtocols2 (\r
1555 ImageHandle,\r
1556 SystemTable,\r
1557 &gIDEBusDriverBinding,\r
1558 ImageHandle,\r
1559 &gIDEBusComponentName,\r
1560 &gIDEBusComponentName2,\r
1561 NULL,\r
1562 NULL,\r
1563 &gIDEBusDriverDiagnostics,\r
1564 &gIDEBusDriverDiagnostics2\r
1565 );\r
1566 ASSERT_EFI_ERROR (Status);\r
1567\r
1568 return Status;\r
1569}\r