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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/** @file
Provides services to retrieve values from Version 1 of a capsule's FMP Payload
Header. The FMP Payload Header structure is not defined in the library class.
Instead, services are provided to retrieve information from the FMP Payload
Header. If information is added to the FMP Payload Header, then new services
may be added to this library class to retrieve the new information.
Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**/
#include <PiDxe.h>
#include <Library/FmpPayloadHeaderLib.h>
///
/// Define FMP Payload Header structure here so it is not public
///
#pragma pack(1)
typedef struct {
UINT32 Signature;
UINT32 HeaderSize;
UINT32 FwVersion;
UINT32 LowestSupportedVersion;
} FMP_PAYLOAD_HEADER;
#pragma pack()
///
/// Identifier is used to make sure the data in the header is for this structure
/// and version. If the structure changes update the last digit.
///
#define FMP_PAYLOAD_HEADER_SIGNATURE SIGNATURE_32 ('M', 'S', 'S', '1')
/**
Returns the FMP Payload Header size in bytes.
@param[in] Header FMP Payload Header to evaluate
@param[in] FmpPayloadSize Size of FMP payload
@param[out] Size The size, in bytes, of the FMP Payload Header.
@retval EFI_SUCCESS The firmware version was returned.
@retval EFI_INVALID_PARAMETER Header is NULL.
@retval EFI_INVALID_PARAMETER Size is NULL.
@retval EFI_INVALID_PARAMETER Header is not a valid FMP Payload Header.
**/
EFI_STATUS
EFIAPI
GetFmpPayloadHeaderSize (
IN CONST VOID *Header,
IN CONST UINTN FmpPayloadSize,
OUT UINT32 *Size
)
{
FMP_PAYLOAD_HEADER *FmpPayloadHeader;
FmpPayloadHeader = NULL;
if (Header == NULL || Size == NULL) {
return EFI_INVALID_PARAMETER;
}
FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
if ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader ||
(UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize ||
FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)) {
return EFI_INVALID_PARAMETER;
}
if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
return EFI_INVALID_PARAMETER;
}
*Size = FmpPayloadHeader->HeaderSize;
return EFI_SUCCESS;
}
/**
Returns the version described in the FMP Payload Header.
@param[in] Header FMP Payload Header to evaluate
@param[in] FmpPayloadSize Size of FMP payload
@param[out] Version The firmware version described in the FMP Payload
Header.
@retval EFI_SUCCESS The firmware version was returned.
@retval EFI_INVALID_PARAMETER Header is NULL.
@retval EFI_INVALID_PARAMETER Version is NULL.
@retval EFI_INVALID_PARAMETER Header is not a valid FMP Payload Header.
**/
EFI_STATUS
EFIAPI
GetFmpPayloadHeaderVersion (
IN CONST VOID *Header,
IN CONST UINTN FmpPayloadSize,
OUT UINT32 *Version
)
{
FMP_PAYLOAD_HEADER *FmpPayloadHeader;
FmpPayloadHeader = NULL;
if (Header == NULL || Version == NULL) {
return EFI_INVALID_PARAMETER;
}
FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
if ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader ||
(UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize ||
FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)) {
return EFI_INVALID_PARAMETER;
}
if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
return EFI_INVALID_PARAMETER;
}
*Version = FmpPayloadHeader->FwVersion;
return EFI_SUCCESS;
}
/**
Returns the lowest supported version described in the FMP Payload Header.
@param[in] Header FMP Payload Header to evaluate
@param[in] FmpPayloadSize Size of FMP payload
@param[out] LowestSupportedVersion The lowest supported version described in
the FMP Payload Header.
@retval EFI_SUCCESS The lowest support version was returned.
@retval EFI_INVALID_PARAMETER Header is NULL.
@retval EFI_INVALID_PARAMETER LowestSupportedVersion is NULL.
@retval EFI_INVALID_PARAMETER Header is not a valid FMP Payload Header.
**/
EFI_STATUS
EFIAPI
GetFmpPayloadHeaderLowestSupportedVersion (
IN CONST VOID *Header,
IN CONST UINTN FmpPayloadSize,
IN OUT UINT32 *LowestSupportedVersion
)
{
FMP_PAYLOAD_HEADER *FmpPayloadHeader;
FmpPayloadHeader = NULL;
if (Header == NULL || LowestSupportedVersion == NULL) {
return EFI_INVALID_PARAMETER;
}
FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
if ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader ||
(UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize ||
FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)) {
return EFI_INVALID_PARAMETER;
}
if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
return EFI_INVALID_PARAMETER;
}
*LowestSupportedVersion = FmpPayloadHeader->LowestSupportedVersion;
return EFI_SUCCESS;
}
|
