]>
Commit | Line | Data |
---|---|---|
af2cf989 HW |
1 | /** @file\r |
2 | \r | |
3 | Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r | |
4 | This program and the accompanying materials\r | |
5 | are licensed and made available under the terms and conditions of the BSD License\r | |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | \r | |
12 | **/\r | |
13 | \r | |
14 | #ifndef _EDKII_ATA_AHCI_HOST_CONTROLLER_PPI_H_\r | |
15 | #define _EDKII_ATA_AHCI_HOST_CONTROLLER_PPI_H_\r | |
16 | \r | |
17 | #include <Protocol/DevicePath.h>\r | |
18 | \r | |
19 | ///\r | |
20 | /// Global ID for the EDKII_ATA_AHCI_HOST_CONTROLLER_PPI.\r | |
21 | ///\r | |
22 | #define EDKII_ATA_AHCI_HOST_CONTROLLER_PPI_GUID \\r | |
23 | { \\r | |
24 | 0x61dd33ea, 0x421f, 0x4cc0, { 0x89, 0x29, 0xff, 0xee, 0xa9, 0xa1, 0xa2, 0x61 } \\r | |
25 | }\r | |
26 | \r | |
27 | //\r | |
28 | // Forward declaration for the EDKII_ATA_AHCI_HOST_CONTROLLER_PPI.\r | |
29 | //\r | |
30 | typedef struct _EDKII_ATA_AHCI_HOST_CONTROLLER_PPI EDKII_ATA_AHCI_HOST_CONTROLLER_PPI;\r | |
31 | \r | |
32 | /**\r | |
33 | Get the MMIO base address of ATA AHCI host controller.\r | |
34 | \r | |
35 | @param[in] This The PPI instance pointer.\r | |
36 | @param[in] ControllerId The ID of the ATA AHCI host controller.\r | |
37 | @param[out] MmioBar The MMIO base address of the controller.\r | |
38 | \r | |
39 | @retval EFI_SUCCESS The operation succeeds.\r | |
40 | @retval EFI_INVALID_PARAMETER The parameters are invalid.\r | |
41 | @retval EFI_NOT_FOUND The specified ATA AHCI host controller not found.\r | |
42 | \r | |
43 | **/\r | |
44 | typedef\r | |
45 | EFI_STATUS\r | |
46 | (EFIAPI *EDKII_ATA_AHCI_HC_GET_MMIO_BAR) (\r | |
47 | IN EDKII_ATA_AHCI_HOST_CONTROLLER_PPI *This,\r | |
48 | IN UINT8 ControllerId,\r | |
49 | OUT UINTN *MmioBar\r | |
50 | );\r | |
51 | \r | |
52 | /**\r | |
53 | Get the device path of ATA AHCI host controller.\r | |
54 | \r | |
55 | @param[in] This The PPI instance pointer.\r | |
56 | @param[in] ControllerId The ID of the ATA AHCI host controller.\r | |
57 | @param[out] DevicePathLength The length of the device path in bytes specified\r | |
58 | by DevicePath.\r | |
59 | @param[out] DevicePath The device path of ATA AHCI host controller.\r | |
60 | This field re-uses EFI Device Path Protocol as\r | |
61 | defined by Section 10.2 EFI Device Path Protocol\r | |
62 | of UEFI 2.7 Specification.\r | |
63 | \r | |
64 | @retval EFI_SUCCESS The operation succeeds.\r | |
65 | @retval EFI_INVALID_PARAMETER The parameters are invalid.\r | |
66 | @retval EFI_NOT_FOUND The specified ATA AHCI host controller not found.\r | |
67 | @retval EFI_OUT_OF_RESOURCES The operation fails due to lack of resources.\r | |
68 | \r | |
69 | **/\r | |
70 | typedef\r | |
71 | EFI_STATUS\r | |
72 | (EFIAPI *EDKII_ATA_AHCI_HC_GET_DEVICE_PATH) (\r | |
73 | IN EDKII_ATA_AHCI_HOST_CONTROLLER_PPI *This,\r | |
74 | IN UINT8 ControllerId,\r | |
75 | OUT UINTN *DevicePathLength,\r | |
76 | OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
77 | );\r | |
78 | \r | |
79 | //\r | |
80 | // This PPI contains a set of services to interact with the ATA AHCI host controller.\r | |
81 | //\r | |
82 | struct _EDKII_ATA_AHCI_HOST_CONTROLLER_PPI {\r | |
83 | EDKII_ATA_AHCI_HC_GET_MMIO_BAR GetAhciHcMmioBar;\r | |
84 | EDKII_ATA_AHCI_HC_GET_DEVICE_PATH GetAhciHcDevicePath;\r | |
85 | };\r | |
86 | \r | |
87 | extern EFI_GUID gEdkiiPeiAtaAhciHostControllerPpiGuid;\r | |
88 | \r | |
89 | #endif\r |