]>
Commit | Line | Data |
---|---|---|
27f30159 SZ |
1 | /** @file\r |
2 | This driver module produces IDE_CONTROLLER_INIT protocol for Sata Controllers.\r | |
3 | \r | |
4 | Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r | |
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 | #include "SataController.h"\r | |
16 | \r | |
17 | ///\r | |
18 | /// EFI_DRIVER_BINDING_PROTOCOL instance\r | |
19 | ///\r | |
20 | EFI_DRIVER_BINDING_PROTOCOL gSataControllerDriverBinding = {\r | |
21 | SataControllerSupported,\r | |
22 | SataControllerStart,\r | |
23 | SataControllerStop,\r | |
24 | 0xa,\r | |
25 | NULL,\r | |
26 | NULL\r | |
27 | };\r | |
28 | \r | |
29 | /**\r | |
30 | Read AHCI Operation register.\r | |
31 | \r | |
32 | @param PciIo The PCI IO protocol instance.\r | |
33 | @param Offset The operation register offset.\r | |
34 | \r | |
35 | @return The register content read.\r | |
36 | \r | |
37 | **/\r | |
38 | UINT32\r | |
39 | EFIAPI\r | |
40 | AhciReadReg (\r | |
41 | IN EFI_PCI_IO_PROTOCOL *PciIo,\r | |
42 | IN UINT32 Offset\r | |
43 | )\r | |
44 | {\r | |
45 | UINT32 Data;\r | |
46 | \r | |
47 | ASSERT (PciIo != NULL);\r | |
48 | \r | |
49 | Data = 0;\r | |
50 | \r | |
51 | PciIo->Mem.Read (\r | |
52 | PciIo,\r | |
53 | EfiPciIoWidthUint32,\r | |
54 | AHCI_BAR_INDEX,\r | |
55 | (UINT64) Offset,\r | |
56 | 1,\r | |
57 | &Data\r | |
58 | );\r | |
59 | \r | |
60 | return Data;\r | |
61 | }\r | |
62 | \r | |
63 | /**\r | |
64 | Write AHCI Operation register.\r | |
65 | \r | |
66 | @param PciIo The PCI IO protocol instance.\r | |
67 | @param Offset The operation register offset.\r | |
68 | @param Data The data used to write down.\r | |
69 | \r | |
70 | **/\r | |
71 | VOID\r | |
72 | EFIAPI\r | |
73 | AhciWriteReg (\r | |
74 | IN EFI_PCI_IO_PROTOCOL *PciIo,\r | |
75 | IN UINT32 Offset,\r | |
76 | IN UINT32 Data\r | |
77 | )\r | |
78 | {\r | |
79 | ASSERT (PciIo != NULL);\r | |
80 | \r | |
81 | PciIo->Mem.Write (\r | |
82 | PciIo,\r | |
83 | EfiPciIoWidthUint32,\r | |
84 | AHCI_BAR_INDEX,\r | |
85 | (UINT64) Offset,\r | |
86 | 1,\r | |
87 | &Data\r | |
88 | );\r | |
89 | \r | |
90 | return;\r | |
91 | }\r | |
92 | \r | |
93 | /**\r | |
94 | This function is used to calculate the best PIO mode supported by specific IDE device\r | |
95 | \r | |
96 | @param IdentifyData The identify data of specific IDE device.\r | |
97 | @param DisPioMode Disqualified PIO modes collection.\r | |
98 | @param SelectedMode Available PIO modes collection.\r | |
99 | \r | |
100 | @retval EFI_SUCCESS Best PIO modes are returned.\r | |
101 | @retval EFI_UNSUPPORTED The device doesn't support PIO mode,\r | |
102 | or all supported modes have been disqualified.\r | |
103 | **/\r | |
104 | EFI_STATUS\r | |
105 | CalculateBestPioMode (\r | |
106 | IN EFI_IDENTIFY_DATA *IdentifyData,\r | |
107 | IN UINT16 *DisPioMode OPTIONAL,\r | |
108 | OUT UINT16 *SelectedMode\r | |
109 | )\r | |
110 | {\r | |
111 | UINT16 PioMode;\r | |
112 | UINT16 AdvancedPioMode;\r | |
113 | UINT16 Temp;\r | |
114 | UINT16 Index;\r | |
115 | UINT16 MinimumPioCycleTime;\r | |
116 | \r | |
117 | Temp = 0xff;\r | |
118 | \r | |
119 | PioMode = (UINT8) (((ATA5_IDENTIFY_DATA *) (&(IdentifyData->AtaData)))->pio_cycle_timing >> 8);\r | |
120 | \r | |
121 | //\r | |
122 | // See whether Identify Data word 64 - 70 are valid\r | |
123 | //\r | |
124 | if ((IdentifyData->AtaData.field_validity & 0x02) == 0x02) {\r | |
125 | \r | |
126 | AdvancedPioMode = IdentifyData->AtaData.advanced_pio_modes;\r | |
127 | DEBUG ((EFI_D_INFO, "CalculateBestPioMode: AdvancedPioMode = %x\n", AdvancedPioMode));\r | |
128 | \r | |
129 | for (Index = 0; Index < 8; Index++) {\r | |
130 | if ((AdvancedPioMode & 0x01) != 0) {\r | |
131 | Temp = Index;\r | |
132 | }\r | |
133 | \r | |
134 | AdvancedPioMode >>= 1;\r | |
135 | }\r | |
136 | \r | |
137 | //\r | |
138 | // If Temp is modified, mean the advanced_pio_modes is not zero;\r | |
139 | // if Temp is not modified, mean there is no advanced PIO mode supported,\r | |
140 | // the best PIO Mode is the value in pio_cycle_timing.\r | |
141 | //\r | |
142 | if (Temp != 0xff) {\r | |
143 | AdvancedPioMode = (UINT16) (Temp + 3);\r | |
144 | } else {\r | |
145 | AdvancedPioMode = PioMode;\r | |
146 | }\r | |
147 | \r | |
148 | //\r | |
149 | // Limit the PIO mode to at most PIO4.\r | |
150 | //\r | |
151 | PioMode = (UINT16) MIN (AdvancedPioMode, 4);\r | |
152 | \r | |
153 | MinimumPioCycleTime = IdentifyData->AtaData.min_pio_cycle_time_with_flow_control;\r | |
154 | \r | |
155 | if (MinimumPioCycleTime <= 120) {\r | |
156 | PioMode = (UINT16) MIN (4, PioMode);\r | |
157 | } else if (MinimumPioCycleTime <= 180) {\r | |
158 | PioMode = (UINT16) MIN (3, PioMode);\r | |
159 | } else if (MinimumPioCycleTime <= 240) {\r | |
160 | PioMode = (UINT16) MIN (2, PioMode);\r | |
161 | } else {\r | |
162 | PioMode = 0;\r | |
163 | }\r | |
164 | \r | |
165 | //\r | |
166 | // Degrade the PIO mode if the mode has been disqualified\r | |
167 | //\r | |
168 | if (DisPioMode != NULL) {\r | |
169 | if (*DisPioMode < 2) {\r | |
170 | return EFI_UNSUPPORTED; // no mode below ATA_PIO_MODE_BELOW_2\r | |
171 | }\r | |
172 | \r | |
173 | if (PioMode >= *DisPioMode) {\r | |
174 | PioMode = (UINT16) (*DisPioMode - 1);\r | |
175 | }\r | |
176 | }\r | |
177 | \r | |
178 | if (PioMode < 2) {\r | |
179 | *SelectedMode = 1; // ATA_PIO_MODE_BELOW_2;\r | |
180 | } else {\r | |
181 | *SelectedMode = PioMode; // ATA_PIO_MODE_2 to ATA_PIO_MODE_4;\r | |
182 | }\r | |
183 | \r | |
184 | } else {\r | |
185 | //\r | |
186 | // Identify Data word 64 - 70 are not valid\r | |
187 | // Degrade the PIO mode if the mode has been disqualified\r | |
188 | //\r | |
189 | if (DisPioMode != NULL) {\r | |
190 | if (*DisPioMode < 2) {\r | |
191 | return EFI_UNSUPPORTED; // no mode below ATA_PIO_MODE_BELOW_2\r | |
192 | }\r | |
193 | \r | |
194 | if (PioMode == *DisPioMode) {\r | |
195 | PioMode--;\r | |
196 | }\r | |
197 | }\r | |
198 | \r | |
199 | if (PioMode < 2) {\r | |
200 | *SelectedMode = 1; // ATA_PIO_MODE_BELOW_2;\r | |
201 | } else {\r | |
202 | *SelectedMode = 2; // ATA_PIO_MODE_2;\r | |
203 | }\r | |
204 | \r | |
205 | }\r | |
206 | \r | |
207 | return EFI_SUCCESS;\r | |
208 | }\r | |
209 | \r | |
210 | /**\r | |
211 | This function is used to calculate the best UDMA mode supported by specific IDE device\r | |
212 | \r | |
213 | @param IdentifyData The identify data of specific IDE device.\r | |
214 | @param DisUDmaMode Disqualified UDMA modes collection.\r | |
215 | @param SelectedMode Available UDMA modes collection.\r | |
216 | \r | |
217 | @retval EFI_SUCCESS Best UDMA modes are returned.\r | |
218 | @retval EFI_UNSUPPORTED The device doesn't support UDMA mode,\r | |
219 | or all supported modes have been disqualified.\r | |
220 | **/\r | |
221 | EFI_STATUS\r | |
222 | CalculateBestUdmaMode (\r | |
223 | IN EFI_IDENTIFY_DATA *IdentifyData,\r | |
224 | IN UINT16 *DisUDmaMode OPTIONAL,\r | |
225 | OUT UINT16 *SelectedMode\r | |
226 | )\r | |
227 | {\r | |
228 | UINT16 TempMode;\r | |
229 | UINT16 DeviceUDmaMode;\r | |
230 | \r | |
231 | DeviceUDmaMode = 0;\r | |
232 | \r | |
233 | //\r | |
234 | // Check whether the WORD 88 (supported UltraDMA by drive) is valid\r | |
235 | //\r | |
236 | if ((IdentifyData->AtaData.field_validity & 0x04) == 0x00) {\r | |
237 | return EFI_UNSUPPORTED;\r | |
238 | }\r | |
239 | \r | |
240 | DeviceUDmaMode = IdentifyData->AtaData.ultra_dma_mode;\r | |
241 | DEBUG ((EFI_D_INFO, "CalculateBestUdmaMode: DeviceUDmaMode = %x\n", DeviceUDmaMode));\r | |
242 | DeviceUDmaMode &= 0x3f;\r | |
243 | TempMode = 0; // initialize it to UDMA-0\r | |
244 | \r | |
245 | while ((DeviceUDmaMode >>= 1) != 0) {\r | |
246 | TempMode++;\r | |
247 | }\r | |
248 | \r | |
249 | //\r | |
250 | // Degrade the UDMA mode if the mode has been disqualified\r | |
251 | //\r | |
252 | if (DisUDmaMode != NULL) {\r | |
253 | if (*DisUDmaMode == 0) {\r | |
254 | *SelectedMode = 0;\r | |
255 | return EFI_UNSUPPORTED; // no mode below ATA_UDMA_MODE_0\r | |
256 | }\r | |
257 | \r | |
258 | if (TempMode >= *DisUDmaMode) {\r | |
259 | TempMode = (UINT16) (*DisUDmaMode - 1);\r | |
260 | }\r | |
261 | }\r | |
262 | \r | |
263 | //\r | |
264 | // Possible returned mode is between ATA_UDMA_MODE_0 and ATA_UDMA_MODE_5\r | |
265 | //\r | |
266 | *SelectedMode = TempMode;\r | |
267 | \r | |
268 | return EFI_SUCCESS;\r | |
269 | }\r | |
270 | \r | |
271 | /**\r | |
272 | The Entry Point of module. It follows the standard UEFI driver model.\r | |
273 | \r | |
274 | @param[in] ImageHandle The firmware allocated handle for the EFI image. \r | |
275 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
276 | \r | |
277 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
278 | @retval other Some error occurs when executing this entry point.\r | |
279 | \r | |
280 | **/\r | |
281 | EFI_STATUS\r | |
282 | EFIAPI\r | |
283 | InitializeSataControllerDriver (\r | |
284 | IN EFI_HANDLE ImageHandle,\r | |
285 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
286 | )\r | |
287 | {\r | |
288 | EFI_STATUS Status;\r | |
289 | \r | |
290 | //\r | |
291 | // Install driver model protocol(s).\r | |
292 | //\r | |
293 | Status = EfiLibInstallDriverBindingComponentName2 (\r | |
294 | ImageHandle,\r | |
295 | SystemTable,\r | |
296 | &gSataControllerDriverBinding,\r | |
297 | ImageHandle,\r | |
298 | &gSataControllerComponentName,\r | |
299 | &gSataControllerComponentName2\r | |
300 | );\r | |
301 | ASSERT_EFI_ERROR (Status);\r | |
302 | \r | |
303 | return Status;\r | |
304 | }\r | |
305 | \r | |
306 | /**\r | |
307 | Supported function of Driver Binding protocol for this driver.\r | |
308 | Test to see if this driver supports ControllerHandle.\r | |
309 | \r | |
310 | @param This Protocol instance pointer.\r | |
311 | @param Controller Handle of device to test.\r | |
312 | @param RemainingDevicePath A pointer to the device path.\r | |
313 | it should be ignored by device driver.\r | |
314 | \r | |
315 | @retval EFI_SUCCESS This driver supports this device.\r | |
316 | @retval EFI_ALREADY_STARTED This driver is already running on this device.\r | |
317 | @retval other This driver does not support this device.\r | |
318 | \r | |
319 | **/\r | |
320 | EFI_STATUS\r | |
321 | EFIAPI\r | |
322 | SataControllerSupported (\r | |
323 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
324 | IN EFI_HANDLE Controller,\r | |
325 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
326 | )\r | |
327 | {\r | |
328 | EFI_STATUS Status;\r | |
329 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
330 | PCI_TYPE00 PciData;\r | |
331 | \r | |
332 | //\r | |
333 | // Attempt to open PCI I/O Protocol\r | |
334 | //\r | |
335 | Status = gBS->OpenProtocol (\r | |
336 | Controller,\r | |
337 | &gEfiPciIoProtocolGuid,\r | |
338 | (VOID **) &PciIo,\r | |
339 | This->DriverBindingHandle,\r | |
340 | Controller,\r | |
341 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
342 | );\r | |
343 | if (EFI_ERROR (Status)) {\r | |
344 | return Status;\r | |
345 | }\r | |
346 | \r | |
347 | //\r | |
348 | // Now further check the PCI header: Base Class (offset 0x0B) and\r | |
349 | // Sub Class (offset 0x0A). This controller should be an SATA controller\r | |
350 | //\r | |
351 | Status = PciIo->Pci.Read (\r | |
352 | PciIo,\r | |
353 | EfiPciIoWidthUint8,\r | |
354 | PCI_CLASSCODE_OFFSET,\r | |
355 | sizeof (PciData.Hdr.ClassCode),\r | |
356 | PciData.Hdr.ClassCode\r | |
357 | );\r | |
358 | if (EFI_ERROR (Status)) {\r | |
359 | return EFI_UNSUPPORTED;\r | |
360 | }\r | |
361 | \r | |
362 | if (IS_PCI_IDE (&PciData) || IS_PCI_SATADPA (&PciData)) {\r | |
363 | return EFI_SUCCESS;\r | |
364 | }\r | |
365 | \r | |
366 | return EFI_UNSUPPORTED;\r | |
367 | }\r | |
368 | \r | |
369 | /**\r | |
370 | This routine is called right after the .Supported() called and \r | |
371 | Start this driver on ControllerHandle.\r | |
372 | \r | |
373 | @param This Protocol instance pointer.\r | |
374 | @param Controller Handle of device to bind driver to.\r | |
375 | @param RemainingDevicePath A pointer to the device path.\r | |
376 | it should be ignored by device driver.\r | |
377 | \r | |
378 | @retval EFI_SUCCESS This driver is added to this device.\r | |
379 | @retval EFI_ALREADY_STARTED This driver is already running on this device.\r | |
380 | @retval other Some error occurs when binding this driver to this device.\r | |
381 | \r | |
382 | **/\r | |
383 | EFI_STATUS\r | |
384 | EFIAPI\r | |
385 | SataControllerStart (\r | |
386 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
387 | IN EFI_HANDLE Controller,\r | |
388 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
389 | )\r | |
390 | {\r | |
391 | EFI_STATUS Status;\r | |
392 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
393 | PCI_TYPE00 PciData;\r | |
394 | EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r | |
395 | UINT32 Data32;\r | |
396 | UINTN ChannelDeviceCount;\r | |
397 | \r | |
398 | DEBUG ((EFI_D_INFO, "SataControllerStart START\n"));\r | |
399 | \r | |
400 | SataPrivateData = NULL;\r | |
401 | \r | |
402 | //\r | |
403 | // Now test and open PCI I/O Protocol\r | |
404 | //\r | |
405 | Status = gBS->OpenProtocol (\r | |
406 | Controller,\r | |
407 | &gEfiPciIoProtocolGuid,\r | |
408 | (VOID **) &PciIo,\r | |
409 | This->DriverBindingHandle,\r | |
410 | Controller,\r | |
411 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
412 | );\r | |
413 | if (EFI_ERROR (Status)) {\r | |
414 | DEBUG ((EFI_D_ERROR, "SataControllerStart error return status = %r\n", Status));\r | |
415 | return Status;\r | |
416 | }\r | |
417 | \r | |
418 | //\r | |
419 | // Allocate Sata Private Data structure\r | |
420 | //\r | |
421 | SataPrivateData = AllocateZeroPool (sizeof (EFI_SATA_CONTROLLER_PRIVATE_DATA));\r | |
422 | if (SataPrivateData == NULL) {\r | |
423 | Status = EFI_OUT_OF_RESOURCES;\r | |
424 | goto Done;\r | |
425 | }\r | |
426 | \r | |
427 | //\r | |
428 | // Initialize Sata Private Data\r | |
429 | //\r | |
430 | SataPrivateData->Signature = SATA_CONTROLLER_SIGNATURE;\r | |
431 | SataPrivateData->PciIo = PciIo;\r | |
432 | SataPrivateData->IdeInit.GetChannelInfo = IdeInitGetChannelInfo;\r | |
433 | SataPrivateData->IdeInit.NotifyPhase = IdeInitNotifyPhase;\r | |
434 | SataPrivateData->IdeInit.SubmitData = IdeInitSubmitData;\r | |
435 | SataPrivateData->IdeInit.DisqualifyMode = IdeInitDisqualifyMode;\r | |
436 | SataPrivateData->IdeInit.CalculateMode = IdeInitCalculateMode;\r | |
437 | SataPrivateData->IdeInit.SetTiming = IdeInitSetTiming;\r | |
438 | SataPrivateData->IdeInit.EnumAll = SATA_ENUMER_ALL;\r | |
439 | \r | |
440 | Status = PciIo->Pci.Read (\r | |
441 | PciIo,\r | |
442 | EfiPciIoWidthUint8,\r | |
443 | PCI_CLASSCODE_OFFSET,\r | |
444 | sizeof (PciData.Hdr.ClassCode),\r | |
445 | PciData.Hdr.ClassCode\r | |
446 | );\r | |
447 | ASSERT_EFI_ERROR (Status);\r | |
448 | \r | |
449 | if (IS_PCI_IDE (&PciData)) {\r | |
450 | SataPrivateData->IdeInit.ChannelCount = IDE_MAX_CHANNEL;\r | |
451 | SataPrivateData->DeviceCount = IDE_MAX_DEVICES;\r | |
452 | } else if (IS_PCI_SATADPA (&PciData)) {\r | |
453 | //\r | |
454 | // Read Host Capability Register(CAP) to get Number of Ports(NPS) and Supports Port Multiplier(SPM)\r | |
455 | // NPS is 0's based value indicating the maximum number of ports supported by the HBA silicon.\r | |
456 | // A maximum of 32 ports can be supported. A value of '0h', indicating one port, is the minimum requirement.\r | |
457 | //\r | |
458 | Data32 = AhciReadReg (PciIo, R_AHCI_CAP);\r | |
271c7901 | 459 | SataPrivateData->IdeInit.ChannelCount = (UINT8) ((Data32 & B_AHCI_CAP_NPS) + 1);\r |
27f30159 SZ |
460 | SataPrivateData->DeviceCount = AHCI_MAX_DEVICES;\r |
461 | if ((Data32 & B_AHCI_CAP_SPM) == B_AHCI_CAP_SPM) {\r | |
462 | SataPrivateData->DeviceCount = AHCI_MULTI_MAX_DEVICES;\r | |
463 | }\r | |
464 | }\r | |
465 | \r | |
466 | ChannelDeviceCount = (UINTN) (SataPrivateData->IdeInit.ChannelCount) * (UINTN) (SataPrivateData->DeviceCount);\r | |
467 | SataPrivateData->DisqulifiedModes = AllocateZeroPool ((sizeof (EFI_ATA_COLLECTIVE_MODE)) * ChannelDeviceCount);\r | |
468 | if (SataPrivateData->DisqulifiedModes == NULL) {\r | |
469 | Status = EFI_OUT_OF_RESOURCES;\r | |
470 | goto Done;\r | |
471 | }\r | |
472 | \r | |
473 | SataPrivateData->IdentifyData = AllocateZeroPool ((sizeof (EFI_IDENTIFY_DATA)) * ChannelDeviceCount);\r | |
474 | if (SataPrivateData->IdentifyData == NULL) {\r | |
475 | Status = EFI_OUT_OF_RESOURCES;\r | |
476 | goto Done;\r | |
477 | }\r | |
478 | \r | |
479 | SataPrivateData->IdentifyValid = AllocateZeroPool ((sizeof (BOOLEAN)) * ChannelDeviceCount);\r | |
480 | if (SataPrivateData->IdentifyValid == NULL) {\r | |
481 | Status = EFI_OUT_OF_RESOURCES;\r | |
482 | goto Done;\r | |
483 | }\r | |
484 | \r | |
485 | //\r | |
486 | // Install IDE Controller Init Protocol to this instance\r | |
487 | //\r | |
488 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
489 | &Controller,\r | |
490 | &gEfiIdeControllerInitProtocolGuid,\r | |
491 | &(SataPrivateData->IdeInit),\r | |
492 | NULL\r | |
493 | );\r | |
494 | \r | |
495 | Done:\r | |
496 | if (EFI_ERROR (Status)) {\r | |
497 | \r | |
498 | gBS->CloseProtocol (\r | |
499 | Controller,\r | |
500 | &gEfiPciIoProtocolGuid,\r | |
501 | This->DriverBindingHandle,\r | |
502 | Controller\r | |
503 | );\r | |
504 | if (SataPrivateData != NULL) {\r | |
505 | if (SataPrivateData->DisqulifiedModes != NULL) {\r | |
506 | FreePool (SataPrivateData->DisqulifiedModes);\r | |
507 | }\r | |
508 | if (SataPrivateData->IdentifyData != NULL) {\r | |
509 | FreePool (SataPrivateData->IdentifyData);\r | |
510 | }\r | |
511 | if (SataPrivateData->IdentifyValid != NULL) {\r | |
512 | FreePool (SataPrivateData->IdentifyValid);\r | |
513 | }\r | |
514 | FreePool (SataPrivateData);\r | |
515 | }\r | |
516 | }\r | |
517 | \r | |
518 | DEBUG ((EFI_D_INFO, "SataControllerStart END status = %r\n", Status));\r | |
519 | \r | |
520 | return Status;\r | |
521 | }\r | |
522 | \r | |
523 | /**\r | |
524 | Stop this driver on ControllerHandle.\r | |
525 | \r | |
526 | @param This Protocol instance pointer.\r | |
527 | @param Controller Handle of device to stop driver on.\r | |
528 | @param NumberOfChildren Not used.\r | |
529 | @param ChildHandleBuffer Not used.\r | |
530 | \r | |
531 | @retval EFI_SUCCESS This driver is removed from this device.\r | |
532 | @retval other Some error occurs when removing this driver from this device.\r | |
533 | \r | |
534 | **/\r | |
535 | EFI_STATUS\r | |
536 | EFIAPI\r | |
537 | SataControllerStop (\r | |
538 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
539 | IN EFI_HANDLE Controller,\r | |
540 | IN UINTN NumberOfChildren,\r | |
541 | IN EFI_HANDLE *ChildHandleBuffer\r | |
542 | )\r | |
543 | {\r | |
544 | EFI_STATUS Status;\r | |
545 | EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeInit;\r | |
546 | EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r | |
547 | \r | |
548 | //\r | |
549 | // Open the produced protocol\r | |
550 | //\r | |
551 | Status = gBS->OpenProtocol (\r | |
552 | Controller,\r | |
553 | &gEfiIdeControllerInitProtocolGuid,\r | |
554 | (VOID **) &IdeInit,\r | |
555 | This->DriverBindingHandle,\r | |
556 | Controller,\r | |
557 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
558 | );\r | |
559 | if (EFI_ERROR (Status)) {\r | |
560 | return EFI_UNSUPPORTED;\r | |
561 | }\r | |
562 | \r | |
563 | SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (IdeInit);\r | |
564 | ASSERT (SataPrivateData != NULL);\r | |
565 | \r | |
566 | //\r | |
567 | // Uninstall the IDE Controller Init Protocol from this instance\r | |
568 | //\r | |
569 | Status = gBS->UninstallMultipleProtocolInterfaces (\r | |
570 | Controller,\r | |
571 | &gEfiIdeControllerInitProtocolGuid,\r | |
572 | &(SataPrivateData->IdeInit),\r | |
573 | NULL\r | |
574 | );\r | |
575 | if (EFI_ERROR (Status)) {\r | |
576 | return Status;\r | |
577 | }\r | |
578 | \r | |
579 | if (SataPrivateData != NULL) {\r | |
580 | if (SataPrivateData->DisqulifiedModes != NULL) {\r | |
581 | FreePool (SataPrivateData->DisqulifiedModes);\r | |
582 | }\r | |
583 | if (SataPrivateData->IdentifyData != NULL) {\r | |
584 | FreePool (SataPrivateData->IdentifyData);\r | |
585 | }\r | |
586 | if (SataPrivateData->IdentifyValid != NULL) {\r | |
587 | FreePool (SataPrivateData->IdentifyValid);\r | |
588 | }\r | |
589 | FreePool (SataPrivateData);\r | |
590 | }\r | |
591 | \r | |
592 | //\r | |
593 | // Close protocols opened by Sata Controller driver\r | |
594 | //\r | |
595 | return gBS->CloseProtocol (\r | |
596 | Controller,\r | |
597 | &gEfiPciIoProtocolGuid,\r | |
598 | This->DriverBindingHandle,\r | |
599 | Controller\r | |
600 | );\r | |
601 | }\r | |
602 | \r | |
603 | //\r | |
604 | // Interface functions of IDE_CONTROLLER_INIT protocol\r | |
605 | //\r | |
606 | /**\r | |
607 | This function can be used to obtain information about a specified channel.\r | |
608 | It's usually used by IDE Bus driver during enumeration process.\r | |
609 | \r | |
610 | @param This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r | |
611 | @param Channel Channel number. Parallel ATA (PATA) controllers can support up to two channels.\r | |
612 | Advanced Host Controller Interface (AHCI) Serial ATA (SATA) controllers\r | |
613 | can support up to 32 channels, each of which can have up to 1 device.\r | |
614 | In the presence of a multiplier, each channel can have 15 devices.\r | |
615 | @param Enabled TRUE if the channel is enabled. If the channel is disabled,\r | |
616 | then it will no be enumerated.\r | |
617 | @param MaxDevices For Parallel ATA (PATA) controllers, this number will either be 1 or 2.\r | |
618 | For Serial ATA (SATA) controllers, it always be 1,\r | |
619 | but with a port multiplier, this number can be as large as 15.\r | |
620 | \r | |
621 | @retval EFI_SUCCESS Success to get channel information.\r | |
622 | @retval EFI_INVALID_PARAMETER Invalid channel id.\r | |
623 | **/\r | |
624 | EFI_STATUS\r | |
625 | EFIAPI\r | |
626 | IdeInitGetChannelInfo (\r | |
627 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
628 | IN UINT8 Channel,\r | |
629 | OUT BOOLEAN *Enabled,\r | |
630 | OUT UINT8 *MaxDevices\r | |
631 | )\r | |
632 | {\r | |
633 | EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r | |
634 | SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);\r | |
635 | ASSERT (SataPrivateData != NULL);\r | |
636 | \r | |
637 | if (Channel < This->ChannelCount) {\r | |
638 | *Enabled = TRUE;\r | |
639 | *MaxDevices = SataPrivateData->DeviceCount;\r | |
640 | return EFI_SUCCESS;\r | |
641 | }\r | |
642 | \r | |
643 | *Enabled = FALSE;\r | |
644 | return EFI_INVALID_PARAMETER;\r | |
645 | }\r | |
646 | \r | |
647 | /**\r | |
648 | This function is called by IdeBus driver before executing certain actions.\r | |
649 | This allows IDE Controller Init to prepare for each action.\r | |
650 | \r | |
651 | @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r | |
652 | @param Phase Phase indicator defined by IDE_CONTROLLER_INIT protocol.\r | |
653 | @param Channel Channel number.\r | |
654 | \r | |
655 | @retval EFI_SUCCESS Success operation.\r | |
656 | **/\r | |
657 | EFI_STATUS\r | |
658 | EFIAPI\r | |
659 | IdeInitNotifyPhase (\r | |
660 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
661 | IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase,\r | |
662 | IN UINT8 Channel\r | |
663 | )\r | |
664 | {\r | |
665 | return EFI_SUCCESS;\r | |
666 | }\r | |
667 | \r | |
668 | /**\r | |
669 | This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure\r | |
670 | obtained from IDE deivce. This structure is used to set IDE timing.\r | |
671 | \r | |
672 | @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r | |
673 | @param Channel Channel number.\r | |
674 | @param Device Device number.\r | |
675 | @param IdentifyData A pointer to EFI_IDENTIFY_DATA data structure.\r | |
676 | \r | |
677 | @retval EFI_SUCCESS The information is accepted without any errors.\r | |
678 | @retval EFI_INVALID_PARAMETER Invalid channel id or device id.\r | |
679 | **/\r | |
680 | EFI_STATUS\r | |
681 | EFIAPI\r | |
682 | IdeInitSubmitData (\r | |
683 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
684 | IN UINT8 Channel,\r | |
685 | IN UINT8 Device,\r | |
686 | IN EFI_IDENTIFY_DATA *IdentifyData\r | |
687 | )\r | |
688 | {\r | |
689 | EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r | |
690 | SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);\r | |
691 | ASSERT (SataPrivateData != NULL);\r | |
692 | \r | |
693 | if ((Channel >= This->ChannelCount) || (Device >= SataPrivateData->DeviceCount)) {\r | |
694 | return EFI_INVALID_PARAMETER;\r | |
695 | }\r | |
696 | \r | |
697 | //\r | |
698 | // Make a local copy of device's IdentifyData and mark the valid flag\r | |
699 | //\r | |
700 | if (IdentifyData != NULL) {\r | |
701 | CopyMem (\r | |
702 | &(SataPrivateData->IdentifyData[Channel * Device]),\r | |
703 | IdentifyData,\r | |
704 | sizeof (EFI_IDENTIFY_DATA)\r | |
705 | );\r | |
706 | \r | |
707 | SataPrivateData->IdentifyValid[Channel * Device] = TRUE;\r | |
708 | } else {\r | |
709 | SataPrivateData->IdentifyValid[Channel * Device] = FALSE;\r | |
710 | }\r | |
711 | \r | |
712 | return EFI_SUCCESS;\r | |
713 | }\r | |
714 | \r | |
715 | /**\r | |
716 | This function is called by IdeBus driver to disqualify unsupported operation\r | |
717 | mode on specfic IDE device.\r | |
718 | \r | |
719 | @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r | |
720 | @param Channel Channel number.\r | |
721 | @param Device Device number.\r | |
722 | @param BadModes The modes that the device does not support and that\r | |
723 | should be disqualified.\r | |
724 | \r | |
725 | @retval EFI_SUCCESS The modes were accepted without any errors.\r | |
726 | @retval EFI_INVALID_PARAMETER Invalid channel id or device id.\r | |
727 | **/\r | |
728 | EFI_STATUS\r | |
729 | EFIAPI\r | |
730 | IdeInitDisqualifyMode (\r | |
731 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
732 | IN UINT8 Channel,\r | |
733 | IN UINT8 Device,\r | |
734 | IN EFI_ATA_COLLECTIVE_MODE *BadModes\r | |
735 | )\r | |
736 | {\r | |
737 | EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r | |
738 | SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);\r | |
739 | ASSERT (SataPrivateData != NULL);\r | |
740 | \r | |
741 | if ((Channel >= This->ChannelCount) || (BadModes == NULL) || (Device >= SataPrivateData->DeviceCount)) {\r | |
742 | return EFI_INVALID_PARAMETER;\r | |
743 | }\r | |
744 | \r | |
745 | //\r | |
746 | // Record the disqualified modes per channel per device. From ATA/ATAPI spec,\r | |
747 | // if a mode is not supported, the modes higher than it is also not supported.\r | |
748 | //\r | |
749 | CopyMem (\r | |
750 | &(SataPrivateData->DisqulifiedModes[Channel * Device]),\r | |
751 | BadModes,\r | |
752 | sizeof (EFI_ATA_COLLECTIVE_MODE)\r | |
753 | );\r | |
754 | \r | |
755 | return EFI_SUCCESS;\r | |
756 | }\r | |
757 | \r | |
758 | /**\r | |
759 | This function is called by IdeBus driver to calculate the best operation mode\r | |
760 | supported by specific IDE device.\r | |
761 | \r | |
762 | @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r | |
763 | @param Channel Channel number.\r | |
764 | @param Device Device number.\r | |
765 | @param SupportedModes The optimum modes for the device.\r | |
766 | \r | |
767 | @retval EFI_SUCCESS Supported modes are returned.\r | |
768 | @retval EFI_INVALID_PARAMETER Invalid channel id or device id.\r | |
769 | @retval EFI_OUT_OF_RESOURCES Fail to allocate pool.\r | |
770 | @retval EFI_NOT_READY Identify data of the device is not ready.\r | |
771 | **/\r | |
772 | EFI_STATUS\r | |
773 | EFIAPI\r | |
774 | IdeInitCalculateMode (\r | |
775 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
776 | IN UINT8 Channel,\r | |
777 | IN UINT8 Device,\r | |
778 | OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes\r | |
779 | )\r | |
780 | {\r | |
781 | EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r | |
782 | EFI_IDENTIFY_DATA *IdentifyData;\r | |
783 | BOOLEAN IdentifyValid;\r | |
784 | EFI_ATA_COLLECTIVE_MODE *DisqulifiedModes;\r | |
785 | UINT16 SelectedMode;\r | |
786 | EFI_STATUS Status;\r | |
787 | \r | |
788 | SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);\r | |
789 | ASSERT (SataPrivateData != NULL);\r | |
790 | \r | |
791 | if ((Channel >= This->ChannelCount) || (SupportedModes == NULL) || (Device >= SataPrivateData->DeviceCount)) {\r | |
792 | return EFI_INVALID_PARAMETER;\r | |
793 | }\r | |
794 | \r | |
795 | *SupportedModes = AllocateZeroPool (sizeof (EFI_ATA_COLLECTIVE_MODE));\r | |
796 | if (*SupportedModes == NULL) {\r | |
797 | return EFI_OUT_OF_RESOURCES;\r | |
798 | }\r | |
799 | \r | |
800 | IdentifyData = &(SataPrivateData->IdentifyData[Channel * Device]);\r | |
801 | IdentifyValid = SataPrivateData->IdentifyValid[Channel * Device];\r | |
802 | DisqulifiedModes = &(SataPrivateData->DisqulifiedModes[Channel * Device]);\r | |
803 | \r | |
804 | //\r | |
805 | // Make sure we've got the valid identify data of the device from SubmitData()\r | |
806 | //\r | |
807 | if (!IdentifyValid) {\r | |
808 | return EFI_NOT_READY;\r | |
809 | }\r | |
810 | \r | |
811 | Status = CalculateBestPioMode (\r | |
812 | IdentifyData,\r | |
813 | (DisqulifiedModes->PioMode.Valid ? ((UINT16 *) &(DisqulifiedModes->PioMode.Mode)) : NULL),\r | |
814 | &SelectedMode\r | |
815 | );\r | |
816 | if (!EFI_ERROR (Status)) {\r | |
817 | (*SupportedModes)->PioMode.Valid = TRUE;\r | |
818 | (*SupportedModes)->PioMode.Mode = SelectedMode;\r | |
819 | \r | |
820 | } else {\r | |
821 | (*SupportedModes)->PioMode.Valid = FALSE;\r | |
822 | }\r | |
823 | DEBUG ((EFI_D_INFO, "IdeInitCalculateMode: PioMode = %x\n", (*SupportedModes)->PioMode.Mode));\r | |
824 | \r | |
825 | Status = CalculateBestUdmaMode (\r | |
826 | IdentifyData,\r | |
827 | (DisqulifiedModes->UdmaMode.Valid ? ((UINT16 *) &(DisqulifiedModes->UdmaMode.Mode)) : NULL),\r | |
828 | &SelectedMode\r | |
829 | );\r | |
830 | \r | |
831 | if (!EFI_ERROR (Status)) {\r | |
832 | (*SupportedModes)->UdmaMode.Valid = TRUE;\r | |
833 | (*SupportedModes)->UdmaMode.Mode = SelectedMode;\r | |
834 | \r | |
835 | } else {\r | |
836 | (*SupportedModes)->UdmaMode.Valid = FALSE;\r | |
837 | }\r | |
838 | DEBUG ((EFI_D_INFO, "IdeInitCalculateMode: UdmaMode = %x\n", (*SupportedModes)->UdmaMode.Mode));\r | |
839 | \r | |
840 | //\r | |
841 | // The modes other than PIO and UDMA are not supported\r | |
842 | //\r | |
843 | return EFI_SUCCESS;\r | |
844 | }\r | |
845 | \r | |
846 | /**\r | |
847 | This function is called by IdeBus driver to set appropriate timing on IDE\r | |
848 | controller according supported operation mode.\r | |
849 | \r | |
850 | @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r | |
851 | @param Channel Channel number.\r | |
852 | @param Device Device number.\r | |
853 | @param Modes The modes to set.\r | |
854 | \r | |
855 | @retval EFI_SUCCESS Sucess operation.\r | |
856 | **/\r | |
857 | EFI_STATUS\r | |
858 | EFIAPI\r | |
859 | IdeInitSetTiming (\r | |
860 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
861 | IN UINT8 Channel,\r | |
862 | IN UINT8 Device,\r | |
863 | IN EFI_ATA_COLLECTIVE_MODE *Modes\r | |
864 | )\r | |
865 | {\r | |
866 | return EFI_SUCCESS;\r | |
867 | }\r |