2 PCI Root Bridge Io Protocol implementation
4 Copyright (c) 2008 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are
6 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 "PciHostBridge.h"
18 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR SpaceDesp
[TypeMax
];
19 EFI_ACPI_END_TAG_DESCRIPTOR EndDesp
;
20 } RESOURCE_CONFIGURATION
;
22 RESOURCE_CONFIGURATION Configuration
= {
23 {{0x8A, 0x2B, 1, 0, 0, 0, 0, 0, 0, 0},
24 {0x8A, 0x2B, 0, 0, 0, 32, 0, 0, 0, 0},
25 {0x8A, 0x2B, 0, 0, 6, 32, 0, 0, 0, 0},
26 {0x8A, 0x2B, 0, 0, 0, 64, 0, 0, 0, 0},
27 {0x8A, 0x2B, 0, 0, 6, 64, 0, 0, 0, 0},
28 {0x8A, 0x2B, 2, 0, 0, 0, 0, 0, 0, 0}},
33 // Protocol Member Function Prototypes
37 Polls an address in memory mapped I/O space until an exit condition is met, or
40 This function provides a standard way to poll a PCI memory location. A PCI memory read
41 operation is performed at the PCI memory address specified by Address for the width specified
42 by Width. The result of this PCI memory read operation is stored in Result. This PCI memory
43 read operation is repeated until either a timeout of Delay 100 ns units has expired, or (Result &
44 Mask) is equal to Value.
46 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
47 @param[in] Width Signifies the width of the memory operations.
48 @param[in] Address The base address of the memory operations. The caller is
49 responsible for aligning Address if required.
50 @param[in] Mask Mask used for the polling criteria. Bytes above Width in Mask
51 are ignored. The bits in the bytes below Width which are zero in
52 Mask are ignored when polling the memory address.
53 @param[in] Value The comparison value used for the polling exit criteria.
54 @param[in] Delay The number of 100 ns units to poll. Note that timer available may
55 be of poorer granularity.
56 @param[out] Result Pointer to the last value read from the memory location.
58 @retval EFI_SUCCESS The last data returned from the access matched the poll exit criteria.
59 @retval EFI_INVALID_PARAMETER Width is invalid.
60 @retval EFI_INVALID_PARAMETER Result is NULL.
61 @retval EFI_TIMEOUT Delay expired before a match occurred.
62 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
68 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
69 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
78 Reads from the I/O space of a PCI Root Bridge. Returns when either the polling exit criteria is
79 satisfied or after a defined duration.
81 This function provides a standard way to poll a PCI I/O location. A PCI I/O read operation is
82 performed at the PCI I/O address specified by Address for the width specified by Width.
83 The result of this PCI I/O read operation is stored in Result. This PCI I/O read operation is
84 repeated until either a timeout of Delay 100 ns units has expired, or (Result & Mask) is equal
87 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
88 @param[in] Width Signifies the width of the I/O operations.
89 @param[in] Address The base address of the I/O operations. The caller is responsible
90 for aligning Address if required.
91 @param[in] Mask Mask used for the polling criteria. Bytes above Width in Mask
92 are ignored. The bits in the bytes below Width which are zero in
93 Mask are ignored when polling the I/O address.
94 @param[in] Value The comparison value used for the polling exit criteria.
95 @param[in] Delay The number of 100 ns units to poll. Note that timer available may
96 be of poorer granularity.
97 @param[out] Result Pointer to the last value read from the memory location.
99 @retval EFI_SUCCESS The last data returned from the access matched the poll exit criteria.
100 @retval EFI_INVALID_PARAMETER Width is invalid.
101 @retval EFI_INVALID_PARAMETER Result is NULL.
102 @retval EFI_TIMEOUT Delay expired before a match occurred.
103 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
109 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
110 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
119 Enables a PCI driver to access PCI controller registers in the PCI root bridge memory space.
121 The Mem.Read(), and Mem.Write() functions enable a driver to access PCI controller
122 registers in the PCI root bridge memory space.
123 The memory operations are carried out exactly as requested. The caller is responsible for satisfying
124 any alignment and memory width restrictions that a PCI Root Bridge on a platform might require.
126 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
127 @param[in] Width Signifies the width of the memory operation.
128 @param[in] Address The base address of the memory operation. The caller is
129 responsible for aligning the Address if required.
130 @param[in] Count The number of memory operations to perform. Bytes moved is
131 Width size * Count, starting at Address.
132 @param[out] Buffer For read operations, the destination buffer to store the results. For
133 write operations, the source buffer to write data from.
135 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
136 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
137 @retval EFI_INVALID_PARAMETER Buffer is NULL.
138 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
143 RootBridgeIoMemRead (
144 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
145 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
152 Enables a PCI driver to access PCI controller registers in the PCI root bridge memory space.
154 The Mem.Read(), and Mem.Write() functions enable a driver to access PCI controller
155 registers in the PCI root bridge memory space.
156 The memory operations are carried out exactly as requested. The caller is responsible for satisfying
157 any alignment and memory width restrictions that a PCI Root Bridge on a platform might require.
159 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
160 @param[in] Width Signifies the width of the memory operation.
161 @param[in] Address The base address of the memory operation. The caller is
162 responsible for aligning the Address if required.
163 @param[in] Count The number of memory operations to perform. Bytes moved is
164 Width size * Count, starting at Address.
165 @param[in] Buffer For read operations, the destination buffer to store the results. For
166 write operations, the source buffer to write data from.
168 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
169 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
170 @retval EFI_INVALID_PARAMETER Buffer is NULL.
171 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
175 RootBridgeIoMemWrite (
176 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
177 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
184 Enables a PCI driver to access PCI controller registers in the PCI root bridge I/O space.
186 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
187 @param[in] Width Signifies the width of the memory operations.
188 @param[in] UserAddress The base address of the I/O operation. The caller is responsible for
189 aligning the Address if required.
190 @param[in] Count The number of I/O operations to perform. Bytes moved is Width
191 size * Count, starting at Address.
192 @param[out] UserBuffer For read operations, the destination buffer to store the results. For
193 write operations, the source buffer to write data from.
195 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
196 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
197 @retval EFI_INVALID_PARAMETER Buffer is NULL.
198 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
204 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
205 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
206 IN UINT64 UserAddress
,
212 Enables a PCI driver to access PCI controller registers in the PCI root bridge I/O space.
214 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
215 @param[in] Width Signifies the width of the memory operations.
216 @param[in] UserAddress The base address of the I/O operation. The caller is responsible for
217 aligning the Address if required.
218 @param[in] Count The number of I/O operations to perform. Bytes moved is Width
219 size * Count, starting at Address.
220 @param[in] UserBuffer For read operations, the destination buffer to store the results. For
221 write operations, the source buffer to write data from.
223 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
224 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
225 @retval EFI_INVALID_PARAMETER Buffer is NULL.
226 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
231 RootBridgeIoIoWrite (
232 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
233 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
234 IN UINT64 UserAddress
,
240 Enables a PCI driver to copy one region of PCI root bridge memory space to another region of PCI
241 root bridge memory space.
243 The CopyMem() function enables a PCI driver to copy one region of PCI root bridge memory
244 space to another region of PCI root bridge memory space. This is especially useful for video scroll
245 operation on a memory mapped video buffer.
246 The memory operations are carried out exactly as requested. The caller is responsible for satisfying
247 any alignment and memory width restrictions that a PCI root bridge on a platform might require.
249 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL instance.
250 @param[in] Width Signifies the width of the memory operations.
251 @param[in] DestAddress The destination address of the memory operation. The caller is
252 responsible for aligning the DestAddress if required.
253 @param[in] SrcAddress The source address of the memory operation. The caller is
254 responsible for aligning the SrcAddress if required.
255 @param[in] Count The number of memory operations to perform. Bytes moved is
256 Width size * Count, starting at DestAddress and SrcAddress.
258 @retval EFI_SUCCESS The data was copied from one memory region to another memory region.
259 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
260 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
265 RootBridgeIoCopyMem (
266 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
267 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
268 IN UINT64 DestAddress
,
269 IN UINT64 SrcAddress
,
274 Enables a PCI driver to access PCI controller registers in a PCI root bridge's configuration space.
276 The Pci.Read() and Pci.Write() functions enable a driver to access PCI configuration
277 registers for a PCI controller.
278 The PCI Configuration operations are carried out exactly as requested. The caller is responsible for
279 any alignment and PCI configuration width issues that a PCI Root Bridge on a platform might
282 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
283 @param[in] Width Signifies the width of the memory operations.
284 @param[in] Address The address within the PCI configuration space for the PCI controller.
285 @param[in] Count The number of PCI configuration operations to perform. Bytes
286 moved is Width size * Count, starting at Address.
287 @param[out] Buffer For read operations, the destination buffer to store the results. For
288 write operations, the source buffer to write data from.
290 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
291 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
292 @retval EFI_INVALID_PARAMETER Buffer is NULL.
293 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
298 RootBridgeIoPciRead (
299 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
300 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
307 Enables a PCI driver to access PCI controller registers in a PCI root bridge's configuration space.
309 The Pci.Read() and Pci.Write() functions enable a driver to access PCI configuration
310 registers for a PCI controller.
311 The PCI Configuration operations are carried out exactly as requested. The caller is responsible for
312 any alignment and PCI configuration width issues that a PCI Root Bridge on a platform might
315 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
316 @param[in] Width Signifies the width of the memory operations.
317 @param[in] Address The address within the PCI configuration space for the PCI controller.
318 @param[in] Count The number of PCI configuration operations to perform. Bytes
319 moved is Width size * Count, starting at Address.
320 @param[in] Buffer For read operations, the destination buffer to store the results. For
321 write operations, the source buffer to write data from.
323 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
324 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
325 @retval EFI_INVALID_PARAMETER Buffer is NULL.
326 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
331 RootBridgeIoPciWrite (
332 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
333 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
340 Provides the PCI controller-specific addresses required to access system memory from a
343 The Map() function provides the PCI controller specific addresses needed to access system
344 memory. This function is used to map system memory for PCI bus master DMA accesses.
346 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
347 @param[in] Operation Indicates if the bus master is going to read or write to system memory.
348 @param[in] HostAddress The system memory address to map to the PCI controller.
349 @param[in, out] NumberOfBytes On input the number of bytes to map. On output the number of bytes that were mapped.
350 @param[out] DeviceAddress The resulting map address for the bus master PCI controller to use
351 to access the system memory's HostAddress.
352 @param[out] Mapping The value to pass to Unmap() when the bus master DMA operation is complete.
354 @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
355 @retval EFI_INVALID_PARAMETER Operation is invalid.
356 @retval EFI_INVALID_PARAMETER HostAddress is NULL.
357 @retval EFI_INVALID_PARAMETER NumberOfBytes is NULL.
358 @retval EFI_INVALID_PARAMETER DeviceAddress is NULL.
359 @retval EFI_INVALID_PARAMETER Mapping is NULL.
360 @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
361 @retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
362 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
368 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
369 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION Operation
,
370 IN VOID
*HostAddress
,
371 IN OUT UINTN
*NumberOfBytes
,
372 OUT EFI_PHYSICAL_ADDRESS
*DeviceAddress
,
377 Completes the Map() operation and releases any corresponding resources.
379 The Unmap() function completes the Map() operation and releases any corresponding resources.
380 If the operation was an EfiPciOperationBusMasterWrite or
381 EfiPciOperationBusMasterWrite64, the data is committed to the target system memory.
382 Any resources used for the mapping are freed.
384 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
385 @param[in] Mapping The mapping value returned from Map().
387 @retval EFI_SUCCESS The range was unmapped.
388 @retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by Map().
389 @retval EFI_DEVICE_ERROR The data was not committed to the target system memory.
395 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
400 Allocates pages that are suitable for an EfiPciOperationBusMasterCommonBuffer or
401 EfiPciOperationBusMasterCommonBuffer64 mapping.
403 @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
404 @param Type This parameter is not used and must be ignored.
405 @param MemoryType The type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData.
406 @param Pages The number of pages to allocate.
407 @param HostAddress A pointer to store the base system memory address of the allocated range.
408 @param Attributes The requested bit mask of attributes for the allocated range. Only
409 the attributes EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE, EFI_PCI_ATTRIBUTE_MEMORY_CACHED,
410 and EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE may be used with this function.
412 @retval EFI_SUCCESS The requested memory pages were allocated.
413 @retval EFI_INVALID_PARAMETER MemoryType is invalid.
414 @retval EFI_INVALID_PARAMETER HostAddress is NULL.
415 @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are
416 MEMORY_WRITE_COMBINE, MEMORY_CACHED, and DUAL_ADDRESS_CYCLE.
417 @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
422 RootBridgeIoAllocateBuffer (
423 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
424 IN EFI_ALLOCATE_TYPE Type
,
425 IN EFI_MEMORY_TYPE MemoryType
,
427 OUT VOID
**HostAddress
,
432 Frees memory that was allocated with AllocateBuffer().
434 The FreeBuffer() function frees memory that was allocated with AllocateBuffer().
436 @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
437 @param Pages The number of pages to free.
438 @param HostAddress The base system memory address of the allocated range.
440 @retval EFI_SUCCESS The requested memory pages were freed.
441 @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
442 was not allocated with AllocateBuffer().
447 RootBridgeIoFreeBuffer (
448 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
450 OUT VOID
*HostAddress
454 Flushes all PCI posted write transactions from a PCI host bridge to system memory.
456 The Flush() function flushes any PCI posted write transactions from a PCI host bridge to system
457 memory. Posted write transactions are generated by PCI bus masters when they perform write
458 transactions to target addresses in system memory.
459 This function does not flush posted write transactions from any PCI bridges. A PCI controller
460 specific action must be taken to guarantee that the posted write transactions have been flushed from
461 the PCI controller and from all the PCI bridges into the PCI host bridge. This is typically done with
462 a PCI read transaction from the PCI controller prior to calling Flush().
464 @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
466 @retval EFI_SUCCESS The PCI posted write transactions were flushed from the PCI host
467 bridge to system memory.
468 @retval EFI_DEVICE_ERROR The PCI posted write transactions were not flushed from the PCI
469 host bridge due to a hardware error.
475 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
479 Gets the attributes that a PCI root bridge supports setting with SetAttributes(), and the
480 attributes that a PCI root bridge is currently using.
482 The GetAttributes() function returns the mask of attributes that this PCI root bridge supports
483 and the mask of attributes that the PCI root bridge is currently using.
485 @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
486 @param Supported A pointer to the mask of attributes that this PCI root bridge
487 supports setting with SetAttributes().
488 @param Attributes A pointer to the mask of attributes that this PCI root bridge is
491 @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI root
492 bridge supports is returned in Supports. If Attributes is
493 not NULL, then the attributes that the PCI root bridge is currently
494 using is returned in Attributes.
495 @retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL.
500 RootBridgeIoGetAttributes (
501 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
502 OUT UINT64
*Supported
,
503 OUT UINT64
*Attributes
507 Sets attributes for a resource range on a PCI root bridge.
509 The SetAttributes() function sets the attributes specified in Attributes for the PCI root
510 bridge on the resource range specified by ResourceBase and ResourceLength. Since the
511 granularity of setting these attributes may vary from resource type to resource type, and from
512 platform to platform, the actual resource range and the one passed in by the caller may differ. As a
513 result, this function may set the attributes specified by Attributes on a larger resource range
514 than the caller requested. The actual range is returned in ResourceBase and
515 ResourceLength. The caller is responsible for verifying that the actual range for which the
516 attributes were set is acceptable.
518 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
519 @param[in] Attributes The mask of attributes to set. If the attribute bit
520 MEMORY_WRITE_COMBINE, MEMORY_CACHED, or
521 MEMORY_DISABLE is set, then the resource range is specified by
522 ResourceBase and ResourceLength. If
523 MEMORY_WRITE_COMBINE, MEMORY_CACHED, and
524 MEMORY_DISABLE are not set, then ResourceBase and
525 ResourceLength are ignored, and may be NULL.
526 @param[in, out] ResourceBase A pointer to the base address of the resource range to be modified
527 by the attributes specified by Attributes.
528 @param[in, out] ResourceLength A pointer to the length of the resource range to be modified by the
529 attributes specified by Attributes.
531 @retval EFI_SUCCESS The current configuration of this PCI root bridge was returned in Resources.
532 @retval EFI_UNSUPPORTED The current configuration of this PCI root bridge could not be retrieved.
533 @retval EFI_INVALID_PARAMETER Invalid pointer of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
538 RootBridgeIoSetAttributes (
539 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
540 IN UINT64 Attributes
,
541 IN OUT UINT64
*ResourceBase
,
542 IN OUT UINT64
*ResourceLength
546 Retrieves the current resource settings of this PCI root bridge in the form of a set of ACPI 2.0
547 resource descriptors.
549 There are only two resource descriptor types from the ACPI Specification that may be used to
550 describe the current resources allocated to a PCI root bridge. These are the QWORD Address
551 Space Descriptor (ACPI 2.0 Section 6.4.3.5.1), and the End Tag (ACPI 2.0 Section 6.4.2.8). The
552 QWORD Address Space Descriptor can describe memory, I/O, and bus number ranges for dynamic
553 or fixed resources. The configuration of a PCI root bridge is described with one or more QWORD
554 Address Space Descriptors followed by an End Tag.
556 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
557 @param[out] Resources A pointer to the ACPI 2.0 resource descriptors that describe the
558 current configuration of this PCI root bridge. The storage for the
559 ACPI 2.0 resource descriptors is allocated by this function. The
560 caller must treat the return buffer as read-only data, and the buffer
561 must not be freed by the caller.
563 @retval EFI_SUCCESS The current configuration of this PCI root bridge was returned in Resources.
564 @retval EFI_UNSUPPORTED The current configuration of this PCI root bridge could not be retrieved.
565 @retval EFI_INVALID_PARAMETER Invalid pointer of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
570 RootBridgeIoConfiguration (
571 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
576 // Memory Controller Pci Root Bridge Io Module Variables
578 EFI_METRONOME_ARCH_PROTOCOL
*mMetronome
;
581 // Lookup table for increment values based on transfer widths
583 UINT8 mInStride
[] = {
584 1, // EfiPciWidthUint8
585 2, // EfiPciWidthUint16
586 4, // EfiPciWidthUint32
587 8, // EfiPciWidthUint64
588 0, // EfiPciWidthFifoUint8
589 0, // EfiPciWidthFifoUint16
590 0, // EfiPciWidthFifoUint32
591 0, // EfiPciWidthFifoUint64
592 1, // EfiPciWidthFillUint8
593 2, // EfiPciWidthFillUint16
594 4, // EfiPciWidthFillUint32
595 8 // EfiPciWidthFillUint64
599 // Lookup table for increment values based on transfer widths
601 UINT8 mOutStride
[] = {
602 1, // EfiPciWidthUint8
603 2, // EfiPciWidthUint16
604 4, // EfiPciWidthUint32
605 8, // EfiPciWidthUint64
606 1, // EfiPciWidthFifoUint8
607 2, // EfiPciWidthFifoUint16
608 4, // EfiPciWidthFifoUint32
609 8, // EfiPciWidthFifoUint64
610 0, // EfiPciWidthFillUint8
611 0, // EfiPciWidthFillUint16
612 0, // EfiPciWidthFillUint32
613 0 // EfiPciWidthFillUint64
618 Construct the Pci Root Bridge Io protocol
620 @param Protocol Point to protocol instance
621 @param HostBridgeHandle Handle of host bridge
622 @param Attri Attribute of host bridge
623 @param ResAperture ResourceAperture for host bridge
625 @retval EFI_SUCCESS Success to initialize the Pci Root Bridge.
629 RootBridgeConstructor (
630 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*Protocol
,
631 IN EFI_HANDLE HostBridgeHandle
,
633 IN PCI_ROOT_BRIDGE_RESOURCE_APERTURE
*ResAperture
637 PCI_ROOT_BRIDGE_INSTANCE
*PrivateData
;
638 PCI_RESOURCE_TYPE Index
;
640 PrivateData
= DRIVER_INSTANCE_FROM_PCI_ROOT_BRIDGE_IO_THIS (Protocol
);
643 // The host to pci bridge, the host memory and io addresses are
644 // direct mapped to pci addresses, so no need translate, set bases to 0.
646 PrivateData
->MemBase
= ResAperture
->MemBase
;
647 PrivateData
->IoBase
= ResAperture
->IoBase
;
650 // The host bridge only supports 32bit addressing for memory
651 // and standard IA32 16bit io
653 PrivateData
->MemLimit
= ResAperture
->MemLimit
;
654 PrivateData
->IoLimit
= ResAperture
->IoLimit
;
657 // Bus Aperture for this Root Bridge (Possible Range)
659 PrivateData
->BusBase
= ResAperture
->BusBase
;
660 PrivateData
->BusLimit
= ResAperture
->BusLimit
;
663 // Specific for this chipset
665 for (Index
= TypeIo
; Index
< TypeMax
; Index
++) {
666 PrivateData
->ResAllocNode
[Index
].Type
= Index
;
667 PrivateData
->ResAllocNode
[Index
].Base
= 0;
668 PrivateData
->ResAllocNode
[Index
].Length
= 0;
669 PrivateData
->ResAllocNode
[Index
].Status
= ResNone
;
672 PrivateData
->RootBridgeAttrib
= Attri
;
674 PrivateData
->Supports
= EFI_PCI_ATTRIBUTE_IDE_PRIMARY_IO
| EFI_PCI_ATTRIBUTE_IDE_SECONDARY_IO
| \
675 EFI_PCI_ATTRIBUTE_ISA_IO_16
| EFI_PCI_ATTRIBUTE_ISA_MOTHERBOARD_IO
| \
676 EFI_PCI_ATTRIBUTE_VGA_MEMORY
| \
677 EFI_PCI_ATTRIBUTE_VGA_IO_16
| EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO_16
;
678 PrivateData
->Attributes
= PrivateData
->Supports
;
680 Protocol
->ParentHandle
= HostBridgeHandle
;
682 Protocol
->PollMem
= RootBridgeIoPollMem
;
683 Protocol
->PollIo
= RootBridgeIoPollIo
;
685 Protocol
->Mem
.Read
= RootBridgeIoMemRead
;
686 Protocol
->Mem
.Write
= RootBridgeIoMemWrite
;
688 Protocol
->Io
.Read
= RootBridgeIoIoRead
;
689 Protocol
->Io
.Write
= RootBridgeIoIoWrite
;
691 Protocol
->CopyMem
= RootBridgeIoCopyMem
;
693 Protocol
->Pci
.Read
= RootBridgeIoPciRead
;
694 Protocol
->Pci
.Write
= RootBridgeIoPciWrite
;
696 Protocol
->Map
= RootBridgeIoMap
;
697 Protocol
->Unmap
= RootBridgeIoUnmap
;
699 Protocol
->AllocateBuffer
= RootBridgeIoAllocateBuffer
;
700 Protocol
->FreeBuffer
= RootBridgeIoFreeBuffer
;
702 Protocol
->Flush
= RootBridgeIoFlush
;
704 Protocol
->GetAttributes
= RootBridgeIoGetAttributes
;
705 Protocol
->SetAttributes
= RootBridgeIoSetAttributes
;
707 Protocol
->Configuration
= RootBridgeIoConfiguration
;
709 Protocol
->SegmentNumber
= 0;
711 Status
= gBS
->LocateProtocol (&gEfiMetronomeArchProtocolGuid
, NULL
, (VOID
**)&mMetronome
);
712 ASSERT_EFI_ERROR (Status
);
718 Check parameters for IO,MMIO,PCI read/write services of PCI Root Bridge IO.
720 The I/O operations are carried out exactly as requested. The caller is responsible
721 for satisfying any alignment and I/O width restrictions that a PI System on a
722 platform might require. For example on some platforms, width requests of
723 EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will
724 be handled by the driver.
726 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
727 @param[in] OperationType I/O operation type: IO/MMIO/PCI.
728 @param[in] Width Signifies the width of the I/O or Memory operation.
729 @param[in] Address The base address of the I/O operation.
730 @param[in] Count The number of I/O operations to perform. The number of
731 bytes moved is Width size * Count, starting at Address.
732 @param[in] Buffer For read operations, the destination buffer to store the results.
733 For write operations, the source buffer from which to write data.
735 @retval EFI_SUCCESS The parameters for this request pass the checks.
736 @retval EFI_INVALID_PARAMETER Width is invalid for this PI system.
737 @retval EFI_INVALID_PARAMETER Buffer is NULL.
738 @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.
739 @retval EFI_UNSUPPORTED The address range specified by Address, Width,
740 and Count is not valid for this PI system.
744 RootBridgeIoCheckParameter (
745 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
746 IN OPERATION_TYPE OperationType
,
747 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
753 PCI_ROOT_BRIDGE_INSTANCE
*PrivateData
;
754 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS
*PciRbAddr
;
760 // Check to see if Buffer is NULL
762 if (Buffer
== NULL
) {
763 return EFI_INVALID_PARAMETER
;
767 // Check to see if Width is in the valid range
769 if ((UINT32
)Width
>= EfiPciWidthMaximum
) {
770 return EFI_INVALID_PARAMETER
;
774 // For FIFO type, the target address won't increase during the access,
775 // so treat Count as 1
777 if (Width
>= EfiPciWidthFifoUint8
&& Width
<= EfiPciWidthFifoUint64
) {
782 // Check to see if Width is in the valid range for I/O Port operations
784 Width
= (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
) (Width
& 0x03);
785 if ((OperationType
!= MemOperation
) && (Width
== EfiPciWidthUint64
)) {
787 return EFI_INVALID_PARAMETER
;
791 // Check to see if Address is aligned
793 if ((Address
& (UINT64
)(mInStride
[Width
] - 1)) != 0) {
794 return EFI_UNSUPPORTED
;
797 PrivateData
= DRIVER_INSTANCE_FROM_PCI_ROOT_BRIDGE_IO_THIS (This
);
800 // Check to see if any address associated with this transfer exceeds the maximum
801 // allowed address. The maximum address implied by the parameters passed in is
802 // Address + Size * Count. If the following condition is met, then the transfer
805 // Address + Size * Count > Limit + 1
807 // Since Limit can be the maximum integer value supported by the CPU and Count
808 // can also be the maximum integer value supported by the CPU, this range
809 // check must be adjusted to avoid all oveflow conditions.
811 // The following form of the range check is equivalent but assumes that
812 // Limit is of the form (2^n - 1).
814 if (OperationType
== IoOperation
) {
815 Base
= PrivateData
->IoBase
;
816 Limit
= PrivateData
->IoLimit
;
817 } else if (OperationType
== MemOperation
) {
818 Base
= PrivateData
->MemBase
;
819 Limit
= PrivateData
->MemLimit
;
821 PciRbAddr
= (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS
*) &Address
;
822 if (PciRbAddr
->Bus
< PrivateData
->BusBase
|| PciRbAddr
->Bus
> PrivateData
->BusLimit
) {
823 return EFI_INVALID_PARAMETER
;
826 if (PciRbAddr
->Device
> MAX_PCI_DEVICE_NUMBER
|| PciRbAddr
->Function
> MAX_PCI_FUNCTION_NUMBER
) {
827 return EFI_INVALID_PARAMETER
;
830 if (PciRbAddr
->ExtendedRegister
!= 0) {
831 Address
= PciRbAddr
->ExtendedRegister
;
833 Address
= PciRbAddr
->Register
;
836 Limit
= MAX_PCI_REG_ADDRESS
;
839 if (Address
< Base
) {
840 return EFI_INVALID_PARAMETER
;
844 if (Address
> Limit
) {
845 return EFI_UNSUPPORTED
;
848 MaxCount
= RShiftU64 (Limit
, Width
);
849 if (MaxCount
< (Count
- 1)) {
850 return EFI_UNSUPPORTED
;
852 if (Address
> LShiftU64 (MaxCount
- Count
+ 1, Width
)) {
853 return EFI_UNSUPPORTED
;
861 Internal help function for read and write memory space.
863 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
864 @param[in] Write Switch value for Read or Write.
865 @param[in] Width Signifies the width of the memory operations.
866 @param[in] UserAddress The address within the PCI configuration space for the PCI controller.
867 @param[in] Count The number of PCI configuration operations to perform. Bytes
868 moved is Width size * Count, starting at Address.
869 @param[in, out] UserBuffer For read operations, the destination buffer to store the results. For
870 write operations, the source buffer to write data from.
872 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
873 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
874 @retval EFI_INVALID_PARAMETER Buffer is NULL.
875 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
880 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
882 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
891 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH OperationWidth
;
894 Status
= RootBridgeIoCheckParameter (This
, MemOperation
, Width
, Address
, Count
, Buffer
);
895 if (EFI_ERROR (Status
)) {
899 InStride
= mInStride
[Width
];
900 OutStride
= mOutStride
[Width
];
901 OperationWidth
= (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
) (Width
& 0x03);
902 for (Uint8Buffer
= Buffer
; Count
> 0; Address
+= InStride
, Uint8Buffer
+= OutStride
, Count
--) {
904 switch (OperationWidth
) {
905 case EfiPciWidthUint8
:
906 MmioWrite8 ((UINTN
)Address
, *Uint8Buffer
);
908 case EfiPciWidthUint16
:
909 MmioWrite16 ((UINTN
)Address
, *((UINT16
*)Uint8Buffer
));
911 case EfiPciWidthUint32
:
912 MmioWrite32 ((UINTN
)Address
, *((UINT32
*)Uint8Buffer
));
914 case EfiPciWidthUint64
:
915 MmioWrite64 ((UINTN
)Address
, *((UINT64
*)Uint8Buffer
));
919 // The RootBridgeIoCheckParameter call above will ensure that this
920 // path is not taken.
926 switch (OperationWidth
) {
927 case EfiPciWidthUint8
:
928 *Uint8Buffer
= MmioRead8 ((UINTN
)Address
);
930 case EfiPciWidthUint16
:
931 *((UINT16
*)Uint8Buffer
) = MmioRead16 ((UINTN
)Address
);
933 case EfiPciWidthUint32
:
934 *((UINT32
*)Uint8Buffer
) = MmioRead32 ((UINTN
)Address
);
936 case EfiPciWidthUint64
:
937 *((UINT64
*)Uint8Buffer
) = MmioRead64 ((UINTN
)Address
);
941 // The RootBridgeIoCheckParameter call above will ensure that this
942 // path is not taken.
953 Internal help function for read and write IO space.
955 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
956 @param[in] Write Switch value for Read or Write.
957 @param[in] Width Signifies the width of the memory operations.
958 @param[in] UserAddress The address within the PCI configuration space for the PCI controller.
959 @param[in] Count The number of PCI configuration operations to perform. Bytes
960 moved is Width size * Count, starting at Address.
961 @param[in, out] UserBuffer For read operations, the destination buffer to store the results. For
962 write operations, the source buffer to write data from.
964 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
965 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
966 @retval EFI_INVALID_PARAMETER Buffer is NULL.
967 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
972 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
974 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
983 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH OperationWidth
;
986 Status
= RootBridgeIoCheckParameter (This
, IoOperation
, Width
, Address
, Count
, Buffer
);
987 if (EFI_ERROR (Status
)) {
991 InStride
= mInStride
[Width
];
992 OutStride
= mOutStride
[Width
];
993 OperationWidth
= (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
) (Width
& 0x03);
995 for (Uint8Buffer
= Buffer
; Count
> 0; Address
+= InStride
, Uint8Buffer
+= OutStride
, Count
--) {
997 switch (OperationWidth
) {
998 case EfiPciWidthUint8
:
999 IoWrite8 ((UINTN
)Address
, *Uint8Buffer
);
1001 case EfiPciWidthUint16
:
1002 IoWrite16 ((UINTN
)Address
, *((UINT16
*)Uint8Buffer
));
1004 case EfiPciWidthUint32
:
1005 IoWrite32 ((UINTN
)Address
, *((UINT32
*)Uint8Buffer
));
1009 // The RootBridgeIoCheckParameter call above will ensure that this
1010 // path is not taken.
1016 switch (OperationWidth
) {
1017 case EfiPciWidthUint8
:
1018 *Uint8Buffer
= IoRead8 ((UINTN
)Address
);
1020 case EfiPciWidthUint16
:
1021 *((UINT16
*)Uint8Buffer
) = IoRead16 ((UINTN
)Address
);
1023 case EfiPciWidthUint32
:
1024 *((UINT32
*)Uint8Buffer
) = IoRead32 ((UINTN
)Address
);
1028 // The RootBridgeIoCheckParameter call above will ensure that this
1029 // path is not taken.
1040 Internal help function for read and write PCI configuration space.
1042 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1043 @param[in] Write Switch value for Read or Write.
1044 @param[in] Width Signifies the width of the memory operations.
1045 @param[in] UserAddress The address within the PCI configuration space for the PCI controller.
1046 @param[in] Count The number of PCI configuration operations to perform. Bytes
1047 moved is Width size * Count, starting at Address.
1048 @param[in, out] UserBuffer For read operations, the destination buffer to store the results. For
1049 write operations, the source buffer to write data from.
1051 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
1052 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
1053 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1054 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1059 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1061 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1070 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH OperationWidth
;
1072 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS
*PciRbAddr
;
1075 Status
= RootBridgeIoCheckParameter (This
, PciOperation
, Width
, Address
, Count
, Buffer
);
1076 if (EFI_ERROR (Status
)) {
1080 PciRbAddr
= (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS
*) &Address
;
1082 PcieRegAddr
= (UINTN
) PCI_LIB_ADDRESS (
1085 PciRbAddr
->Function
,
1086 (PciRbAddr
->ExtendedRegister
!= 0) ? \
1087 PciRbAddr
->ExtendedRegister
:
1091 InStride
= mInStride
[Width
];
1092 OutStride
= mOutStride
[Width
];
1093 OperationWidth
= (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH
) (Width
& 0x03);
1094 for (Uint8Buffer
= Buffer
; Count
> 0; PcieRegAddr
+= InStride
, Uint8Buffer
+= OutStride
, Count
--) {
1096 switch (OperationWidth
) {
1097 case EfiPciWidthUint8
:
1098 PciWrite8 (PcieRegAddr
, *Uint8Buffer
);
1100 case EfiPciWidthUint16
:
1101 PciWrite16 (PcieRegAddr
, *((UINT16
*)Uint8Buffer
));
1103 case EfiPciWidthUint32
:
1104 PciWrite32 (PcieRegAddr
, *((UINT32
*)Uint8Buffer
));
1108 // The RootBridgeIoCheckParameter call above will ensure that this
1109 // path is not taken.
1115 switch (OperationWidth
) {
1116 case EfiPciWidthUint8
:
1117 *Uint8Buffer
= PciRead8 (PcieRegAddr
);
1119 case EfiPciWidthUint16
:
1120 *((UINT16
*)Uint8Buffer
) = PciRead16 (PcieRegAddr
);
1122 case EfiPciWidthUint32
:
1123 *((UINT32
*)Uint8Buffer
) = PciRead32 (PcieRegAddr
);
1127 // The RootBridgeIoCheckParameter call above will ensure that this
1128 // path is not taken.
1140 Polls an address in memory mapped I/O space until an exit condition is met, or
1143 This function provides a standard way to poll a PCI memory location. A PCI memory read
1144 operation is performed at the PCI memory address specified by Address for the width specified
1145 by Width. The result of this PCI memory read operation is stored in Result. This PCI memory
1146 read operation is repeated until either a timeout of Delay 100 ns units has expired, or (Result &
1147 Mask) is equal to Value.
1149 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1150 @param[in] Width Signifies the width of the memory operations.
1151 @param[in] Address The base address of the memory operations. The caller is
1152 responsible for aligning Address if required.
1153 @param[in] Mask Mask used for the polling criteria. Bytes above Width in Mask
1154 are ignored. The bits in the bytes below Width which are zero in
1155 Mask are ignored when polling the memory address.
1156 @param[in] Value The comparison value used for the polling exit criteria.
1157 @param[in] Delay The number of 100 ns units to poll. Note that timer available may
1158 be of poorer granularity.
1159 @param[out] Result Pointer to the last value read from the memory location.
1161 @retval EFI_SUCCESS The last data returned from the access matched the poll exit criteria.
1162 @retval EFI_INVALID_PARAMETER Width is invalid.
1163 @retval EFI_INVALID_PARAMETER Result is NULL.
1164 @retval EFI_TIMEOUT Delay expired before a match occurred.
1165 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1170 RootBridgeIoPollMem (
1171 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1172 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1181 UINT64 NumberOfTicks
;
1184 if (Result
== NULL
) {
1185 return EFI_INVALID_PARAMETER
;
1188 if ((UINT32
)Width
> EfiPciWidthUint64
) {
1189 return EFI_INVALID_PARAMETER
;
1193 // No matter what, always do a single poll.
1195 Status
= This
->Mem
.Read (This
, Width
, Address
, 1, Result
);
1196 if (EFI_ERROR (Status
)) {
1199 if ((*Result
& Mask
) == Value
) {
1209 // Determine the proper # of metronome ticks to wait for polling the
1210 // location. The nuber of ticks is Roundup (Delay / mMetronome->TickPeriod)+1
1211 // The "+1" to account for the possibility of the first tick being short
1212 // because we started in the middle of a tick.
1214 // BugBug: overriding mMetronome->TickPeriod with UINT32 until Metronome
1215 // protocol definition is updated.
1217 NumberOfTicks
= DivU64x32Remainder (Delay
, (UINT32
) mMetronome
->TickPeriod
, &Remainder
);
1218 if (Remainder
!= 0) {
1223 while (NumberOfTicks
!= 0) {
1225 mMetronome
->WaitForTick (mMetronome
, 1);
1227 Status
= This
->Mem
.Read (This
, Width
, Address
, 1, Result
);
1228 if (EFI_ERROR (Status
)) {
1232 if ((*Result
& Mask
) == Value
) {
1243 Reads from the I/O space of a PCI Root Bridge. Returns when either the polling exit criteria is
1244 satisfied or after a defined duration.
1246 This function provides a standard way to poll a PCI I/O location. A PCI I/O read operation is
1247 performed at the PCI I/O address specified by Address for the width specified by Width.
1248 The result of this PCI I/O read operation is stored in Result. This PCI I/O read operation is
1249 repeated until either a timeout of Delay 100 ns units has expired, or (Result & Mask) is equal
1252 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1253 @param[in] Width Signifies the width of the I/O operations.
1254 @param[in] Address The base address of the I/O operations. The caller is responsible
1255 for aligning Address if required.
1256 @param[in] Mask Mask used for the polling criteria. Bytes above Width in Mask
1257 are ignored. The bits in the bytes below Width which are zero in
1258 Mask are ignored when polling the I/O address.
1259 @param[in] Value The comparison value used for the polling exit criteria.
1260 @param[in] Delay The number of 100 ns units to poll. Note that timer available may
1261 be of poorer granularity.
1262 @param[out] Result Pointer to the last value read from the memory location.
1264 @retval EFI_SUCCESS The last data returned from the access matched the poll exit criteria.
1265 @retval EFI_INVALID_PARAMETER Width is invalid.
1266 @retval EFI_INVALID_PARAMETER Result is NULL.
1267 @retval EFI_TIMEOUT Delay expired before a match occurred.
1268 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1273 RootBridgeIoPollIo (
1274 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1275 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1284 UINT64 NumberOfTicks
;
1288 // No matter what, always do a single poll.
1291 if (Result
== NULL
) {
1292 return EFI_INVALID_PARAMETER
;
1295 if ((UINT32
)Width
> EfiPciWidthUint64
) {
1296 return EFI_INVALID_PARAMETER
;
1299 Status
= This
->Io
.Read (This
, Width
, Address
, 1, Result
);
1300 if (EFI_ERROR (Status
)) {
1303 if ((*Result
& Mask
) == Value
) {
1313 // Determine the proper # of metronome ticks to wait for polling the
1314 // location. The number of ticks is Roundup (Delay / mMetronome->TickPeriod)+1
1315 // The "+1" to account for the possibility of the first tick being short
1316 // because we started in the middle of a tick.
1318 NumberOfTicks
= DivU64x32Remainder (Delay
, (UINT32
)mMetronome
->TickPeriod
, &Remainder
);
1319 if (Remainder
!= 0) {
1324 while (NumberOfTicks
!= 0) {
1326 mMetronome
->WaitForTick (mMetronome
, 1);
1328 Status
= This
->Io
.Read (This
, Width
, Address
, 1, Result
);
1329 if (EFI_ERROR (Status
)) {
1333 if ((*Result
& Mask
) == Value
) {
1344 Enables a PCI driver to access PCI controller registers in the PCI root bridge memory space.
1346 The Mem.Read(), and Mem.Write() functions enable a driver to access PCI controller
1347 registers in the PCI root bridge memory space.
1348 The memory operations are carried out exactly as requested. The caller is responsible for satisfying
1349 any alignment and memory width restrictions that a PCI Root Bridge on a platform might require.
1351 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1352 @param[in] Width Signifies the width of the memory operation.
1353 @param[in] Address The base address of the memory operation. The caller is
1354 responsible for aligning the Address if required.
1355 @param[in] Count The number of memory operations to perform. Bytes moved is
1356 Width size * Count, starting at Address.
1357 @param[out] Buffer For read operations, the destination buffer to store the results. For
1358 write operations, the source buffer to write data from.
1360 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
1361 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
1362 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1363 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1368 RootBridgeIoMemRead (
1369 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1370 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1376 return RootBridgeIoMemRW (This
, FALSE
, Width
, Address
, Count
, Buffer
);
1380 Enables a PCI driver to access PCI controller registers in the PCI root bridge memory space.
1382 The Mem.Read(), and Mem.Write() functions enable a driver to access PCI controller
1383 registers in the PCI root bridge memory space.
1384 The memory operations are carried out exactly as requested. The caller is responsible for satisfying
1385 any alignment and memory width restrictions that a PCI Root Bridge on a platform might require.
1387 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1388 @param[in] Width Signifies the width of the memory operation.
1389 @param[in] Address The base address of the memory operation. The caller is
1390 responsible for aligning the Address if required.
1391 @param[in] Count The number of memory operations to perform. Bytes moved is
1392 Width size * Count, starting at Address.
1393 @param[in] Buffer For read operations, the destination buffer to store the results. For
1394 write operations, the source buffer to write data from.
1396 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
1397 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
1398 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1399 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1403 RootBridgeIoMemWrite (
1404 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1405 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1411 return RootBridgeIoMemRW (This
, TRUE
, Width
, Address
, Count
, Buffer
);
1415 Enables a PCI driver to access PCI controller registers in the PCI root bridge I/O space.
1417 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1418 @param[in] Width Signifies the width of the memory operations.
1419 @param[in] Address The base address of the I/O operation. The caller is responsible for
1420 aligning the Address if required.
1421 @param[in] Count The number of I/O operations to perform. Bytes moved is Width
1422 size * Count, starting at Address.
1423 @param[out] Buffer For read operations, the destination buffer to store the results. For
1424 write operations, the source buffer to write data from.
1426 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
1427 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
1428 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1429 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1434 RootBridgeIoIoRead (
1435 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1436 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1442 return RootBridgeIoIoRW (This
, FALSE
, Width
, Address
, Count
, Buffer
);
1446 Enables a PCI driver to access PCI controller registers in the PCI root bridge I/O space.
1448 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1449 @param[in] Width Signifies the width of the memory operations.
1450 @param[in] Address The base address of the I/O operation. The caller is responsible for
1451 aligning the Address if required.
1452 @param[in] Count The number of I/O operations to perform. Bytes moved is Width
1453 size * Count, starting at Address.
1454 @param[in] Buffer For read operations, the destination buffer to store the results. For
1455 write operations, the source buffer to write data from.
1457 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
1458 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
1459 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1460 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1465 RootBridgeIoIoWrite (
1466 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1467 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1473 return RootBridgeIoIoRW (This
, TRUE
, Width
, Address
, Count
, Buffer
);
1477 Enables a PCI driver to copy one region of PCI root bridge memory space to another region of PCI
1478 root bridge memory space.
1480 The CopyMem() function enables a PCI driver to copy one region of PCI root bridge memory
1481 space to another region of PCI root bridge memory space. This is especially useful for video scroll
1482 operation on a memory mapped video buffer.
1483 The memory operations are carried out exactly as requested. The caller is responsible for satisfying
1484 any alignment and memory width restrictions that a PCI root bridge on a platform might require.
1486 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL instance.
1487 @param[in] Width Signifies the width of the memory operations.
1488 @param[in] DestAddress The destination address of the memory operation. The caller is
1489 responsible for aligning the DestAddress if required.
1490 @param[in] SrcAddress The source address of the memory operation. The caller is
1491 responsible for aligning the SrcAddress if required.
1492 @param[in] Count The number of memory operations to perform. Bytes moved is
1493 Width size * Count, starting at DestAddress and SrcAddress.
1495 @retval EFI_SUCCESS The data was copied from one memory region to another memory region.
1496 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
1497 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1502 RootBridgeIoCopyMem (
1503 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1504 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1505 IN UINT64 DestAddress
,
1506 IN UINT64 SrcAddress
,
1516 if ((UINT32
)Width
> EfiPciWidthUint64
) {
1517 return EFI_INVALID_PARAMETER
;
1520 if (DestAddress
== SrcAddress
) {
1524 Stride
= (UINTN
)(1 << Width
);
1527 if ((DestAddress
> SrcAddress
) && (DestAddress
< (SrcAddress
+ Count
* Stride
))) {
1529 SrcAddress
= SrcAddress
+ (Count
-1) * Stride
;
1530 DestAddress
= DestAddress
+ (Count
-1) * Stride
;
1533 for (Index
= 0;Index
< Count
;Index
++) {
1534 Status
= RootBridgeIoMemRead (
1541 if (EFI_ERROR (Status
)) {
1544 Status
= RootBridgeIoMemWrite (
1551 if (EFI_ERROR (Status
)) {
1555 SrcAddress
+= Stride
;
1556 DestAddress
+= Stride
;
1558 SrcAddress
-= Stride
;
1559 DestAddress
-= Stride
;
1566 Enables a PCI driver to access PCI controller registers in a PCI root bridge's configuration space.
1568 The Pci.Read() and Pci.Write() functions enable a driver to access PCI configuration
1569 registers for a PCI controller.
1570 The PCI Configuration operations are carried out exactly as requested. The caller is responsible for
1571 any alignment and PCI configuration width issues that a PCI Root Bridge on a platform might
1574 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1575 @param[in] Width Signifies the width of the memory operations.
1576 @param[in] Address The address within the PCI configuration space for the PCI controller.
1577 @param[in] Count The number of PCI configuration operations to perform. Bytes
1578 moved is Width size * Count, starting at Address.
1579 @param[out] Buffer For read operations, the destination buffer to store the results. For
1580 write operations, the source buffer to write data from.
1582 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
1583 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
1584 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1585 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1590 RootBridgeIoPciRead (
1591 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1592 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1598 return RootBridgeIoPciRW (This
, FALSE
, Width
, Address
, Count
, Buffer
);
1602 Enables a PCI driver to access PCI controller registers in a PCI root bridge's configuration space.
1604 The Pci.Read() and Pci.Write() functions enable a driver to access PCI configuration
1605 registers for a PCI controller.
1606 The PCI Configuration operations are carried out exactly as requested. The caller is responsible for
1607 any alignment and PCI configuration width issues that a PCI Root Bridge on a platform might
1610 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1611 @param[in] Width Signifies the width of the memory operations.
1612 @param[in] Address The address within the PCI configuration space for the PCI controller.
1613 @param[in] Count The number of PCI configuration operations to perform. Bytes
1614 moved is Width size * Count, starting at Address.
1615 @param[in] Buffer For read operations, the destination buffer to store the results. For
1616 write operations, the source buffer to write data from.
1618 @retval EFI_SUCCESS The data was read from or written to the PCI root bridge.
1619 @retval EFI_INVALID_PARAMETER Width is invalid for this PCI root bridge.
1620 @retval EFI_INVALID_PARAMETER Buffer is NULL.
1621 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1626 RootBridgeIoPciWrite (
1627 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1628 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width
,
1634 return RootBridgeIoPciRW (This
, TRUE
, Width
, Address
, Count
, Buffer
);
1638 Provides the PCI controller-specific addresses required to access system memory from a
1641 The Map() function provides the PCI controller specific addresses needed to access system
1642 memory. This function is used to map system memory for PCI bus master DMA accesses.
1644 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1645 @param[in] Operation Indicates if the bus master is going to read or write to system memory.
1646 @param[in] HostAddress The system memory address to map to the PCI controller.
1647 @param[in, out] NumberOfBytes On input the number of bytes to map. On output the number of bytes that were mapped.
1648 @param[out] DeviceAddress The resulting map address for the bus master PCI controller to use
1649 to access the system memory's HostAddress.
1650 @param[out] Mapping The value to pass to Unmap() when the bus master DMA operation is complete.
1652 @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
1653 @retval EFI_INVALID_PARAMETER Operation is invalid.
1654 @retval EFI_INVALID_PARAMETER HostAddress is NULL.
1655 @retval EFI_INVALID_PARAMETER NumberOfBytes is NULL.
1656 @retval EFI_INVALID_PARAMETER DeviceAddress is NULL.
1657 @retval EFI_INVALID_PARAMETER Mapping is NULL.
1658 @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
1659 @retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
1660 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1666 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1667 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION Operation
,
1668 IN VOID
*HostAddress
,
1669 IN OUT UINTN
*NumberOfBytes
,
1670 OUT EFI_PHYSICAL_ADDRESS
*DeviceAddress
,
1675 EFI_PHYSICAL_ADDRESS PhysicalAddress
;
1678 if (HostAddress
== NULL
|| NumberOfBytes
== NULL
|| DeviceAddress
== NULL
|| Mapping
== NULL
) {
1679 return EFI_INVALID_PARAMETER
;
1683 // Initialize the return values to their defaults
1688 // Make sure that Operation is valid
1690 if ((UINT32
)Operation
>= EfiPciOperationMaximum
) {
1691 return EFI_INVALID_PARAMETER
;
1695 // Most PCAT like chipsets can not handle performing DMA above 4GB.
1696 // If any part of the DMA transfer being mapped is above 4GB, then
1697 // map the DMA transfer to a buffer below 4GB.
1699 PhysicalAddress
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) HostAddress
;
1700 if ((PhysicalAddress
+ *NumberOfBytes
) > 0x100000000ULL
) {
1703 // Common Buffer operations can not be remapped. If the common buffer
1704 // if above 4GB, then it is not possible to generate a mapping, so return
1707 if (Operation
== EfiPciOperationBusMasterCommonBuffer
|| Operation
== EfiPciOperationBusMasterCommonBuffer64
) {
1708 return EFI_UNSUPPORTED
;
1712 // Allocate a MAP_INFO structure to remember the mapping when Unmap() is
1715 Status
= gBS
->AllocatePool (
1716 EfiBootServicesData
,
1720 if (EFI_ERROR (Status
)) {
1726 // Return a pointer to the MAP_INFO structure in Mapping
1731 // Initialize the MAP_INFO structure
1733 MapInfo
->Operation
= Operation
;
1734 MapInfo
->NumberOfBytes
= *NumberOfBytes
;
1735 MapInfo
->NumberOfPages
= EFI_SIZE_TO_PAGES(*NumberOfBytes
);
1736 MapInfo
->HostAddress
= PhysicalAddress
;
1737 MapInfo
->MappedHostAddress
= 0x00000000ffffffff;
1740 // Allocate a buffer below 4GB to map the transfer to.
1742 Status
= gBS
->AllocatePages (
1744 EfiBootServicesData
,
1745 MapInfo
->NumberOfPages
,
1746 &MapInfo
->MappedHostAddress
1748 if (EFI_ERROR (Status
)) {
1749 gBS
->FreePool (MapInfo
);
1755 // If this is a read operation from the Bus Master's point of view,
1756 // then copy the contents of the real buffer into the mapped buffer
1757 // so the Bus Master can read the contents of the real buffer.
1759 if (Operation
== EfiPciOperationBusMasterRead
|| Operation
== EfiPciOperationBusMasterRead64
) {
1761 (VOID
*)(UINTN
)MapInfo
->MappedHostAddress
,
1762 (VOID
*)(UINTN
)MapInfo
->HostAddress
,
1763 MapInfo
->NumberOfBytes
1768 // The DeviceAddress is the address of the maped buffer below 4GB
1770 *DeviceAddress
= MapInfo
->MappedHostAddress
;
1773 // The transfer is below 4GB, so the DeviceAddress is simply the HostAddress
1775 *DeviceAddress
= PhysicalAddress
;
1782 Completes the Map() operation and releases any corresponding resources.
1784 The Unmap() function completes the Map() operation and releases any corresponding resources.
1785 If the operation was an EfiPciOperationBusMasterWrite or
1786 EfiPciOperationBusMasterWrite64, the data is committed to the target system memory.
1787 Any resources used for the mapping are freed.
1789 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1790 @param[in] Mapping The mapping value returned from Map().
1792 @retval EFI_SUCCESS The range was unmapped.
1793 @retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by Map().
1794 @retval EFI_DEVICE_ERROR The data was not committed to the target system memory.
1800 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1807 // See if the Map() operation associated with this Unmap() required a mapping buffer.
1808 // If a mapping buffer was not required, then this function simply returns EFI_SUCCESS.
1810 if (Mapping
!= NULL
) {
1812 // Get the MAP_INFO structure from Mapping
1814 MapInfo
= (MAP_INFO
*)Mapping
;
1817 // If this is a write operation from the Bus Master's point of view,
1818 // then copy the contents of the mapped buffer into the real buffer
1819 // so the processor can read the contents of the real buffer.
1821 if (MapInfo
->Operation
== EfiPciOperationBusMasterWrite
|| MapInfo
->Operation
== EfiPciOperationBusMasterWrite64
) {
1823 (VOID
*)(UINTN
)MapInfo
->HostAddress
,
1824 (VOID
*)(UINTN
)MapInfo
->MappedHostAddress
,
1825 MapInfo
->NumberOfBytes
1830 // Free the mapped buffer and the MAP_INFO structure.
1832 gBS
->FreePages (MapInfo
->MappedHostAddress
, MapInfo
->NumberOfPages
);
1833 gBS
->FreePool (Mapping
);
1839 Allocates pages that are suitable for an EfiPciOperationBusMasterCommonBuffer or
1840 EfiPciOperationBusMasterCommonBuffer64 mapping.
1842 @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1843 @param Type This parameter is not used and must be ignored.
1844 @param MemoryType The type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData.
1845 @param Pages The number of pages to allocate.
1846 @param HostAddress A pointer to store the base system memory address of the allocated range.
1847 @param Attributes The requested bit mask of attributes for the allocated range. Only
1848 the attributes EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE, EFI_PCI_ATTRIBUTE_MEMORY_CACHED,
1849 and EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE may be used with this function.
1851 @retval EFI_SUCCESS The requested memory pages were allocated.
1852 @retval EFI_INVALID_PARAMETER MemoryType is invalid.
1853 @retval EFI_INVALID_PARAMETER HostAddress is NULL.
1854 @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are
1855 MEMORY_WRITE_COMBINE, MEMORY_CACHED, and DUAL_ADDRESS_CYCLE.
1856 @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
1861 RootBridgeIoAllocateBuffer (
1862 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1863 IN EFI_ALLOCATE_TYPE Type
,
1864 IN EFI_MEMORY_TYPE MemoryType
,
1866 OUT VOID
**HostAddress
,
1867 IN UINT64 Attributes
1871 EFI_PHYSICAL_ADDRESS PhysicalAddress
;
1874 // Validate Attributes
1876 if ((Attributes
& EFI_PCI_ATTRIBUTE_INVALID_FOR_ALLOCATE_BUFFER
) != 0) {
1877 return EFI_UNSUPPORTED
;
1881 // Check for invalid inputs
1883 if (HostAddress
== NULL
) {
1884 return EFI_INVALID_PARAMETER
;
1888 // The only valid memory types are EfiBootServicesData and EfiRuntimeServicesData
1890 if (MemoryType
!= EfiBootServicesData
&& MemoryType
!= EfiRuntimeServicesData
) {
1891 return EFI_INVALID_PARAMETER
;
1895 // Limit allocations to memory below 4GB
1897 PhysicalAddress
= (EFI_PHYSICAL_ADDRESS
)(0xffffffff);
1899 Status
= gBS
->AllocatePages (AllocateMaxAddress
, MemoryType
, Pages
, &PhysicalAddress
);
1900 if (EFI_ERROR (Status
)) {
1904 *HostAddress
= (VOID
*)(UINTN
)PhysicalAddress
;
1910 Frees memory that was allocated with AllocateBuffer().
1912 The FreeBuffer() function frees memory that was allocated with AllocateBuffer().
1914 @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1915 @param Pages The number of pages to free.
1916 @param HostAddress The base system memory address of the allocated range.
1918 @retval EFI_SUCCESS The requested memory pages were freed.
1919 @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
1920 was not allocated with AllocateBuffer().
1925 RootBridgeIoFreeBuffer (
1926 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1928 OUT VOID
*HostAddress
1931 return gBS
->FreePages ((EFI_PHYSICAL_ADDRESS
) (UINTN
) HostAddress
, Pages
);
1935 Flushes all PCI posted write transactions from a PCI host bridge to system memory.
1937 The Flush() function flushes any PCI posted write transactions from a PCI host bridge to system
1938 memory. Posted write transactions are generated by PCI bus masters when they perform write
1939 transactions to target addresses in system memory.
1940 This function does not flush posted write transactions from any PCI bridges. A PCI controller
1941 specific action must be taken to guarantee that the posted write transactions have been flushed from
1942 the PCI controller and from all the PCI bridges into the PCI host bridge. This is typically done with
1943 a PCI read transaction from the PCI controller prior to calling Flush().
1945 @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1947 @retval EFI_SUCCESS The PCI posted write transactions were flushed from the PCI host
1948 bridge to system memory.
1949 @retval EFI_DEVICE_ERROR The PCI posted write transactions were not flushed from the PCI
1950 host bridge due to a hardware error.
1956 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
1960 // not supported yet
1966 Gets the attributes that a PCI root bridge supports setting with SetAttributes(), and the
1967 attributes that a PCI root bridge is currently using.
1969 The GetAttributes() function returns the mask of attributes that this PCI root bridge supports
1970 and the mask of attributes that the PCI root bridge is currently using.
1972 @param This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
1973 @param Supported A pointer to the mask of attributes that this PCI root bridge
1974 supports setting with SetAttributes().
1975 @param Attributes A pointer to the mask of attributes that this PCI root bridge is
1978 @retval EFI_SUCCESS If Supports is not NULL, then the attributes that the PCI root
1979 bridge supports is returned in Supports. If Attributes is
1980 not NULL, then the attributes that the PCI root bridge is currently
1981 using is returned in Attributes.
1982 @retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL.
1987 RootBridgeIoGetAttributes (
1988 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
1989 OUT UINT64
*Supported
,
1990 OUT UINT64
*Attributes
1993 PCI_ROOT_BRIDGE_INSTANCE
*PrivateData
;
1995 PrivateData
= DRIVER_INSTANCE_FROM_PCI_ROOT_BRIDGE_IO_THIS(This
);
1997 if (Attributes
== NULL
&& Supported
== NULL
) {
1998 return EFI_INVALID_PARAMETER
;
2002 // Set the return value for Supported and Attributes
2004 if (Supported
!= NULL
) {
2005 *Supported
= PrivateData
->Supports
;
2008 if (Attributes
!= NULL
) {
2009 *Attributes
= PrivateData
->Attributes
;
2016 Sets attributes for a resource range on a PCI root bridge.
2018 The SetAttributes() function sets the attributes specified in Attributes for the PCI root
2019 bridge on the resource range specified by ResourceBase and ResourceLength. Since the
2020 granularity of setting these attributes may vary from resource type to resource type, and from
2021 platform to platform, the actual resource range and the one passed in by the caller may differ. As a
2022 result, this function may set the attributes specified by Attributes on a larger resource range
2023 than the caller requested. The actual range is returned in ResourceBase and
2024 ResourceLength. The caller is responsible for verifying that the actual range for which the
2025 attributes were set is acceptable.
2027 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
2028 @param[in] Attributes The mask of attributes to set. If the attribute bit
2029 MEMORY_WRITE_COMBINE, MEMORY_CACHED, or
2030 MEMORY_DISABLE is set, then the resource range is specified by
2031 ResourceBase and ResourceLength. If
2032 MEMORY_WRITE_COMBINE, MEMORY_CACHED, and
2033 MEMORY_DISABLE are not set, then ResourceBase and
2034 ResourceLength are ignored, and may be NULL.
2035 @param[in, out] ResourceBase A pointer to the base address of the resource range to be modified
2036 by the attributes specified by Attributes.
2037 @param[in, out] ResourceLength A pointer to the length of the resource range to be modified by the
2038 attributes specified by Attributes.
2040 @retval EFI_SUCCESS The current configuration of this PCI root bridge was returned in Resources.
2041 @retval EFI_UNSUPPORTED The current configuration of this PCI root bridge could not be retrieved.
2042 @retval EFI_INVALID_PARAMETER Invalid pointer of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
2047 RootBridgeIoSetAttributes (
2048 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
2049 IN UINT64 Attributes
,
2050 IN OUT UINT64
*ResourceBase
,
2051 IN OUT UINT64
*ResourceLength
2054 PCI_ROOT_BRIDGE_INSTANCE
*PrivateData
;
2056 PrivateData
= DRIVER_INSTANCE_FROM_PCI_ROOT_BRIDGE_IO_THIS(This
);
2058 if (Attributes
!= 0) {
2059 if ((Attributes
& (~(PrivateData
->Supports
))) != 0) {
2060 return EFI_UNSUPPORTED
;
2065 // This is a generic driver for a PC-AT class system. It does not have any
2066 // chipset specific knowlegde, so none of the attributes can be set or
2067 // cleared. Any attempt to set attribute that are already set will succeed,
2068 // and any attempt to set an attribute that is not supported will fail.
2070 if (Attributes
& (~PrivateData
->Attributes
)) {
2071 return EFI_UNSUPPORTED
;
2078 Retrieves the current resource settings of this PCI root bridge in the form of a set of ACPI 2.0
2079 resource descriptors.
2081 There are only two resource descriptor types from the ACPI Specification that may be used to
2082 describe the current resources allocated to a PCI root bridge. These are the QWORD Address
2083 Space Descriptor (ACPI 2.0 Section 6.4.3.5.1), and the End Tag (ACPI 2.0 Section 6.4.2.8). The
2084 QWORD Address Space Descriptor can describe memory, I/O, and bus number ranges for dynamic
2085 or fixed resources. The configuration of a PCI root bridge is described with one or more QWORD
2086 Address Space Descriptors followed by an End Tag.
2088 @param[in] This A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
2089 @param[out] Resources A pointer to the ACPI 2.0 resource descriptors that describe the
2090 current configuration of this PCI root bridge. The storage for the
2091 ACPI 2.0 resource descriptors is allocated by this function. The
2092 caller must treat the return buffer as read-only data, and the buffer
2093 must not be freed by the caller.
2095 @retval EFI_SUCCESS The current configuration of this PCI root bridge was returned in Resources.
2096 @retval EFI_UNSUPPORTED The current configuration of this PCI root bridge could not be retrieved.
2097 @retval EFI_INVALID_PARAMETER Invalid pointer of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
2102 RootBridgeIoConfiguration (
2103 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*This
,
2104 OUT VOID
**Resources
2107 PCI_ROOT_BRIDGE_INSTANCE
*PrivateData
;
2110 PrivateData
= DRIVER_INSTANCE_FROM_PCI_ROOT_BRIDGE_IO_THIS (This
);
2112 for (Index
= 0; Index
< TypeMax
; Index
++) {
2113 if (PrivateData
->ResAllocNode
[Index
].Status
== ResAllocated
) {
2114 Configuration
.SpaceDesp
[Index
].AddrRangeMin
= PrivateData
->ResAllocNode
[Index
].Base
;
2115 Configuration
.SpaceDesp
[Index
].AddrRangeMax
= PrivateData
->ResAllocNode
[Index
].Base
+ PrivateData
->ResAllocNode
[Index
].Length
- 1;
2116 Configuration
.SpaceDesp
[Index
].AddrLen
= PrivateData
->ResAllocNode
[Index
].Length
;
2120 *Resources
= &Configuration
;