Add PciCfg PPI definitions
[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / PciCfg.h
1 /** @file
2 This file declares PciCfg PPI used to access PCI configuration space in PEI
3
4 Copyright (c) 2006, Intel Corporation
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
9
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.
12
13 Module Name: PciCfg.h
14
15 @par Revision Reference:
16 This PPI is defined in PEI CIS
17 Version 0.91.
18
19 **/
20
21 #ifndef __PEI_PCI_CFG_H__
22 #define __PEI_PCI_CFG_H__
23
24 #define EFI_PEI_PCI_CFG_PPI_INSTALLED_GUID \
25 { \
26 0xe1f2eba0, 0xf7b9, 0x4a26, {0x86, 0x20, 0x13, 0x12, 0x21, 0x64, 0x2a, 0x90 } \
27 }
28
29 typedef struct _EFI_PEI_PCI_CFG_PPI EFI_PEI_PCI_CFG_PPI;
30
31 #define PEI_PCI_CFG_ADDRESS(bus, dev, func, reg) ( \
32 (UINT64) ((((UINTN) bus) << 24) + (((UINTN) dev) << 16) + (((UINTN) func) << 8) + ((UINTN) reg)) \
33 ) & 0x00000000ffffffff
34
35 /**
36 PCI read and write operation.
37
38 @param PeiServices An indirect pointer to the PEI Services Table
39 published by the PEI Foundation.
40 @param This Pointer to local data for the interface.
41 @param Width The width of the access. Enumerated in bytes.
42 @param Address The physical address of the access.
43 @param Buffer A pointer to the buffer of data.
44
45 @retval EFI_SUCCESS The function completed successfully.
46 @retval EFI_NOT_YET_AVAILABLE The service has not been installed.
47
48 **/
49 typedef
50 EFI_STATUS
51 (EFIAPI *EFI_PEI_PCI_CFG_PPI_IO) (
52 IN EFI_PEI_SERVICES **PeiServices,
53 IN EFI_PEI_PCI_CFG_PPI *This,
54 IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,
55 IN UINT64 Address,
56 IN OUT VOID *Buffer
57 );
58
59 /**
60 PCI read-modify-write operation.
61
62 @param PeiServices An indirect pointer to the PEI Services Table
63 published by the PEI Foundation.
64 @param This Pointer to local data for the interface.
65 @param Width The width of the access. Enumerated in bytes.
66 @param Address The physical address of the access.
67 @param SetBits Value of the bits to set.
68 @param ClearBits Value of the bits to clear.
69
70 @retval EFI_SUCCESS The function completed successfully.
71
72 **/
73 typedef
74 EFI_STATUS
75 (EFIAPI *EFI_PEI_PCI_CFG_PPI_RW) (
76 IN EFI_PEI_SERVICES **PeiServices,
77 IN EFI_PEI_PCI_CFG_PPI *This,
78 IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,
79 IN UINT64 Address,
80 IN UINTN SetBits,
81 IN UINTN ClearBits
82 );
83
84 /**
85 @par Ppi Description:
86 The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI
87 controllers behind a PCI root bridge controller.
88
89 @param Read
90 PCI read services. See the Read() function description.
91
92 @param Write
93 PCI write services. See the Write() function description.
94
95 @param Modify
96 PCI read-modify-write services. See the Modify() function description.
97
98 **/
99 struct _EFI_PEI_PCI_CFG_PPI {
100 EFI_PEI_PCI_CFG_PPI_IO Read;
101 EFI_PEI_PCI_CFG_PPI_IO Write;
102 EFI_PEI_PCI_CFG_PPI_RW Modify;
103 };
104
105 extern EFI_GUID gEfiPciCfgPpiInServiceTableGuid;
106
107 #endif