1*** Settings ***
2Documentation  Test IPMI sensor IDs.
3
4Resource               ../lib/ipmi_client.robot
5Resource               ../lib/rest_client.robot
6Resource               ../lib/openbmc_ffdc.robot
7Resource               ../lib/boot_utils.robot
8Resource               ../lib/bmc_redfish_resource.robot
9Library                ../lib/ipmi_utils.py
10Library                ../lib/utilities.py
11Variables              ../data/ipmi_raw_cmd_table.py
12
13Suite setup             Suite Setup Execution
14Suite Teardown          Redfish.Logout
15Test Teardown           Test Teardown Execution
16
17Force Tags              IPMI_SDR
18
19*** Test Cases ***
20
21Verify SDR Info
22    [Documentation]  Verify sdr info command output.
23    [Tags]  Verify_SDR_Info
24    # Example of SDR info command output:
25    # SDR Version                         : 0x51
26    # Record Count                        : 216
27    # Free Space                          : unspecified
28    # Most recent Addition                :
29    # Most recent Erase                   :
30    # SDR overflow                        : no
31    # SDR Repository Update Support       : unspecified
32    # Delete SDR supported                : no
33    # Partial Add SDR supported           : no
34    # Reserve SDR repository supported    : no
35    # SDR Repository Alloc info supported : no
36
37    # Check if delete, partially add, reserve SDR and get SDR alloc info command are supported or not.
38    ${support_delete_sdr}=  Fetch IPMI Command Support Status
39    ...  ${IPMI_RAW_CMD['SDR']['Delete SDR'][0]}
40    ${support_partial_add}=  Fetch IPMI Command Support Status
41    ...  ${IPMI_RAW_CMD['SDR']['Partially Add SDR'][0]}
42    ${support_reserve_sdr_repository}=  Fetch IPMI Command Support Status
43    ...  ${IPMI_RAW_CMD['SDR']['Reserve SDR Repository'][0]}
44    ${support_sdr_repository_alloc_info}=  Fetch IPMI Command Support Status
45    ...  ${IPMI_RAW_CMD['SDR']['Get SDR allocation Info'][0]}
46
47    ${sdr_info}=  Get SDR Info
48    Should Be Equal  ${sdr_info['sdr_version']}  0x51
49
50    # Get sensor count from "sdr elist all" command output.
51    ${sensor_count}=  Get Sensor Count
52    Should Be Equal As Strings
53    ...  ${sdr_info['record_count']}  ${sensor_count}
54
55    Should Be Equal  ${sdr_info['free_space']}  unspecified
56    Should Not Be Equal  ${sdr_info['most_recent_addition']}  ${EMPTY}
57    Should Not Be Equal  ${sdr_info['most_recent_erase']}  ${EMPTY}
58    Should Be Equal  ${sdr_info['sdr_overflow']}  yes
59    Should Be Equal  ${sdr_info['sdr_repository_update_support']}  unspecified
60    Should Be Equal  ${sdr_info['delete_sdr_supported']}  ${support_delete_sdr}
61    Should Be Equal  ${sdr_info['partial_add_sdr_supported']}  ${support_partial_add}
62    Should Be Equal  ${sdr_info['reserve_sdr_repository_supported']}  ${support_reserve_sdr_repository}
63    Should Be Equal  ${sdr_info['sdr_repository_alloc_info_supported']}  ${support_sdr_repository_alloc_info}
64
65
66Test CPU Core SDR Info At Power On
67    [Documentation]  Verify CPU core SDR info via IPMI and Redfish at power on.
68
69    [Tags]  Test_CPU_Core_SDR_Info_At_Power_On
70
71    Redfish Power On  stack_mode=skip  quiet=1
72    Test SDR Info  core
73
74
75Test DIMM SDR Info At Power On
76    [Documentation]  Verify DIMM SDR info via IPMI and Redfish at power on.
77
78    [Tags]  Test_DIMM_SDR_Info_At_Power_On
79
80    Redfish Power On  stack_mode=skip  quiet=1
81    Test SDR Info  dimm
82
83
84Test GPU SDR Info At Power On
85    [Documentation]  Verify GPU SDR info via IPMI and Redfish at power on.
86
87    [Tags]  Test_GPU_SDR_Info_At_Power_On
88
89    Redfish Power On  stack_mode=skip  quiet=1
90    Test SDR Info  gv100card
91
92
93Test CPU Core SDR Info At Power Off
94    [Documentation]  Verify CPU core SDR info via IPMI and Redfish at power off.
95
96    [Tags]  Test_CPU_Core_SDR_Info_At_Power_Off
97
98    Redfish Hard Power Off  stack_mode=skip  quiet=1
99    Test SDR Info  core
100
101
102Test DIMM SDR Info At Power Off
103    [Documentation]  Verify DIMM SDR info via IPMI and Redfish at power off.
104
105    [Tags]  Test_DIMM_SDR_Info_At_Power_Off
106
107    Redfish Hard Power Off  stack_mode=skip  quiet=1
108    Test SDR Info  dimm
109
110
111Test Auto Reboot SDR Info
112    [Documentation]  Verify auto reboot SDR info via IPMI and Redfish.
113    [Tags]  Test_Auto_Reboot_SDR_Info
114
115
116    ${component_uri_list}=  Get Component URIs  auto_reboot
117    ${component_uri}=  Get From List  ${component_uri_list}  0
118    ${state_rest}=  Read Attribute  ${component_uri}  AutoReboot
119
120    ${state_ipmi}=  Get SDR Presence Via IPMI  auto_reboot${SPACE}
121
122    Run Keyword If  '${state_ipmi}' == 'Disabled'
123    ...    Should Be True  ${state_rest} == ${0}
124    ...  ELSE IF  '${state_ipmi}' == 'State Asserted'
125    ...    Should Be True  ${state_rest} == ${1}
126
127
128Test TPM Enable SDR Info
129    [Documentation]  Verify auto reboot SDR info via IPMI and Redfish.
130    [Tags]  Test_TPM_Enable_SDR_Info
131
132
133    ${component_uri_list}=  Get Component URIs  TPMEnable
134    ${component_uri}=  Get From List  ${component_uri_list}  0
135    ${state_rest}=  Read Attribute  ${component_uri}  TPMEnable
136
137    ${state_ipmi}=  Get SDR Presence Via IPMI  auto_reboot${SPACE}
138
139    Run Keyword If  '${state_ipmi}' == 'Disabled'
140    ...    Should Be True  ${state_rest} == ${0}
141    ...  ELSE IF  '${state_ipmi}' == 'State Asserted'
142    ...    Should Be True  ${state_rest} == ${1}
143
144
145Test Reserve SDR Repository
146    [Documentation]  Verify Reserve SDR Repository IPMI command.
147    [Tags]  Test_Reserve_SDR_Repository
148
149    ${reservation_id}=  Get Reservation ID  convert_lsb_to_msb=True
150
151    # Getting another Reservation ID and verify it is different from previous Reservation ID.
152    ${new_reservation_id}=  Get Reservation ID  convert_lsb_to_msb=True
153
154    Should Not Be Equal  ${reservation_id}  ${new_reservation_id}
155    ...  msg=Getting same reservation ID for second time, reservation ID must be different.
156
157
158Test Get SDR Using Reservation ID
159   [Documentation]  Verify get SDR command using reservation ID obtained from Reserve SDR repository.
160   [Tags]  Test_Get_SDR_Using_Reservation_ID
161
162   ${reservation_id}=  Get Reservation ID  add_prefix=True
163
164   # Get SDR full without using Reservation ID.
165   Run External IPMI Raw Command  ${IPMI_RAW_CMD['SDR']['Get'][0]}
166
167   # Get SDR Partially using Reservation ID.
168   ${get_sdr_raw_cmd}=  Catenate
169   ...  ${IPMI_RAW_CMD['Get SDR']['Get'][1]} ${reservation_id} 0x${record_id} 0x00
170   ...  ${IPMI_RAW_CMD['Get SDR']['Get'][2]}
171   Run External IPMI Raw Command  ${get_sdr_raw_cmd}
172
173   # Get SDR partially without using reservation ID and expect error.
174   Verify Invalid IPMI Command  ${IPMI_RAW_CMD['SDR']['Get'][3]}  0xc5
175
176
177Test Get SDR Using Invalid Reservation ID
178    [Documentation]  Verify get SDR command using invalid reservation ID.
179    [Tags]  Test_Get_SDR_Using_Invalid_Reservation_ID
180
181    # Generate two reservation ID and verify get SDR partial using old reservation ID.
182    ${first_reservation_id}=  Get Reservation ID  add_prefix=True
183    ${second_reservation_id}=  Get Reservation ID  add_prefix=True
184
185    # Creating the raw cmd with First reservation ID.
186    ${get_sdr_raw_cmd}=  Catenate
187    ...  ${IPMI_RAW_CMD['Get SDR']['Get'][1]} ${first_reservation_id} 0x${record_id} 0x00
188    ...  ${IPMI_RAW_CMD['Get SDR']['Get'][2]}
189
190
191Test Reserve SDR Repository After BMC Reboot
192    [Documentation]  Verify reserve SDR repository reservation ID after BMC Reboot.
193    [Tags]  Test_Reserve_SDR_Repository_After_BMC_Reboot
194
195    #  Get Reservation ID before reboot.
196    ${reservation_id_before_reboot}=  Get Reservation ID  add_prefix=True
197
198    # Cold reset BMC
199    IPMI MC Reset Cold (run)
200
201    # Waiting to for sdr to populate.
202    Sleep  10s
203
204    # Create Get SDR Partially command using reservation ID which got before reboot.
205    ${get_sdr_raw_cmd}=  Catenate
206    ...  ${IPMI_RAW_CMD['Get SDR']['Get'][1]} ${reservation_id_before_reboot} 0x${record_id} 0x00
207    ...  ${IPMI_RAW_CMD['Get SDR']['Get'][2]}
208
209    Verify Invalid IPMI Command  ${get_sdr_raw_cmd}  0xc5
210
211    #  Verify get SDR partially with new reservation ID after reboot.
212    ${reservation_id_after_reboot}=  Get Reservation ID  add_prefix=True
213    ${get_sdr_raw_cmd}=  Catenate
214    ...  ${IPMI_RAW_CMD['Get SDR']['Get'][1]} ${reservation_id_after_reboot} 0x${record_id} 0x00
215    ...  ${IPMI_RAW_CMD['Get SDR']['Get'][2]}
216    Run External IPMI Raw Command  ${get_sdr_raw_cmd}
217
218
219*** Keywords ***
220
221Get Reservation ID
222    [Documentation]  Get reservation ID using reserve SDR repository.
223    [Arguments]  ${add_prefix}=False  ${convert_lsb_to_msb}=False
224
225    # Description of argument(s):
226    # add_prefix             If True will prefix "0x" to the reservation ID.
227    #                        e.g. IPMI response for Reservation ID command will be  like 01 00
228    #                        return reservation ID will be "0x01" for above response.
229
230    # convert_lsb_to_msb     If True will convert the reservation ID from LSB first to MSB first.
231    #                        e.g. IPMI response for reservation ID command will be like  01 0a
232    #                        return reservation ID will be "a1" for above response.
233
234    ${reservation_id}=  Run External IPMI Raw Command
235    ...  ${IPMI_RAW_CMD['SDR']['Reserve SDR Repository'][0]}
236
237    ${reservation_id}=  Run Keyword If  ${add_prefix}
238    ...  Add Prefix To String  ${reservation_id}  0x
239    ...  ELSE IF  ${convert_lsb_to_msb}
240    ...  Convert LSB To MSB  ${reservation_id}
241    ...  ELSE
242    ...  Return From Keyword  ${reservation_id}
243
244    [Return]  ${reservation_id}
245
246
247Get Sensor Count
248    [Documentation]  Get sensors count using "sdr elist all" command.
249    # Example of "sdr elist all" command output:
250    # BootProgress     | 03h | ok  | 34.2 |
251    # OperatingSystemS | 05h | ok  | 35.1 |
252    # AttemptsLeft     | 07h | ok  | 34.1 |
253    # occ0             | 08h | ok  | 210.1 | Device Disabled
254    # occ1             | 09h | ok  | 210.2 | Device Disabled
255    # p0_core0_temp    | 11h | ns  |  3.1 | Disabled
256    # cpu0_core0       | 12h | ok  | 208.1 | Presence detected
257    # p0_core1_temp    | 14h | ns  |  3.2 | Disabled
258    # cpu0_core1       | 15h | ok  | 208.2 | Presence detected
259    # p0_core2_temp    | 17h | ns  |  3.3 | Disabled
260    # ..
261    # ..
262    # ..
263    # ..
264    # ..
265    # ..
266    # fan3             | 00h | ns  | 29.4 | Logical FRU @35h
267    # bmc              | 00h | ns  |  6.1 | Logical FRU @3Ch
268    # ethernet         | 00h | ns  |  1.1 | Logical FRU @46h
269
270    ${output}=  Run IPMI Standard Command  sdr elist all
271    ${sensor_list}=  Split String  ${output}  \n
272    ${sensor_count}=  Get Length  ${sensor_list}
273    [Return]  ${sensor_count}
274
275
276Get Component URIs
277    [Documentation]  Get URIs for given component from given URIs
278    ...  and return as a list.
279    [Arguments]  ${component_name}  ${uri_list}=${SYSTEM_URI}
280
281    # A sample result returned for the "core" component:
282    # /xyz/openbmc_project/inventory/system/chassis/motherboard/cpu0/core0
283    # /xyz/openbmc_project/inventory/system/chassis/motherboard/cpu0/core1
284    # /xyz/openbmc_project/inventory/system/chassis/motherboard/cpu0/core10
285    # /xyz/openbmc_project/inventory/system/chassis/motherboard/cpu0/core11
286    # /xyz/openbmc_project/inventory/system/chassis/motherboard/cpu0/core12
287    # (etc.)
288
289    # Description of argument(s):
290    # component_name    Component name (e.g. "core", "dimm", etc.).
291    # uri_list          URI list.
292
293    ${component_uris}=  Get Matches  ${uri_list}
294    ...  regexp=^.*[0-9a-z_].${component_name}\[_0-9a-z]*$
295    ...  case_insensitive=${True}
296    [Return]  ${component_uris}
297
298
299Get SDR Presence Via IPMI
300    [Documentation]  Return presence info from IPMI sensor data record.
301    [Arguments]  ${component_name}
302
303    # Description of argument(s):
304    # component_name    Component name (e.g. "cpu0_core0", "dimm0", etc.).
305
306    # Example of IPMI SDR elist output.
307    # BootProgress     | 03h | ok  | 34.2 |
308    # OperatingSystemS | 05h | ok  | 35.1 | boot completed - device not specified
309    # AttemptsLeft     | 07h | ok  | 34.1 |
310    # occ0             | 08h | ok  | 210.1 | Device Disabled
311    # occ1             | 09h | ok  | 210.2 | Device Disabled
312    # cpu0_core0       | 12h | ok  | 208.1 | Presence detected
313    # cpu0_core1       | 15h | ok  | 208.2 | Disabled
314    # cpu0_core2       | 18h | ok  | 208.3 | Presence detected
315    # dimm0            | A6h | ok  | 32.1 | Presence Detected
316    # dimm1            | A8h | ok  | 32.2 | Presence Detected
317    # dimm2            | AAh | ok  | 32.9 | Presence Detected
318    # gv100card0       | C5h | ok  | 216.1 | 0 unspecified
319    # gv100card1       | C8h | ok  | 216.2 | 0 unspecified
320    # TPMEnable        | D7h | ok  |  3.3 | State Asserted
321    # auto_reboot      | DAh | ok  | 33.2 | State Asserted
322    # volatile         | DBh | ok  | 33.1 | State Deasserted
323
324    ${sdr_elist_output}=  Run IPMI Standard Command  sdr elist
325    ${sdr_component_line}=
326    ...  Get Lines Containing String  ${sdr_elist_output}  ${component_name}
327    ...  case-insensitive
328
329    ${presence_ipmi}=  Fetch From Right  ${sdr_component_line}  |
330    ${presence_ipmi}=  Strip String  ${presence_ipmi}
331    [Return]  ${presence_ipmi}
332
333
334Verify SDR
335    [Documentation]  Verify IPMI sensor data record for given component
336    ...  with Redfish.
337    [Arguments]  ${component_name}
338
339    # Description of argument(s):
340    # component_name    Component name (e.g. "cpu0/core0", "dimm0", etc.).
341
342    ${presence_rest}=  Read Attribute
343    ...  ${HOST_INVENTORY_URI}system/chassis/motherboard/${component_name}
344    ...  Present
345    ${functional_rest}=  Read Attribute
346    ...  ${HOST_INVENTORY_URI}system/chassis/motherboard/${component_name}
347    ...  Functional
348
349    # Replace "/" with "_" if there is any "/" in component name.
350    # e.g. cpu0/core0 to cpu0_core0
351    ${component_name}=  Replace String  ${component_name}  /  _
352    ${presence_ipmi}=  Get SDR Presence Via IPMI  ${component_name}${SPACE}
353
354    Run Keyword If  '${presence_ipmi}' == 'Disabled' or '${presence_ipmi}' == ''
355    ...    Should Be True  ${presence_rest} == ${0} and ${functional_rest} == ${0}
356    ...  ELSE IF  '${presence_ipmi}' == 'Presence Detected' or '${presence_ipmi}' == 'Presence detected'
357    ...    Should Be True  ${presence_rest} == ${1} and ${functional_rest} == ${1}
358    ...  ELSE IF  '${presence_ipmi}' == 'State Asserted'
359    ...    Should Be True  ${presence_rest} == ${1} and ${functional_rest} == ${1}
360    ...  ELSE IF  '${presence_ipmi}' == 'State Deasserted'
361    ...    Should Be True  ${presence_rest} == ${1} and ${functional_rest} == ${0}
362    ...  ELSE  Fail  msg=Invalid Presence${presence_ipmi}
363
364
365Test SDR Info
366    [Documentation]  Test SDR info for given component.
367    [Arguments]  ${component_name}
368
369    # Description of argument(s):
370    # component_name    Component name (e.g. "core", "dimm", etc.).
371
372    ${component_uri_list}=  Get Component URIs  ${component_name}
373
374    FOR  ${uri}  IN  @{component_uri_list}
375      ${component_name}=  Fetch From Right  ${uri}  motherboard/
376      Log To Console  ${component_name}
377      Verify SDR  ${component_name}
378    END
379
380Fetch IPMI Command Support Status
381    [Documentation]  Return yes if IPMI command is supported.
382    [Arguments]  ${ipmi_cmd}
383
384    # Description of argument(s):
385    # ipmi_cmd    IPMI command.
386
387    ${resp}=  Run External IPMI Raw Command  ${ipmi_cmd}  fail_on_err=0
388    ${resp_code_match}=  Get Regexp Matches  ${resp}  rsp=0xc1
389
390    ${cmd_support}=  Set Variable If  ${resp_code_match} != []  no  yes
391
392    [Return]  ${cmd_support}
393
394
395Get SDR Record ID
396    [Documentation]  Fetch one record ID from SDR elist IPMI cmd response.
397
398    ${resp}=  Run External IPMI Standard Command  sdr elist
399    ${record_id}=  Get Regexp Matches  ${resp}  \\|\\s+([0-9]+)h\\s+\\|  1
400
401    [Return]  ${record_id[0]}
402
403
404Suite Setup Execution
405    [Documentation]  Do the initial suite setup.
406
407    Redfish.Login
408    Redfish Power On  stack_mode=skip  quiet=1
409
410    ${record_id}=  Get SDR Record ID
411    Set Suite Variable  ${record_id}
412
413    # If REST is supported, then the uri_list will be returned.
414    ${resp}=  OpenBMC Get Request  ${OPENBMC_BASE_URI}
415    IF  '${resp.status_code}' == '${HTTP_OK}'
416      ${uri_list}=  Read Properties  ${OPENBMC_BASE_URI}list
417      Set Suite Variable  ${SYSTEM_URI}  ${uri_list}
418      Log  ${uri_list}
419    END
420
421
422Test Teardown Execution
423    [Documentation]  Do the post test teardown.
424
425    FFDC On Test Case Fail
426