]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacySio.c
IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / IntelFrameworkModulePkg / Csm / LegacyBiosDxe / LegacySio.c
CommitLineData
bcecde14 1/** @file\r
2 Collect Sio information from Native EFI Drivers.\r
3 Sio is floppy, parallel, serial, ... hardware\r
4\r
26a7ece7 5Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
bcecde14 6\r
c0a00b14 7SPDX-License-Identifier: BSD-2-Clause-Patent\r
bcecde14 8\r
9**/\r
10\r
11#include "LegacyBiosInterface.h"\r
12\r
62ade6d2
RN
13/**\r
14 Collect EFI Info about legacy devices through Super IO interface.\r
15\r
16 @param SioPtr Pointer to SIO data.\r
17\r
18 @retval EFI_SUCCESS When SIO data is got successfully.\r
19 @retval EFI_NOT_FOUND When ISA IO interface is absent.\r
20\r
21**/\r
22EFI_STATUS\r
23LegacyBiosBuildSioDataFromSio (\r
24 IN DEVICE_PRODUCER_DATA_HEADER *SioPtr\r
25 )\r
26{\r
27 EFI_STATUS Status;\r
28 DEVICE_PRODUCER_SERIAL *SioSerial;\r
29 DEVICE_PRODUCER_PARALLEL *SioParallel;\r
30 DEVICE_PRODUCER_FLOPPY *SioFloppy;\r
31 UINTN HandleCount;\r
32 EFI_HANDLE *HandleBuffer;\r
33 UINTN Index;\r
34 UINTN ChildIndex;\r
35 EFI_SIO_PROTOCOL *Sio;\r
36 ACPI_RESOURCE_HEADER_PTR Resources;\r
37 EFI_ACPI_IO_PORT_DESCRIPTOR *IoResource;\r
38 EFI_ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR *FixedIoResource;\r
39 EFI_ACPI_DMA_DESCRIPTOR *DmaResource;\r
40 EFI_ACPI_IRQ_NOFLAG_DESCRIPTOR *IrqResource;\r
41 UINT16 Address;\r
42 UINT8 Dma;\r
43 UINT8 Irq;\r
44 UINTN EntryCount;\r
45 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfoBuffer;\r
46 EFI_BLOCK_IO_PROTOCOL *BlockIo;\r
47 EFI_SERIAL_IO_PROTOCOL *SerialIo;\r
48 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
49 ACPI_HID_DEVICE_PATH *Acpi;\r
50\r
51 //\r
52 // Get the list of ISA controllers in the system\r
53 //\r
54 Status = gBS->LocateHandleBuffer (\r
55 ByProtocol,\r
56 &gEfiSioProtocolGuid,\r
57 NULL,\r
58 &HandleCount,\r
59 &HandleBuffer\r
60 );\r
61 if (EFI_ERROR (Status)) {\r
62 return EFI_NOT_FOUND;\r
63 }\r
64 //\r
65 // Collect legacy information from each of the ISA controllers in the system\r
66 //\r
67 for (Index = 0; Index < HandleCount; Index++) {\r
68 Status = gBS->HandleProtocol (HandleBuffer[Index], &gEfiSioProtocolGuid, (VOID **) &Sio);\r
69 if (EFI_ERROR (Status)) {\r
70 continue;\r
71 }\r
72\r
73 Address = MAX_UINT16;\r
74 Dma = MAX_UINT8;\r
75 Irq = MAX_UINT8;\r
76 Status = Sio->GetResources (Sio, &Resources);\r
77 if (!EFI_ERROR (Status)) {\r
78 //\r
79 // Get the base address information from ACPI resource descriptor.\r
80 //\r
81 while (Resources.SmallHeader->Byte != ACPI_END_TAG_DESCRIPTOR) {\r
82 switch (Resources.SmallHeader->Byte) {\r
83 case ACPI_IO_PORT_DESCRIPTOR:\r
84 IoResource = (EFI_ACPI_IO_PORT_DESCRIPTOR *) Resources.SmallHeader;\r
85 Address = IoResource->BaseAddressMin;\r
86 break;\r
87\r
88 case ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR:\r
89 FixedIoResource = (EFI_ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR *) Resources.SmallHeader;\r
90 Address = FixedIoResource->BaseAddress;\r
91 break;\r
92\r
93 case ACPI_DMA_DESCRIPTOR:\r
94 DmaResource = (EFI_ACPI_DMA_DESCRIPTOR *) Resources.SmallHeader;\r
95 Dma = (UINT8) LowBitSet32 (DmaResource->ChannelMask);\r
96 break;\r
97\r
98 case ACPI_IRQ_DESCRIPTOR:\r
99 case ACPI_IRQ_NOFLAG_DESCRIPTOR:\r
100 IrqResource = (EFI_ACPI_IRQ_NOFLAG_DESCRIPTOR *) Resources.SmallHeader;\r
101 Irq = (UINT8) LowBitSet32 (IrqResource->Mask);\r
102 break;\r
103\r
104 default:\r
105 break;\r
106 }\r
107\r
108 if (Resources.SmallHeader->Bits.Type == 0) {\r
109 Resources.SmallHeader = (ACPI_SMALL_RESOURCE_HEADER *) ((UINT8 *) Resources.SmallHeader\r
110 + Resources.SmallHeader->Bits.Length\r
111 + sizeof (*Resources.SmallHeader));\r
112 } else {\r
113 Resources.LargeHeader = (ACPI_LARGE_RESOURCE_HEADER *) ((UINT8 *) Resources.LargeHeader\r
114 + Resources.LargeHeader->Length\r
115 + sizeof (*Resources.LargeHeader));\r
116 }\r
117 }\r
118 }\r
119\r
120 DEBUG ((EFI_D_INFO, "LegacySio: Address/Dma/Irq = %x/%d/%d\n", Address, Dma, Irq));\r
121\r
122 DevicePath = DevicePathFromHandle (HandleBuffer[Index]);\r
123 if (DevicePath == NULL) {\r
124 continue;\r
125 }\r
126\r
127 Acpi = NULL;\r
128 while (!IsDevicePathEnd (DevicePath)) {\r
129 Acpi = (ACPI_HID_DEVICE_PATH *) DevicePath;\r
130 DevicePath = NextDevicePathNode (DevicePath);\r
131 }\r
132\r
133 if ((Acpi == NULL) || (DevicePathType (Acpi) != ACPI_DEVICE_PATH) ||\r
134 ((DevicePathSubType (Acpi) != ACPI_DP) && (DevicePathSubType (Acpi) != ACPI_EXTENDED_DP))\r
135 ) {\r
136 continue;\r
137 }\r
138\r
139 //\r
140 // See if this is an ISA serial port\r
141 //\r
142 // Ignore DMA resource since it is always returned NULL\r
143 //\r
144 if (Acpi->HID == EISA_PNP_ID (0x500) || Acpi->HID == EISA_PNP_ID (0x501)) {\r
145\r
146 if (Acpi->UID < 4 && Address != MAX_UINT16 && Irq != MAX_UINT8) {\r
147 //\r
148 // Get the handle of the child device that has opened the Super I/O Protocol\r
149 //\r
150 Status = gBS->OpenProtocolInformation (\r
151 HandleBuffer[Index],\r
152 &gEfiSioProtocolGuid,\r
153 &OpenInfoBuffer,\r
154 &EntryCount\r
155 );\r
156 if (EFI_ERROR (Status)) {\r
157 continue;\r
158 }\r
159 for (ChildIndex = 0; ChildIndex < EntryCount; ChildIndex++) {\r
160 if ((OpenInfoBuffer[ChildIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
161 Status = gBS->HandleProtocol (OpenInfoBuffer[ChildIndex].ControllerHandle, &gEfiSerialIoProtocolGuid, (VOID **) &SerialIo);\r
162 if (!EFI_ERROR (Status)) {\r
163 SioSerial = &SioPtr->Serial[Acpi->UID];\r
164 SioSerial->Address = Address;\r
165 SioSerial->Irq = Irq;\r
166 SioSerial->Mode = DEVICE_SERIAL_MODE_NORMAL | DEVICE_SERIAL_MODE_DUPLEX_HALF;\r
167 break;\r
168 }\r
169 }\r
170 }\r
171\r
172 FreePool (OpenInfoBuffer);\r
173 }\r
174 }\r
175 //\r
176 // See if this is an ISA parallel port\r
177 //\r
178 // Ignore DMA resource since it is always returned NULL, port\r
179 // only used in output mode.\r
180 //\r
181 if (Acpi->HID == EISA_PNP_ID (0x400) || Acpi->HID == EISA_PNP_ID (0x401)) {\r
182 if (Acpi->UID < 3 && Address != MAX_UINT16 && Irq != MAX_UINT8 && Dma != MAX_UINT8) {\r
183 SioParallel = &SioPtr->Parallel[Acpi->UID];\r
184 SioParallel->Address = Address;\r
185 SioParallel->Irq = Irq;\r
186 SioParallel->Dma = Dma;\r
187 SioParallel->Mode = DEVICE_PARALLEL_MODE_MODE_OUTPUT_ONLY;\r
188 }\r
189 }\r
190 //\r
191 // See if this is an ISA floppy controller\r
192 //\r
193 if (Acpi->HID == EISA_PNP_ID (0x604)) {\r
194 if (Address != MAX_UINT16 && Irq != MAX_UINT8 && Dma != MAX_UINT8) {\r
195 Status = gBS->HandleProtocol (HandleBuffer[Index], &gEfiBlockIoProtocolGuid, (VOID **) &BlockIo);\r
196 if (!EFI_ERROR (Status)) {\r
197 SioFloppy = &SioPtr->Floppy;\r
198 SioFloppy->Address = Address;\r
199 SioFloppy->Irq = Irq;\r
200 SioFloppy->Dma = Dma;\r
201 SioFloppy->NumberOfFloppy++;\r
202 }\r
203 }\r
204 }\r
205 //\r
206 // See if this is a mouse\r
207 // Always set mouse found so USB hot plug will work\r
208 //\r
209 // Ignore lower byte of HID. Pnp0fxx is any type of mouse.\r
210 //\r
211 // Hid = ResourceList->Device.HID & 0xff00ffff;\r
212 // PnpId = EISA_PNP_ID(0x0f00);\r
213 // if (Hid == PnpId) {\r
214 // if (ResourceList->Device.UID == 1) {\r
215 // Status = gBS->HandleProtocol (HandleBuffer[Index], &gEfiSimplePointerProtocolGuid, &SimplePointer);\r
216 // if (!EFI_ERROR (Status)) {\r
217 //\r
218 SioPtr->MousePresent = 0x01;\r
219 //\r
220 // }\r
221 // }\r
222 // }\r
223 //\r
224 }\r
225\r
226 FreePool (HandleBuffer);\r
227 return EFI_SUCCESS;\r
228\r
229}\r
bcecde14 230\r
231/**\r
26a7ece7 232 Collect EFI Info about legacy devices through ISA IO interface.\r
bcecde14 233\r
26a7ece7 234 @param SioPtr Pointer to SIO data.\r
bcecde14 235\r
7053060f
RN
236 @retval EFI_SUCCESS When SIO data is got successfully.\r
237 @retval EFI_NOT_FOUND When ISA IO interface is absent.\r
bcecde14 238\r
239**/\r
240EFI_STATUS\r
26a7ece7
RN
241LegacyBiosBuildSioDataFromIsaIo (\r
242 IN DEVICE_PRODUCER_DATA_HEADER *SioPtr\r
bcecde14 243 )\r
244{\r
245 EFI_STATUS Status;\r
aa7f11db
RN
246 DEVICE_PRODUCER_SERIAL *SioSerial;\r
247 DEVICE_PRODUCER_PARALLEL *SioParallel;\r
248 DEVICE_PRODUCER_FLOPPY *SioFloppy;\r
bcecde14 249 UINTN HandleCount;\r
250 EFI_HANDLE *HandleBuffer;\r
251 UINTN Index;\r
252 UINTN ResourceIndex;\r
253 UINTN ChildIndex;\r
254 EFI_ISA_IO_PROTOCOL *IsaIo;\r
255 EFI_ISA_ACPI_RESOURCE_LIST *ResourceList;\r
256 EFI_ISA_ACPI_RESOURCE *IoResource;\r
257 EFI_ISA_ACPI_RESOURCE *DmaResource;\r
258 EFI_ISA_ACPI_RESOURCE *InterruptResource;\r
259 UINTN EntryCount;\r
260 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfoBuffer;\r
261 EFI_BLOCK_IO_PROTOCOL *BlockIo;\r
faef6952 262 EFI_SERIAL_IO_PROTOCOL *SerialIo;\r
bcecde14 263\r
bcecde14 264 //\r
265 // Get the list of ISA controllers in the system\r
266 //\r
267 Status = gBS->LocateHandleBuffer (\r
268 ByProtocol,\r
269 &gEfiIsaIoProtocolGuid,\r
270 NULL,\r
271 &HandleCount,\r
272 &HandleBuffer\r
273 );\r
274 if (EFI_ERROR (Status)) {\r
7053060f 275 return EFI_NOT_FOUND;\r
bcecde14 276 }\r
277 //\r
278 // Collect legacy information from each of the ISA controllers in the system\r
279 //\r
280 for (Index = 0; Index < HandleCount; Index++) {\r
281\r
282 Status = gBS->HandleProtocol (HandleBuffer[Index], &gEfiIsaIoProtocolGuid, (VOID **) &IsaIo);\r
283 if (EFI_ERROR (Status)) {\r
284 continue;\r
285 }\r
286\r
287 ResourceList = IsaIo->ResourceList;\r
288\r
289 if (ResourceList == NULL) {\r
290 continue;\r
291 }\r
292 //\r
293 // Collect the resource types neededto fill in the SIO data structure\r
294 //\r
295 IoResource = NULL;\r
296 DmaResource = NULL;\r
297 InterruptResource = NULL;\r
298 for (ResourceIndex = 0;\r
299 ResourceList->ResourceItem[ResourceIndex].Type != EfiIsaAcpiResourceEndOfList;\r
300 ResourceIndex++\r
301 ) {\r
302 switch (ResourceList->ResourceItem[ResourceIndex].Type) {\r
303 case EfiIsaAcpiResourceIo:\r
304 IoResource = &ResourceList->ResourceItem[ResourceIndex];\r
305 break;\r
306\r
307 case EfiIsaAcpiResourceMemory:\r
308 break;\r
309\r
310 case EfiIsaAcpiResourceDma:\r
311 DmaResource = &ResourceList->ResourceItem[ResourceIndex];\r
312 break;\r
313\r
314 case EfiIsaAcpiResourceInterrupt:\r
315 InterruptResource = &ResourceList->ResourceItem[ResourceIndex];\r
316 break;\r
317\r
318 default:\r
319 break;\r
320 }\r
321 }\r
322 //\r
323 // See if this is an ISA serial port\r
324 //\r
325 // Ignore DMA resource since it is always returned NULL\r
326 //\r
327 if (ResourceList->Device.HID == EISA_PNP_ID (0x500) || ResourceList->Device.HID == EISA_PNP_ID (0x501)) {\r
328\r
329 if (ResourceList->Device.UID <= 3 &&\r
330 IoResource != NULL &&\r
331 InterruptResource != NULL\r
332 ) {\r
333 //\r
334 // Get the handle of the child device that has opened the ISA I/O Protocol\r
335 //\r
336 Status = gBS->OpenProtocolInformation (\r
337 HandleBuffer[Index],\r
338 &gEfiIsaIoProtocolGuid,\r
339 &OpenInfoBuffer,\r
340 &EntryCount\r
341 );\r
342 if (EFI_ERROR (Status)) {\r
343 continue;\r
344 }\r
345 //\r
346 // We want resource for legacy even if no 32-bit driver installed\r
347 //\r
348 for (ChildIndex = 0; ChildIndex < EntryCount; ChildIndex++) {\r
faef6952 349 if ((OpenInfoBuffer[ChildIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
83155d7e 350 Status = gBS->HandleProtocol (OpenInfoBuffer[ChildIndex].ControllerHandle, &gEfiSerialIoProtocolGuid, (VOID **) &SerialIo);\r
faef6952
RN
351 if (!EFI_ERROR (Status)) {\r
352 SioSerial = &SioPtr->Serial[ResourceList->Device.UID];\r
353 SioSerial->Address = (UINT16) IoResource->StartRange;\r
354 SioSerial->Irq = (UINT8) InterruptResource->StartRange;\r
355 SioSerial->Mode = DEVICE_SERIAL_MODE_NORMAL | DEVICE_SERIAL_MODE_DUPLEX_HALF;\r
356 break;\r
357 }\r
358 }\r
bcecde14 359 }\r
360\r
361 FreePool (OpenInfoBuffer);\r
362 }\r
363 }\r
364 //\r
365 // See if this is an ISA parallel port\r
366 //\r
367 // Ignore DMA resource since it is always returned NULL, port\r
368 // only used in output mode.\r
369 //\r
370 if (ResourceList->Device.HID == EISA_PNP_ID (0x400) || ResourceList->Device.HID == EISA_PNP_ID (0x401)) {\r
371 if (ResourceList->Device.UID <= 2 &&\r
372 IoResource != NULL &&\r
373 InterruptResource != NULL &&\r
374 DmaResource != NULL\r
375 ) {\r
aa7f11db
RN
376 SioParallel = &SioPtr->Parallel[ResourceList->Device.UID];\r
377 SioParallel->Address = (UINT16) IoResource->StartRange;\r
378 SioParallel->Irq = (UINT8) InterruptResource->StartRange;\r
379 SioParallel->Dma = (UINT8) DmaResource->StartRange;\r
380 SioParallel->Mode = DEVICE_PARALLEL_MODE_MODE_OUTPUT_ONLY;\r
bcecde14 381 }\r
382 }\r
383 //\r
384 // See if this is an ISA floppy controller\r
385 //\r
386 if (ResourceList->Device.HID == EISA_PNP_ID (0x604)) {\r
387 if (IoResource != NULL && InterruptResource != NULL && DmaResource != NULL) {\r
388 Status = gBS->HandleProtocol (HandleBuffer[Index], &gEfiBlockIoProtocolGuid, (VOID **) &BlockIo);\r
389 if (!EFI_ERROR (Status)) {\r
aa7f11db
RN
390 SioFloppy = &SioPtr->Floppy;\r
391 SioFloppy->Address = (UINT16) IoResource->StartRange;\r
392 SioFloppy->Irq = (UINT8) InterruptResource->StartRange;\r
393 SioFloppy->Dma = (UINT8) DmaResource->StartRange;\r
394 SioFloppy->NumberOfFloppy++;\r
bcecde14 395 }\r
396 }\r
397 }\r
398 //\r
399 // See if this is a mouse\r
400 // Always set mouse found so USB hot plug will work\r
401 //\r
402 // Ignore lower byte of HID. Pnp0fxx is any type of mouse.\r
403 //\r
404 // Hid = ResourceList->Device.HID & 0xff00ffff;\r
405 // PnpId = EISA_PNP_ID(0x0f00);\r
406 // if (Hid == PnpId) {\r
407 // if (ResourceList->Device.UID == 1) {\r
408 // Status = gBS->HandleProtocol (HandleBuffer[Index], &gEfiSimplePointerProtocolGuid, &SimplePointer);\r
409 // if (!EFI_ERROR (Status)) {\r
410 //\r
411 SioPtr->MousePresent = 0x01;\r
412 //\r
413 // }\r
414 // }\r
415 // }\r
416 //\r
417 }\r
418\r
419 FreePool (HandleBuffer);\r
26a7ece7
RN
420 return EFI_SUCCESS;\r
421}\r
422\r
423/**\r
424 Collect EFI Info about legacy devices.\r
425\r
426 @param Private Legacy BIOS Instance data\r
427\r
428 @retval EFI_SUCCESS It should always work.\r
429\r
430**/\r
431EFI_STATUS\r
432LegacyBiosBuildSioData (\r
433 IN LEGACY_BIOS_INSTANCE *Private\r
434 )\r
435{\r
436 EFI_STATUS Status;\r
437 DEVICE_PRODUCER_DATA_HEADER *SioPtr;\r
438 EFI_HANDLE IsaBusController;\r
439 UINTN HandleCount;\r
440 EFI_HANDLE *HandleBuffer;\r
441\r
442 //\r
443 // Get the pointer to the SIO data structure\r
444 //\r
445 SioPtr = &Private->IntThunk->EfiToLegacy16BootTable.SioData;\r
446\r
447 //\r
448 // Zero the data in the SIO data structure\r
449 //\r
450 gBS->SetMem (SioPtr, sizeof (DEVICE_PRODUCER_DATA_HEADER), 0);\r
451\r
452 //\r
453 // Find the ISA Bus Controller used for legacy\r
454 //\r
455 Status = Private->LegacyBiosPlatform->GetPlatformHandle (\r
456 Private->LegacyBiosPlatform,\r
457 EfiGetPlatformIsaBusHandle,\r
458 0,\r
459 &HandleBuffer,\r
460 &HandleCount,\r
461 NULL\r
462 );\r
463 IsaBusController = HandleBuffer[0];\r
464 if (!EFI_ERROR (Status)) {\r
465 //\r
466 // Force ISA Bus Controller to produce all ISA devices\r
467 //\r
468 gBS->ConnectController (IsaBusController, NULL, NULL, TRUE);\r
469 }\r
470\r
62ade6d2
RN
471 Status = LegacyBiosBuildSioDataFromIsaIo (SioPtr);\r
472 if (EFI_ERROR (Status)) {\r
473 LegacyBiosBuildSioDataFromSio (SioPtr);\r
474 }\r
bcecde14 475\r
476 return EFI_SUCCESS;\r
477}\r