]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Library/NonDiscoverableDeviceRegistrationLib.h
MdeModulePkg/S3SmmInitDone.h: Fix copyright coding style error.
[mirror_edk2.git] / MdeModulePkg / Include / Library / NonDiscoverableDeviceRegistrationLib.h
CommitLineData
1652dc21
AB
1/** @file\r
2 Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>\r
3\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 __NON_DISCOVERABLE_DEVICE_REGISTRATION_LIB_H__\r
15#define __NON_DISCOVERABLE_DEVICE_REGISTRATION_LIB_H__\r
16\r
17#include <Protocol/NonDiscoverableDevice.h>\r
18\r
19typedef enum {\r
20 NonDiscoverableDeviceTypeAhci,\r
21 NonDiscoverableDeviceTypeAmba,\r
22 NonDiscoverableDeviceTypeEhci,\r
23 NonDiscoverableDeviceTypeNvme,\r
24 NonDiscoverableDeviceTypeOhci,\r
25 NonDiscoverableDeviceTypeSdhci,\r
26 NonDiscoverableDeviceTypeUfs,\r
27 NonDiscoverableDeviceTypeUhci,\r
28 NonDiscoverableDeviceTypeXhci,\r
29 NonDiscoverableDeviceTypeMax,\r
30} NON_DISCOVERABLE_DEVICE_TYPE;\r
31\r
32/**\r
33 Register a non-discoverable MMIO device\r
34\r
9a882490 35 @param[in] Type The type of non-discoverable device\r
1652dc21
AB
36 @param[in] DmaType Whether the device is DMA coherent\r
37 @param[in] InitFunc Initialization routine to be invoked when\r
38 the device is enabled\r
39 @param[in,out] Handle The handle onto which to install the\r
40 non-discoverable device protocol.\r
41 If Handle is NULL or *Handle is NULL, a\r
42 new handle will be allocated.\r
43 @param[in] NumMmioResources The number of UINTN base/size pairs that\r
44 follow, each describing an MMIO region\r
45 owned by the device\r
9a882490
DB
46 @param[in] ... The variable argument list which contains the\r
47 info about MmioResources.\r
1652dc21
AB
48\r
49 @retval EFI_SUCCESS The registration succeeded.\r
50 @retval Other The registration failed.\r
51\r
52**/\r
53EFI_STATUS\r
54EFIAPI\r
55RegisterNonDiscoverableMmioDevice (\r
56 IN NON_DISCOVERABLE_DEVICE_TYPE Type,\r
57 IN NON_DISCOVERABLE_DEVICE_DMA_TYPE DmaType,\r
58 IN NON_DISCOVERABLE_DEVICE_INIT InitFunc,\r
59 IN OUT EFI_HANDLE *Handle OPTIONAL,\r
60 IN UINTN NumMmioResources,\r
61 ...\r
62 );\r
63\r
64#endif\r