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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
/** @file
This file defines the EDKII_REDFISH_HTTP_PROTOCOL interface.
Copyright (c) 2023-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef EDKII_REDFISH_HTTP_PROTOCOL_H_
#define EDKII_REDFISH_HTTP_PROTOCOL_H_
#include <RedfishServiceData.h>
#include <Library/JsonLib.h>
#include <Protocol/EdkIIRedfishConfigHandler.h>
typedef struct _EDKII_REDFISH_HTTP_PROTOCOL EDKII_REDFISH_HTTP_PROTOCOL;
/**
This function create Redfish service. It's caller's responsibility to free returned
Redfish service by calling FreeService ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] RedfishConfigServiceInfo Redfish config service information.
@retval REDFISH_SERVICE Redfish service is created.
@retval NULL Errors occur.
**/
typedef
REDFISH_SERVICE
(EFIAPI *REDFISH_HTTP_CREATE_SERVICE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo
);
/**
This function free resources in Redfish service. RedfishService is no longer available
after this function returns successfully.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] RedfishService Pointer to Redfish service to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_FREE_SERVICE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE RedfishService
);
/**
This function returns JSON value in given RedfishPayload. Returned JSON value
is a reference to the JSON value in RedfishPayload. Any modification to returned
JSON value will change JSON value in RedfishPayload.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] RedfishPayload Pointer to Redfish payload.
@retval EDKII_JSON_VALUE JSON value is returned.
@retval NULL Errors occur.
**/
typedef
EDKII_JSON_VALUE
(EFIAPI *REDFISH_HTTP_JSON_IN_PAYLOAD)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_PAYLOAD RedfishPayload
);
/**
This function free resources in Request. Request is no longer available
after this function returns successfully.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Request HTTP request to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_FREE_REQUEST)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_REQUEST *Request
);
/**
This function free resources in Response. Response is no longer available
after this function returns successfully.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Response HTTP response to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_FREE_RESPONSE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_RESPONSE *Response
);
/**
This function expire the cached response of given URI.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Uri Target response of URI.
@retval EFI_SUCCESS Target response is expired successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_EXPIRE_RESPONSE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN EFI_STRING Uri
);
/**
Perform HTTP GET to Get redfish resource from given resource URI with
cache mechanism supported. It's caller's responsibility to free Response
by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP GET.
@param[in] Uri Target resource URI.
@param[in] Request Additional request context. This is optional.
@param[out] Response HTTP response from redfish service.
@param[in] UseCache If it is TRUE, this function will search for
cache first. If it is FALSE, this function
will query Redfish URI directly.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_GET_RESOURCE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN REDFISH_REQUEST *Request OPTIONAL,
OUT REDFISH_RESPONSE *Response,
IN BOOLEAN UseCache
);
/**
Perform HTTP PATCH to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP PATCH.
@param[in] Uri Target resource URI.
@param[in] Content Data to patch.
@param[in] ContentSize Size of the Content to be send to Redfish service.
This is optional. When ContentSize is 0, ContentSize
is the size of Content.
@param[in] ContentType Type of the Content to be send to Redfish service.
This is optional. When ContentType is NULL, content
type HTTP_CONTENT_TYPE_APP_JSON will be used.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_PATCH_RESOURCE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
);
/**
Perform HTTP PUT to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP PUT.
@param[in] Uri Target resource URI.
@param[in] Content Data to put.
@param[in] ContentSize Size of the Content to be send to Redfish service.
This is optional. When ContentSize is 0, ContentSize
is the size of Content.
@param[in] ContentType Type of the Content to be send to Redfish service.
This is optional. When ContentType is NULL, content
type HTTP_CONTENT_TYPE_APP_JSON will be used.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_PUT_RESOURCE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
);
/**
Perform HTTP POST to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP POST.
@param[in] Uri Target resource URI.
@param[in] Content Data to post.
@param[in] ContentSize Size of the Content to be send to Redfish service.
This is optional. When ContentSize is 0, ContentSize
is the size of Content.
@param[in] ContentType Type of the Content to be send to Redfish service.
This is optional. When ContentType is NULL, content
type HTTP_CONTENT_TYPE_APP_JSON will be used.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_POST_RESOURCE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
);
/**
Perform HTTP DELETE to delete redfish resource on given resource URI.
It's caller's responsibility to free Response by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP DELETE.
@param[in] Uri Target resource URI.
@param[in] Content JSON represented properties to be deleted. This is
optional.
@param[in] ContentSize Size of the Content to be send to Redfish service.
This is optional. When ContentSize is 0, ContentSize
is the size of Content if Content is not NULL.
@param[in] ContentType Type of the Content to be send to Redfish service.
This is optional. When Content is not NULL and
ContentType is NULL, content type HTTP_CONTENT_TYPE_APP_JSON
will be used.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_DELETE_RESOURCE)(
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content OPTIONAL,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
);
///
/// Definition of _EDKII_REDFISH_HTTP_PROTOCOL.
///
struct _EDKII_REDFISH_HTTP_PROTOCOL {
UINT32 Version;
REDFISH_HTTP_CREATE_SERVICE CreateService;
REDFISH_HTTP_FREE_SERVICE FreeService;
REDFISH_HTTP_JSON_IN_PAYLOAD JsonInPayload;
REDFISH_HTTP_GET_RESOURCE GetResource;
REDFISH_HTTP_PATCH_RESOURCE PatchResource;
REDFISH_HTTP_PUT_RESOURCE PutResource;
REDFISH_HTTP_POST_RESOURCE PostResource;
REDFISH_HTTP_DELETE_RESOURCE DeleteResource;
REDFISH_HTTP_FREE_REQUEST FreeRequest;
REDFISH_HTTP_FREE_RESPONSE FreeResponse;
REDFISH_HTTP_EXPIRE_RESPONSE ExpireResponse;
};
#define EDKII_REDFISH_HTTP_PROTOCOL_REVISION 0x00001000
extern EFI_GUID gEdkIIRedfishHttpProtocolGuid;
#endif
|
