summaryrefslogtreecommitdiff
path: root/ManageabilityPkg/Library/IpmiCommandLib/IpmiCommandLibNetFnStorage.c
blob: 59c456571823e982b04662e853d3088669a951b5 (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
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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
/** @file
  IPMI Command - NetFnStorage.

  Copyright (c) 2018 - 2021, Intel Corporation. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#include <PiPei.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/IpmiLib.h>

#include <IndustryStandard/Ipmi.h>

/**
  This function is used to retrieve FRU Inventory Area

  @param [in]  GetFruInventoryAreaInfoRequest   Pointer to IPMI_GET_FRU_INVENTORY_AREA_INFO_REQUEST.
  @param [out] GetFruInventoryAreaInfoResponse  Pointer to IPMI_GET_FRU_INVENTORY_AREA_INFO_RESPONSE.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiGetFruInventoryAreaInfo (
  IN  IPMI_GET_FRU_INVENTORY_AREA_INFO_REQUEST   *GetFruInventoryAreaInfoRequest,
  OUT IPMI_GET_FRU_INVENTORY_AREA_INFO_RESPONSE  *GetFruInventoryAreaInfoResponse
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*GetFruInventoryAreaInfoResponse);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_GET_FRU_INVENTORY_AREAINFO,
               (VOID *)GetFruInventoryAreaInfoRequest,
               sizeof (*GetFruInventoryAreaInfoRequest),
               (VOID *)GetFruInventoryAreaInfoResponse,
               &DataSize
               );
  return Status;
}

/**
  This function returns specified data from the FRU Inventory Info area.

  @param [in]  ReadFruDataRequest       Pointer to IPMI_READ_FRU_DATA_REQUEST.
  @param [out] ReadFruDataResponse      Pointer to IPMI_READ_FRU_DATA_RESPONSE.
  @param [in, out] ReadFruDataResponseSize  Returns the size of ReadFruDataResponse.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiReadFruData (
  IN  IPMI_READ_FRU_DATA_REQUEST   *ReadFruDataRequest,
  OUT IPMI_READ_FRU_DATA_RESPONSE  *ReadFruDataResponse,
  IN OUT UINT32                    *ReadFruDataResponseSize
  )
{
  EFI_STATUS  Status;

  Status = IpmiSubmitCommand (
             IPMI_NETFN_STORAGE,
             IPMI_STORAGE_READ_FRU_DATA,
             (VOID *)ReadFruDataRequest,
             sizeof (*ReadFruDataRequest),
             (VOID *)ReadFruDataResponse,
             ReadFruDataResponseSize
             );
  return Status;
}

/**
  This function writes specified data from the FRU Inventory Info area.

  @param [in]  WriteFruDataRequest      Pointer to IPMI_WRITE_FRU_DATA_REQUEST.
  @param [in]  WriteFruDataRequestSize  Size of WriteFruDataRequest.
  @param [out] WriteFruDataResponse     Pointer to receive IPMI_WRITE_FRU_DATA_RESPONSE.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiWriteFruData (
  IN  IPMI_WRITE_FRU_DATA_REQUEST   *WriteFruDataRequest,
  IN  UINT32                        WriteFruDataRequestSize,
  OUT IPMI_WRITE_FRU_DATA_RESPONSE  *WriteFruDataResponse
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*WriteFruDataResponse);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_WRITE_FRU_DATA,
               (VOID *)WriteFruDataRequest,
               WriteFruDataRequestSize,
               (VOID *)WriteFruDataResponse,
               &DataSize
               );
  return Status;
}

/**
  This function returns the number of entries in the SEL

  @param [out] GetSelInfoResponse     Pointer to receive IPMI_GET_SEL_INFO_RESPONSE.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiGetSelInfo (
  OUT IPMI_GET_SEL_INFO_RESPONSE  *GetSelInfoResponse
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*GetSelInfoResponse);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_GET_SEL_INFO,
               NULL,
               0,
               (VOID *)GetSelInfoResponse,
               &DataSize
               );
  return Status;
}

/**
  This function retrieves entries from the SEL

  @param [in]  GetSelEntryRequest       Pointer to IPMI_GET_SEL_ENTRY_REQUEST.
  @param [out] GetSelEntryResponse      Pointer to receive IPMI_GET_SEL_ENTRY_RESPONSE.
  @param [in, out]  GetSelEntryResponseSize  Size of entire GetSelEntryResponse.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiGetSelEntry (
  IN IPMI_GET_SEL_ENTRY_REQUEST    *GetSelEntryRequest,
  OUT IPMI_GET_SEL_ENTRY_RESPONSE  *GetSelEntryResponse,
  IN OUT UINT32                    *GetSelEntryResponseSize
  )
{
  EFI_STATUS  Status;

  Status = IpmiSubmitCommand (
             IPMI_NETFN_STORAGE,
             IPMI_STORAGE_GET_SEL_ENTRY,
             (VOID *)GetSelEntryRequest,
             sizeof (*GetSelEntryRequest),
             (VOID *)GetSelEntryResponse,
             GetSelEntryResponseSize
             );
  return Status;
}

/**
  This function adds an entry in the SEL

  @param [in]  AddSelEntryRequest       Pointer to IPMI_ADD_SEL_ENTRY_REQUEST.
  @param [out] AddSelEntryResponse      Pointer to receive IPMI_ADD_SEL_ENTRY_RESPONSE.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiAddSelEntry (
  IN IPMI_ADD_SEL_ENTRY_REQUEST    *AddSelEntryRequest,
  OUT IPMI_ADD_SEL_ENTRY_RESPONSE  *AddSelEntryResponse
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*AddSelEntryResponse);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_ADD_SEL_ENTRY,
               (VOID *)AddSelEntryRequest,
               sizeof (*AddSelEntryRequest),
               (VOID *)AddSelEntryResponse,
               &DataSize
               );
  return Status;
}

/**
  This function adds SEL Entry command that allows the record to be incrementally
  added to the SEL.

  @param [in]  PartialAddSelEntryRequest       Pointer to IPMI_PARTIAL_ADD_SEL_ENTRY_REQUEST.
  @param [in]  PartialAddSelEntryRequestSize   Size of entire PartialAddSelEntryRequest.
  @param [out] PartialAddSelEntryResponse      Pointer to receive IPMI_PARTIAL_ADD_SEL_ENTRY_RESPONSE.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiPartialAddSelEntry (
  IN IPMI_PARTIAL_ADD_SEL_ENTRY_REQUEST    *PartialAddSelEntryRequest,
  IN UINT32                                PartialAddSelEntryRequestSize,
  OUT IPMI_PARTIAL_ADD_SEL_ENTRY_RESPONSE  *PartialAddSelEntryResponse
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*PartialAddSelEntryResponse);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_PARTIAL_ADD_SEL_ENTRY,
               (VOID *)PartialAddSelEntryRequest,
               PartialAddSelEntryRequestSize,
               (VOID *)PartialAddSelEntryResponse,
               &DataSize
               );
  return Status;
}

/**
  This function erases all contents of the System Event Log.

  @param [in]  ClearSelRequest       Pointer to IPMI_CLEAR_SEL_REQUEST.
  @param [out] ClearSelResponse      Pointer to receive IPMI_CLEAR_SEL_RESPONSE.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiClearSel (
  IN IPMI_CLEAR_SEL_REQUEST    *ClearSelRequest,
  OUT IPMI_CLEAR_SEL_RESPONSE  *ClearSelResponse
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*ClearSelResponse);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_CLEAR_SEL,
               (VOID *)ClearSelRequest,
               sizeof (*ClearSelRequest),
               (VOID *)ClearSelResponse,
               &DataSize
               );
  return Status;
}

/**
  This function returns the time from the SEL Device.

  @param [out]  GetSelTimeResponse       Pointer to IPMI_GET_SEL_TIME_RESPONSE.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiGetSelTime (
  OUT IPMI_GET_SEL_TIME_RESPONSE  *GetSelTimeResponse
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*GetSelTimeResponse);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_GET_SEL_TIME,
               NULL,
               0,
               (VOID *)GetSelTimeResponse,
               &DataSize
               );
  return Status;
}

/**
  This function set the time in the SEL Device.

  @param [in]  SetSelTimeRequest       Pointer to IPMI_SET_SEL_TIME_REQUEST.
  @param [out] CompletionCode         IPMI completetion code, refer to Ipmi.h.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiSetSelTime (
  IN IPMI_SET_SEL_TIME_REQUEST  *SetSelTimeRequest,
  OUT UINT8                     *CompletionCode
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*CompletionCode);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_SET_SEL_TIME,
               (VOID *)SetSelTimeRequest,
               sizeof (*SetSelTimeRequest),
               (VOID *)CompletionCode,
               &DataSize
               );
  return Status;
}

/**
  This function returns the SDR command version for the SDR Repository

  @param [out] GetSdrRepositoryInfoResp      Pointer to receive IPMI_GET_SDR_REPOSITORY_INFO_RESPONSE.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiGetSdrRepositoryInfo (
  OUT IPMI_GET_SDR_REPOSITORY_INFO_RESPONSE  *GetSdrRepositoryInfoResp
  )
{
  EFI_STATUS  Status;
  UINT32      DataSize;

  DataSize = sizeof (*GetSdrRepositoryInfoResp);
  Status   = IpmiSubmitCommand (
               IPMI_NETFN_STORAGE,
               IPMI_STORAGE_GET_SDR_REPOSITORY_INFO,
               NULL,
               0,
               (VOID *)GetSdrRepositoryInfoResp,
               &DataSize
               );
  return Status;
}

/**
  This function returns the sensor record specified by Record ID.

  @param [in]  GetSdrRequest       Pointer to IPMI_GET_SDR_REQUEST.
  @param [out] GetSdrResponse      Pointer to receive IPMI_GET_SDR_RESPONSE.
  @param [in, out]  GetSdrResponseSize  Size of entire GetSdrResponse.

  @retval EFI_STATUS   See the return values of IpmiSubmitCommand () function.

**/
EFI_STATUS
EFIAPI
IpmiGetSdr (
  IN  IPMI_GET_SDR_REQUEST   *GetSdrRequest,
  OUT IPMI_GET_SDR_RESPONSE  *GetSdrResponse,
  IN OUT UINT32              *GetSdrResponseSize
  )
{
  EFI_STATUS  Status;

  Status = IpmiSubmitCommand (
             IPMI_NETFN_STORAGE,
             IPMI_STORAGE_GET_SDR,
             (VOID *)GetSdrRequest,
             sizeof (*GetSdrRequest),
             (VOID *)GetSdrResponse,
             GetSdrResponseSize
             );
  return Status;
}