Fix typo in comment.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / PciCfg.h
CommitLineData
caf45c98 1/** @file\r
2 This file declares PciCfg PPI used to access PCI configuration space in PEI\r
3\r
4 Copyright (c) 2006, Intel Corporation \r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
13 Module Name: PciCfg.h\r
14\r
15 @par Revision Reference:\r
16 This PPI is defined in PEI CIS\r
17 Version 0.91.\r
18\r
19**/\r
20\r
21#ifndef __PEI_PCI_CFG_H__\r
22#define __PEI_PCI_CFG_H__\r
23\r
7459094d 24#include <Pi/PiPeiCis.h>\r
25\r
caf45c98 26#define EFI_PEI_PCI_CFG_PPI_INSTALLED_GUID \\r
27 { \\r
28 0xe1f2eba0, 0xf7b9, 0x4a26, {0x86, 0x20, 0x13, 0x12, 0x21, 0x64, 0x2a, 0x90 } \\r
29 }\r
30\r
31typedef struct _EFI_PEI_PCI_CFG_PPI EFI_PEI_PCI_CFG_PPI;\r
32\r
33#define PEI_PCI_CFG_ADDRESS(bus, dev, func, reg) ( \\r
34 (UINT64) ((((UINTN) bus) << 24) + (((UINTN) dev) << 16) + (((UINTN) func) << 8) + ((UINTN) reg)) \\r
35 ) & 0x00000000ffffffff\r
36\r
37/**\r
38 PCI read and write operation.\r
39\r
40 @param PeiServices An indirect pointer to the PEI Services Table\r
41 published by the PEI Foundation.\r
42 @param This Pointer to local data for the interface.\r
43 @param Width The width of the access. Enumerated in bytes.\r
44 @param Address The physical address of the access.\r
45 @param Buffer A pointer to the buffer of data.\r
46\r
47 @retval EFI_SUCCESS The function completed successfully.\r
48 @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r
49\r
50**/\r
51typedef\r
52EFI_STATUS\r
53(EFIAPI *EFI_PEI_PCI_CFG_PPI_IO) (\r
54 IN EFI_PEI_SERVICES **PeiServices,\r
55 IN EFI_PEI_PCI_CFG_PPI *This,\r
56 IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
57 IN UINT64 Address,\r
58 IN OUT VOID *Buffer\r
59 );\r
60\r
61/**\r
62 PCI read-modify-write operation.\r
63\r
64 @param PeiServices An indirect pointer to the PEI Services Table\r
65 published by the PEI Foundation.\r
66 @param This Pointer to local data for the interface.\r
67 @param Width The width of the access. Enumerated in bytes.\r
68 @param Address The physical address of the access.\r
69 @param SetBits Value of the bits to set.\r
70 @param ClearBits Value of the bits to clear.\r
71\r
72 @retval EFI_SUCCESS The function completed successfully.\r
73\r
74**/\r
75typedef\r
76EFI_STATUS\r
77(EFIAPI *EFI_PEI_PCI_CFG_PPI_RW) (\r
78 IN EFI_PEI_SERVICES **PeiServices,\r
79 IN EFI_PEI_PCI_CFG_PPI *This,\r
80 IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
81 IN UINT64 Address,\r
82 IN UINTN SetBits,\r
83 IN UINTN ClearBits\r
84 );\r
85\r
86/**\r
caf45c98 87 The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI \r
88 controllers behind a PCI root bridge controller.\r
89\r
90 @param Read\r
91 PCI read services. See the Read() function description.\r
92\r
93 @param Write\r
94 PCI write services. See the Write() function description.\r
95\r
96 @param Modify\r
97 PCI read-modify-write services. See the Modify() function description.\r
98\r
99**/\r
100struct _EFI_PEI_PCI_CFG_PPI {\r
101 EFI_PEI_PCI_CFG_PPI_IO Read;\r
102 EFI_PEI_PCI_CFG_PPI_IO Write;\r
103 EFI_PEI_PCI_CFG_PPI_RW Modify;\r
104};\r
105\r
106extern EFI_GUID gEfiPciCfgPpiInServiceTableGuid;\r
107\r
108#endif\r