3 Copyright (c) 2008-2009, Apple Inc. All rights reserved.
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "PciEmulation.h"
16 #include <Omap3530/Omap3530.h>
18 EFI_CPU_ARCH_PROTOCOL
*gCpu
;
19 EMBEDDED_EXTERNAL_DEVICE
*gTPS65950
;
21 #define HOST_CONTROLLER_OPERATION_REG_SIZE 0x44
24 ACPI_HID_DEVICE_PATH AcpiDevicePath
;
25 PCI_DEVICE_PATH PciDevicePath
;
26 EFI_DEVICE_PATH_PROTOCOL EndDevicePath
;
27 } EFI_PCI_IO_DEVICE_PATH
;
31 EFI_PCI_IO_DEVICE_PATH DevicePath
;
32 EFI_PCI_IO_PROTOCOL PciIoProtocol
;
33 PCI_TYPE00
*ConfigSpace
;
34 PCI_ROOT_BRIDGE RootBridge
;
36 } EFI_PCI_IO_PRIVATE_DATA
;
38 #define EFI_PCI_IO_PRIVATE_DATA_SIGNATURE SIGNATURE_32('p', 'c', 'i', 'o')
39 #define EFI_PCI_IO_PRIVATE_DATA_FROM_THIS(a) CR(a, EFI_PCI_IO_PRIVATE_DATA, PciIoProtocol, EFI_PCI_IO_PRIVATE_DATA_SIGNATURE)
41 EFI_PCI_IO_DEVICE_PATH PciIoDevicePathTemplate
=
44 { ACPI_DEVICE_PATH
, ACPI_DP
, sizeof (ACPI_HID_DEVICE_PATH
), 0},
45 EISA_PNP_ID(0x0A03), // HID
49 { HARDWARE_DEVICE_PATH
, HW_PCI_DP
, sizeof (PCI_DEVICE_PATH
), 0},
53 { END_DEVICE_PATH_TYPE
, END_ENTIRE_DEVICE_PATH_SUBTYPE
, sizeof (EFI_DEVICE_PATH_PROTOCOL
), 0}
65 // Take USB host out of force-standby mode
66 MmioWrite32(UHH_SYSCONFIG
, UHH_SYSCONFIG_MIDLEMODE_NO_STANDBY
67 | UHH_SYSCONFIG_CLOCKACTIVITY_ON
68 | UHH_SYSCONFIG_SIDLEMODE_NO_STANDBY
69 | UHH_SYSCONFIG_ENAWAKEUP_ENABLE
70 | UHH_SYSCONFIG_AUTOIDLE_ALWAYS_RUN
);
71 MmioWrite32(UHH_HOSTCONFIG
, UHH_HOSTCONFIG_P3_CONNECT_STATUS_DISCONNECT
72 | UHH_HOSTCONFIG_P2_CONNECT_STATUS_DISCONNECT
73 | UHH_HOSTCONFIG_P1_CONNECT_STATUS_DISCONNECT
74 | UHH_HOSTCONFIG_ENA_INCR_ALIGN_DISABLE
75 | UHH_HOSTCONFIG_ENA_INCR16_ENABLE
76 | UHH_HOSTCONFIG_ENA_INCR8_ENABLE
77 | UHH_HOSTCONFIG_ENA_INCR4_ENABLE
78 | UHH_HOSTCONFIG_AUTOPPD_ON_OVERCUR_EN_ON
79 | UHH_HOSTCONFIG_P1_ULPI_BYPASS_ULPI_MODE
);
81 // USB reset (GPIO 147 - Port 5 pin 19) output high
82 MmioAnd32(GPIO5_BASE
+ GPIO_OE
, ~BIT19
);
83 MmioWrite32(GPIO5_BASE
+ GPIO_SETDATAOUT
, BIT19
);
85 // Get the Power IC protocol.
86 Status
= gBS
->LocateProtocol(&gEmbeddedExternalDeviceProtocolGuid
, NULL
, (VOID
**)&gTPS65950
);
87 ASSERT_EFI_ERROR(Status
);
89 //Enable power to the USB host.
90 Status
= gTPS65950
->Read(gTPS65950
, EXTERNAL_DEVICE_REGISTER(I2C_ADDR_GRP_ID3
, LEDEN
), 1, &Data
);
91 ASSERT_EFI_ERROR(Status
);
93 //LEDAON & LEDAPWM control the power to the USB host so enable those bits.
94 Data
|= (LEDAON
| LEDAPWM
);
96 Status
= gTPS65950
->Write(gTPS65950
, EXTERNAL_DEVICE_REGISTER(I2C_ADDR_GRP_ID3
, LEDEN
), 1, &Data
);
97 ASSERT_EFI_ERROR(Status
);
102 IN EFI_PCI_IO_PROTOCOL
*This
,
103 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
113 return EFI_UNSUPPORTED
;
118 IN EFI_PCI_IO_PROTOCOL
*This
,
119 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
129 return EFI_UNSUPPORTED
;
134 IN EFI_PCI_IO_PROTOCOL
*This
,
135 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
142 EFI_PCI_IO_PRIVATE_DATA
*Private
= EFI_PCI_IO_PRIVATE_DATA_FROM_THIS(This
);
144 return PciRootBridgeIoMemRead (&Private
->RootBridge
.Io
,
145 (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
) Width
,
146 Private
->ConfigSpace
->Device
.Bar
[BarIndex
] + Offset
,
154 IN EFI_PCI_IO_PROTOCOL
*This
,
155 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
162 EFI_PCI_IO_PRIVATE_DATA
*Private
= EFI_PCI_IO_PRIVATE_DATA_FROM_THIS(This
);
164 return PciRootBridgeIoMemWrite (&Private
->RootBridge
.Io
,
165 (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
) Width
,
166 Private
->ConfigSpace
->Device
.Bar
[BarIndex
] + Offset
,
174 IN EFI_PCI_IO_PROTOCOL
*This
,
175 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
183 return EFI_UNSUPPORTED
;
188 IN EFI_PCI_IO_PROTOCOL
*This
,
189 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
197 return EFI_UNSUPPORTED
;
202 IN EFI_PCI_IO_PROTOCOL
*This
,
203 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
209 EFI_PCI_IO_PRIVATE_DATA
*Private
= EFI_PCI_IO_PRIVATE_DATA_FROM_THIS(This
);
211 return PciRootBridgeIoMemRW ((EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
)Width
,
216 (PTR
)(UINTN
)(((UINT8
*)Private
->ConfigSpace
) + Offset
)
222 IN EFI_PCI_IO_PROTOCOL
*This
,
223 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
229 EFI_PCI_IO_PRIVATE_DATA
*Private
= EFI_PCI_IO_PRIVATE_DATA_FROM_THIS(This
);
231 return PciRootBridgeIoMemRW ((EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
) Width
,
234 (PTR
)(UINTN
)(((UINT8
*)Private
->ConfigSpace
) + Offset
),
242 IN EFI_PCI_IO_PROTOCOL
*This
,
243 IN EFI_PCI_IO_PROTOCOL_WIDTH Width
,
244 IN UINT8 DestBarIndex
,
245 IN UINT64 DestOffset
,
246 IN UINT8 SrcBarIndex
,
252 return EFI_UNSUPPORTED
;
257 IN EFI_PCI_IO_PROTOCOL
*This
,
258 IN EFI_PCI_IO_PROTOCOL_OPERATION Operation
,
259 IN VOID
*HostAddress
,
260 IN OUT UINTN
*NumberOfBytes
,
261 OUT EFI_PHYSICAL_ADDRESS
*DeviceAddress
,
265 MAP_INFO_INSTANCE
*Map
;
268 if ( HostAddress
== NULL
|| NumberOfBytes
== NULL
||
269 DeviceAddress
== NULL
|| Mapping
== NULL
) {
271 return EFI_INVALID_PARAMETER
;
275 if (Operation
>= EfiPciOperationMaximum
) {
276 return EFI_INVALID_PARAMETER
;
279 *DeviceAddress
= ConvertToPhysicalAddress (HostAddress
);
281 // Data cache flush (HostAddress, NumberOfBytes);
283 // Remember range so we can flush on the other side
284 Status
= gBS
->AllocatePool (EfiBootServicesData
, sizeof (PCI_DMA_MAP
), (VOID
**) &Map
);
285 if (EFI_ERROR(Status
)) {
286 return EFI_OUT_OF_RESOURCES
;
291 Map
->HostAddress
= (UINTN
)HostAddress
;
292 Map
->DeviceAddress
= *DeviceAddress
;
293 Map
->NumberOfBytes
= *NumberOfBytes
;
294 Map
->Operation
= Operation
;
296 // EfiCpuFlushTypeWriteBack, EfiCpuFlushTypeInvalidate
297 gCpu
->FlushDataCache (gCpu
, (EFI_PHYSICAL_ADDRESS
)(UINTN
)HostAddress
, *NumberOfBytes
, EfiCpuFlushTypeWriteBackInvalidate
);
304 IN EFI_PCI_IO_PROTOCOL
*This
,
310 if (Mapping
== NULL
) {
312 return EFI_INVALID_PARAMETER
;
315 Map
= (PCI_DMA_MAP
*)Mapping
;
316 if (Map
->Operation
== EfiPciOperationBusMasterWrite
) {
318 // Make sure we read buffer from uncached memory and not the cache
320 gCpu
->FlushDataCache (gCpu
, Map
->HostAddress
, Map
->NumberOfBytes
, EfiCpuFlushTypeInvalidate
);
321 } else if (Map
->Operation
== EfiPciOperationBusMasterCommonBuffer
) {
323 // CPU was using uncached address, so anything in the cached range is bogus
325 gCpu
->FlushDataCache (gCpu
, Map
->DeviceAddress
, Map
->NumberOfBytes
, EfiCpuFlushTypeInvalidate
);
334 PciIoAllocateBuffer (
335 IN EFI_PCI_IO_PROTOCOL
*This
,
336 IN EFI_ALLOCATE_TYPE Type
,
337 IN EFI_MEMORY_TYPE MemoryType
,
339 OUT VOID
**HostAddress
,
343 if (Attributes
& EFI_PCI_ATTRIBUTE_INVALID_FOR_ALLOCATE_BUFFER
) {
344 return EFI_UNSUPPORTED
;
347 if (HostAddress
== NULL
) {
348 return EFI_INVALID_PARAMETER
;
352 // The only valid memory types are EfiBootServicesData and EfiRuntimeServicesData
354 // We used uncached memory to keep coherency
356 if (MemoryType
== EfiBootServicesData
) {
357 *HostAddress
= UncachedAllocatePages (Pages
);
358 } else if (MemoryType
!= EfiRuntimeServicesData
) {
359 *HostAddress
= UncachedAllocateRuntimePages (Pages
);
361 return EFI_INVALID_PARAMETER
;
369 IN EFI_PCI_IO_PROTOCOL
*This
,
374 if (HostAddress
== NULL
) {
375 return EFI_INVALID_PARAMETER
;
378 UncachedFreePages (HostAddress
, Pages
);
385 IN EFI_PCI_IO_PROTOCOL
*This
393 IN EFI_PCI_IO_PROTOCOL
*This
,
394 OUT UINTN
*SegmentNumber
,
395 OUT UINTN
*BusNumber
,
396 OUT UINTN
*DeviceNumber
,
397 OUT UINTN
*FunctionNumber
400 EFI_PCI_IO_PRIVATE_DATA
*Private
= EFI_PCI_IO_PRIVATE_DATA_FROM_THIS(This
);
402 if (SegmentNumber
!= NULL
) {
403 *SegmentNumber
= Private
->Segment
;
406 if (BusNumber
!= NULL
) {
410 if (DeviceNumber
!= NULL
) {
414 if (FunctionNumber
!= NULL
) {
423 IN EFI_PCI_IO_PROTOCOL
*This
,
424 IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation
,
425 IN UINT64 Attributes
,
426 OUT UINT64
*Result OPTIONAL
430 case EfiPciIoAttributeOperationGet
:
431 case EfiPciIoAttributeOperationSupported
:
432 if (Result
== NULL
) {
433 return EFI_INVALID_PARAMETER
;
435 // We are not a real PCI device so just say things we kind of do
436 *Result
= EFI_PCI_IO_ATTRIBUTE_MEMORY
| EFI_PCI_IO_ATTRIBUTE_BUS_MASTER
| EFI_PCI_DEVICE_ENABLE
;
439 case EfiPciIoAttributeOperationSet
:
440 case EfiPciIoAttributeOperationEnable
:
441 case EfiPciIoAttributeOperationDisable
:
442 // Since we are not a real PCI device no enable/set or disable operations exist.
448 return EFI_INVALID_PARAMETER
;
454 PciIoGetBarAttributes (
455 IN EFI_PCI_IO_PROTOCOL
*This
,
457 OUT UINT64
*Supports
, OPTIONAL
458 OUT VOID
**Resources OPTIONAL
462 return EFI_UNSUPPORTED
;
466 PciIoSetBarAttributes (
467 IN EFI_PCI_IO_PROTOCOL
*This
,
468 IN UINT64 Attributes
,
470 IN OUT UINT64
*Offset
,
471 IN OUT UINT64
*Length
475 return EFI_UNSUPPORTED
;
478 EFI_PCI_IO_PROTOCOL PciIoTemplate
=
496 PciIoGetBarAttributes
,
497 PciIoSetBarAttributes
,
504 PciEmulationEntryPoint (
505 IN EFI_HANDLE ImageHandle
,
506 IN EFI_SYSTEM_TABLE
*SystemTable
511 EFI_PCI_IO_PRIVATE_DATA
*Private
;
512 UINT8 CapabilityLength
;
516 // Get the Cpu protocol for later use
517 Status
= gBS
->LocateProtocol(&gEfiCpuArchProtocolGuid
, NULL
, (VOID
**)&gCpu
);
518 ASSERT_EFI_ERROR(Status
);
520 //Configure USB host for OMAP3530.
523 // Create a private structure
524 Private
= AllocatePool(sizeof(EFI_PCI_IO_PRIVATE_DATA
));
525 if (Private
== NULL
) {
526 Status
= EFI_OUT_OF_RESOURCES
;
530 Private
->Signature
= EFI_PCI_IO_PRIVATE_DATA_SIGNATURE
; // Fill in signature
531 Private
->RootBridge
.Signature
= PCI_ROOT_BRIDGE_SIGNATURE
; // Fake Root Bridge structure needs a signature too
532 Private
->RootBridge
.MemoryStart
= USB_EHCI_HCCAPBASE
; // Get the USB capability register base
533 Private
->Segment
= 0; // Default to segment zero
535 // Find out the capability register length and number of physical ports.
536 CapabilityLength
= MmioRead8(Private
->RootBridge
.MemoryStart
);
537 PhysicalPorts
= (MmioRead32(Private
->RootBridge
.MemoryStart
+ 0x4)) & 0x0000000F;
539 // Calculate the total size of the USB registers.
540 Private
->RootBridge
.MemorySize
= CapabilityLength
+ (HOST_CONTROLLER_OPERATION_REG_SIZE
+ ((4 * PhysicalPorts
) - 1));
542 // Enable Port Power bit in Port status and control registers in EHCI register space.
543 // Port Power Control (PPC) bit in the HCSPARAMS register is already set which indicates
544 // host controller implementation includes port power control.
545 for (Count
= 0; Count
< PhysicalPorts
; Count
++) {
546 MmioOr32((Private
->RootBridge
.MemoryStart
+ CapabilityLength
+ HOST_CONTROLLER_OPERATION_REG_SIZE
+ 4*Count
), 0x00001000);
549 // Create fake PCI config space.
550 Private
->ConfigSpace
= AllocateZeroPool(sizeof(PCI_TYPE00
));
551 if (Private
->ConfigSpace
== NULL
) {
552 Status
= EFI_OUT_OF_RESOURCES
;
557 // Configure PCI config space
558 Private
->ConfigSpace
->Hdr
.VendorId
= 0x3530;
559 Private
->ConfigSpace
->Hdr
.DeviceId
= 0x3530;
560 Private
->ConfigSpace
->Hdr
.ClassCode
[0] = 0x20;
561 Private
->ConfigSpace
->Hdr
.ClassCode
[1] = 0x03;
562 Private
->ConfigSpace
->Hdr
.ClassCode
[2] = 0x0C;
563 Private
->ConfigSpace
->Device
.Bar
[0] = Private
->RootBridge
.MemoryStart
;
567 // Unique device path.
568 CopyMem(&Private
->DevicePath
, &PciIoDevicePathTemplate
, sizeof(PciIoDevicePathTemplate
));
569 Private
->DevicePath
.AcpiDevicePath
.UID
= 0;
571 // Copy protocol structure
572 CopyMem(&Private
->PciIoProtocol
, &PciIoTemplate
, sizeof(PciIoTemplate
));
574 Status
= gBS
->InstallMultipleProtocolInterfaces(&Handle
,
575 &gEfiPciIoProtocolGuid
, &Private
->PciIoProtocol
,
576 &gEfiDevicePathProtocolGuid
, &Private
->DevicePath
,
578 if (EFI_ERROR(Status
)) {
579 DEBUG((EFI_D_ERROR
, "PciEmulationEntryPoint InstallMultipleProtocolInterfaces() failed.\n"));