init

hc

2024-03-22 a0752693d998599af469473b8dc239ef973a012f

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 
  Library functions for SetupLib. 
  This library instance provides methods to access Setup option. 
 
  @copyright 
  Copyright 2012 - 2021 Intel Corporation. <BR> 
 
  SPDX-License-Identifier: BSD-2-Clause-Patent 
**/ 
 
#include <Uefi/UefiBaseType.h> 
#include <SetupTable.h> 
 
/** 
  This function provides a means by which to retrieve a value for a given option. 
 
  Returns the data, data type and data size specified by OptionNumber and Guid. 
 
  @param[in]  Guid          Pointer to a 128-bit unique value that designates 
                            which namespace to retrieve a value from. 
  @param[in]  OptionNumber  The option number to retrieve a current value for. 
  @param[in, out] Data      A pointer to the buffer to be retrieved. 
  @param[in, out] DataSize  The size, in bytes, of Buffer. 
 
  @retval EFI_SUCCESS           Data is successfully reterieved. 
  @retval EFI_INVALID_PARAMETER Guid is NULL or DataSize is NULL or OptionNumber is invalid. 
  @retval EFI_BUFFER_TOO_SMALL  Input data buffer is not enough. 
  @retval EFI_NOT_FOUND         The given option is not found. 
 
**/ 
EFI_STATUS 
EFIAPI 
GetOptionData ( 
  IN EFI_GUID            *Guid, 
  IN UINTN               OptionNumber, 
  IN OUT VOID            *Data, 
  IN UINTN               DataSize 
  ) 
{ 
  return EFI_NOT_FOUND; 
} 
 
/** 
  This function provides a means by which to set a value for a given option number. 
 
  Sets a buffer for the token specified by OptionNumber to the value specified by 
  Data and DataSize. 
  If DataSize is greater than the maximum size support by OptionNumber, 
  then set DataSize to the maximum size supported by OptionNumber. 
 
  @param[in]  Guid              Pointer to a 128-bit unique value that 
                                designates which namespace to set a value from. 
  @param[in]  OptionNumber      The option number to set a current value for. 
  @param[in]  Data              A pointer to the buffer to set. 
  @param[in, out] DataSize      The size, in bytes, of Buffer. 
 
  @retval EFI_SUCCESS           Data is successfully updated. 
  @retval EFI_INVALID_PARAMETER OptionNumber is invalid, Guid is NULL, or Data is NULL, or DataSize is NULL. 
  @retval EFI_NOT_FOUND         The given option is not found. 
  @retval EFI_UNSUPPORTED       Set action is not supported. 
**/ 
EFI_STATUS 
EFIAPI 
SetOptionData ( 
  IN EFI_GUID *Guid, 
  IN UINTN    OptionNumber, 
  IN VOID     *Data, 
  IN UINTN    DataSize 
  ) 
{ 
  return EFI_NOT_FOUND; 
} 
 
/** 
  Get all data in the setup 
 
  @retval EFI_SUCCESS           Data is committed successfully. 
  @retval EFI_INVALID_PARAMETER Guid is NULL. 
  @retval EFI_NOT_FOUND         Guid is not found. 
  @retval EFI_DEVICE_ERROR      Data can't be committed. 
**/ 
EFI_STATUS 
EFIAPI 
GetEntireConfig ( 
  OUT SETUP_DATA *SetupData 
  ) 
{ 
  return EFI_NOT_FOUND; 
} 
 
 
/** 
  Set all data in the setup 
 
  @retval EFI_SUCCESS           Data is committed successfully. 
  @retval EFI_INVALID_PARAMETER Guid is NULL. 
  @retval EFI_NOT_FOUND         Guid is not found. 
  @retval EFI_DEVICE_ERROR      Data can't be committed. 
**/ 
EFI_STATUS 
EFIAPI 
SetEntireConfig ( 
  IN SETUP_DATA *SetupData 
  ) 
{ 
  return EFI_NOT_FOUND; 
} 
 
/** 
  This function provides a means by which to retrieve a value for a given option. 
 
  Returns the data, data type and data size specified by OptionNumber and Guid. 
 
  @param[in]  Guid          Pointer to a 128-bit unique value that designates 
                            which namespace to retrieve a value from. 
  @param[in]  Variable      Pointer to data location where variable is stored. 
 
  @retval EFI_SUCCESS           Data is successfully reterieved. 
  @retval EFI_INVALID_PARAMETER Guid or Variable is null. 
  @retval EFI_NOT_FOUND         The given option is not found. 
 
**/ 
EFI_STATUS 
EFIAPI 
GetSpecificConfigGuid ( 
  IN EFI_GUID            *Guid, 
  OUT VOID               *Variable 
  ) 
{ 
  return EFI_NOT_FOUND; 
} 
 
/** 
  This function provides a means by which to set a value for a given option number. 
 
  Sets a buffer for the token specified by OptionNumber to the value specified by 
  Data and DataSize. 
  If DataSize is greater than the maximum size support by OptionNumber, 
  then set DataSize to the maximum size supported by OptionNumber. 
 
  @param[in]  Guid              Pointer to a 128-bit unique value that 
                                designates which namespace to set a value from. 
  @param[in]  Variable      Pointer to data location where variable is stored. 
 
  @retval EFI_SUCCESS           Data is successfully updated. 
  @retval EFI_INVALID_PARAMETER OptionNumber is invalid, Guid is NULL, or Data is NULL, or DataSize is NULL. 
  @retval EFI_NOT_FOUND         The given option is not found. 
  @retval EFI_UNSUPPORTED       Set action is not supported. 
**/ 
EFI_STATUS 
EFIAPI 
SetSpecificConfigGuid ( 
  IN EFI_GUID *Guid, 
  IN VOID *Variable 
  ) 
{ 
  return EFI_NOT_FOUND; 
}