summaryrefslogtreecommitdiff
path: root/MdePkg/Test/Mock/Include/GoogleTest/Protocol/MockHiiDatabase.h
blob: d24cc685c1fc84df6e188cbabf24e54705723c72 (plain)
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/** @file MockHiiDatabase.h
  This file declares a mock of HiiDatabase Protocol.

  Copyright (c) Microsoft Corporation.
  SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#pragma once

#include <Library/GoogleTestLib.h>
#include <Library/FunctionMockLib.h>

extern "C" {
  #include <Uefi.h>
  #include <Protocol/HiiDatabase.h>
}

struct MockHiiDatabaseProtocol {
  MOCK_INTERFACE_DECLARATION (MockHiiDatabaseProtocol);

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    NewPackageList,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL   *This,
     IN CONST  EFI_HII_PACKAGE_LIST_HEADER *PackageList,
     IN        EFI_HANDLE                  DriverHandle  OPTIONAL,
     OUT       EFI_HII_HANDLE               *Handle
    )
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    RemovePackageList,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL *This,
     IN        EFI_HII_HANDLE             Handle
    )
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    UpdatePackageList,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL   *This,
     IN        EFI_HII_HANDLE               Handle,
     IN CONST  EFI_HII_PACKAGE_LIST_HEADER *PackageList
    )
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    ListPackageLists,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL *This,
     IN        UINT8                     PackageType,
     IN CONST  EFI_GUID                  *PackageGuid,
     IN OUT    UINTN                     *HandleBufferLength,
     OUT       EFI_HII_HANDLE            *Handle
    )
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    ExportPackageLists,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL      *This,
     IN        EFI_HII_HANDLE                 Handle,
     IN OUT    UINTN                          *BufferSize,
     OUT       EFI_HII_PACKAGE_LIST_HEADER    *Buffer
    )
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    RegisterPackageNotify,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL     *This,
     IN        UINT8                         PackageType,
     IN CONST  EFI_GUID                      *PackageGuid,
     IN        EFI_HII_DATABASE_NOTIFY       PackageNotifyFn,
     IN        EFI_HII_DATABASE_NOTIFY_TYPE  NotifyType,
     OUT       EFI_HANDLE                    *NotifyHandle
    )
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    UnregisterPackageNotify,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL *This,
     IN        EFI_HANDLE                NotificationHandle
    )
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    FindKeyboardLayouts,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL *This,
     IN OUT    UINT16                    *KeyGuidBufferLength,
     OUT       EFI_GUID                  *KeyGuidBuffer
    )
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    GetKeyboardLayout,
    (IN CONST  EFI_HII_DATABASE_PROTOCOL *This,
     IN CONST  EFI_GUID                  *KeyGuid,
     IN OUT UINT16                       *KeyboardLayoutLength,
     OUT       EFI_HII_KEYBOARD_LAYOUT   *KeyboardLayout)
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    SetKeyboardLayout,
    (IN CONST  EFI_HII_DATABASE_PROTOCOL *This,
     IN CONST  EFI_GUID                  *KeyGuid)
    );

  MOCK_FUNCTION_DECLARATION (
    EFI_STATUS,
    GetPackageListHandle,
    (
     IN CONST  EFI_HII_DATABASE_PROTOCOL *This,
     IN        EFI_HII_HANDLE             PackageListHandle,
     OUT       EFI_HANDLE                *DriverHandle
    )
    );
};

MOCK_INTERFACE_DEFINITION (MockHiiDatabaseProtocol);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, NewPackageList, 4, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, RemovePackageList, 2, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, UpdatePackageList, 3, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, ListPackageLists, 5, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, ExportPackageLists, 4, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, RegisterPackageNotify, 6, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, UnregisterPackageNotify, 2, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, FindKeyboardLayouts, 3, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, GetKeyboardLayout, 4, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, SetKeyboardLayout, 2, EFIAPI);
MOCK_FUNCTION_DEFINITION (MockHiiDatabaseProtocol, GetPackageListHandle, 3, EFIAPI);

#define MOCK_EFI_HII_DATABASE_PROTOCOL_INSTANCE(NAME) \
  EFI_HII_DATABASE_PROTOCOL NAME##_INSTANCE = {       \
    NewPackageList,                                   \
    RemovePackageList,                                \
    UpdatePackageList,                                \
    ListPackageLists,                                 \
    ExportPackageLists,                               \
    RegisterPackageNotify,                            \
    UnregisterPackageNotify,                          \
    FindKeyboardLayouts,                              \
    GetKeyboardLayout,                                \
    SetKeyboardLayout,                                \
    GetPackageListHandle };                           \
  EFI_HII_DATABASE_PROTOCOL  *NAME =  &NAME##_INSTANCE;