1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/**@file
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _PCI_HOT_PLUG_H_
#define _PCI_HOT_PLUG_H_
//
// External include files do NOT need to be explicitly specified in real EDKII
// environment
//
#include <Base.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <IndustryStandard/Acpi10.h>
#include <Protocol/PciHotPlugInit.h>
#include <Protocol/PciRootBridgeIo.h>
#include <Library/DevicePathLib.h>
#include <Library/UefiLib.h>
#include <Guid/HobList.h>
#include <Library/HobLib.h>
#include <Protocol/SaPolicy.h>
#define PCI_HOT_PLUG_DRIVER_PRIVATE_SIGNATURE SIGNATURE_32 ('G', 'U', 'L', 'P')
#define ACPI \
{ \
{ ACPI_DEVICE_PATH, ACPI_DP, { (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), (UINT8) \
((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) } }, EISA_PNP_ID (0x0A03), 0 \
}
#define PCI(device, function) \
{ \
{ HARDWARE_DEVICE_PATH, HW_PCI_DP, { (UINT8) (sizeof (PCI_DEVICE_PATH)), (UINT8) ((sizeof (PCI_DEVICE_PATH)) >> 8) } }, \
(UINTN) function, (UINTN) device \
}
#define END \
{ \
END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, { END_DEVICE_PATH_LENGTH, 0 } \
}
#define LPC(eisaid, function) \
{ \
{ ACPI_DEVICE_PATH, ACPI_DP, { (UINT8) (sizeof (ACPI_HID_DEVICE_PATH)), (UINT8) \
((sizeof (ACPI_HID_DEVICE_PATH)) >> 8) } }, EISA_PNP_ID (eisaid), function \
}
typedef struct PCIE_HOT_PLUG_DEVICE_PATH {
ACPI_HID_DEVICE_PATH PciRootBridgeNode;
PCI_DEVICE_PATH PciRootPortNode;
EFI_DEVICE_PATH_PROTOCOL EndDeviceNode;
} PCIE_HOT_PLUG_DEVICE_PATH;
typedef struct {
UINTN Signature;
EFI_HANDLE Handle; // Handle for protocol this driver installs on
EFI_PCI_HOT_PLUG_INIT_PROTOCOL HotPlugInitProtocol;
} PCI_HOT_PLUG_INSTANCE;
/**
This procedure returns a list of Root Hot Plug controllers that require
initialization during boot process
@param[in] This The pointer to the instance of the EFI_PCI_HOT_PLUG_INIT protocol.
@param[out] HpcCount The number of Root HPCs returned.
@param[out] HpcList The list of Root HPCs. HpcCount defines the number of elements in this list.
@retval EFI_SUCCESS.
**/
EFI_STATUS
EFIAPI
GetRootHpcList (
IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This,
OUT UINTN *PhpcCount,
OUT EFI_HPC_LOCATION **PhpcList
);
/**
This procedure Initializes one Root Hot Plug Controller
This process may casue initialization of its subordinate buses
@param[in] This The pointer to the instance of the EFI_PCI_HOT_PLUG_INIT protocol.
@param[in] HpcDevicePath The Device Path to the HPC that is being initialized.
@param[in] HpcPciAddress The address of the Hot Plug Controller function on the PCI bus.
@param[in] Event The event that should be signaled when the Hot Plug Controller initialization is complete. Set to NULL if the caller wants to wait until the entire initialization process is complete. The event must be of the type EFI_EVT_SIGNAL.
@param[out] HpcState The state of the Hot Plug Controller hardware. The type EFI_Hpc_STATE is defined in section 3.1.
@retval EFI_SUCCESS.
**/
EFI_STATUS
EFIAPI
InitializeRootHpc (
IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This,
IN EFI_DEVICE_PATH_PROTOCOL *PhpcDevicePath,
IN UINT64 PhpcPciAddress,
IN EFI_EVENT Event, OPTIONAL
OUT EFI_HPC_STATE *PhpcState
);
/**
Returns the resource padding required by the PCI bus that is controlled by the specified Hot Plug Controller.
@param[in] This The pointer to the instance of the EFI_PCI_HOT_PLUG_INIT protocol. initialized.
@param[in] HpcDevicePath The Device Path to the Hot Plug Controller.
@param[in] HpcPciAddress The address of the Hot Plug Controller function on the PCI bus.
@param[out] HpcState The state of the Hot Plug Controller hardware. The type EFI_HPC_STATE is defined in section 3.1.
@param[out] Padding This is the amount of resource padding required by the PCI bus under the control of the specified Hpc. Since the caller does not know the size of this buffer, this buffer is allocated by the callee and freed by the caller.
@param[out] Attribute Describes how padding is accounted for.
@retval EFI_SUCCESS.
**/
EFI_STATUS
EFIAPI
GetResourcePadding (
IN EFI_PCI_HOT_PLUG_INIT_PROTOCOL *This,
IN EFI_DEVICE_PATH_PROTOCOL *PhpcDevicePath,
IN UINT64 PhpcPciAddress,
OUT EFI_HPC_STATE *PhpcState,
OUT VOID **Padding,
OUT EFI_HPC_PADDING_ATTRIBUTES *Attributes
);
#endif
|
