1*** Settings ***
2
3Documentation    Module to test PLDM platform commands.
4
5Library           ../lib/pldm_utils.py
6Variables         ../data/pldm_variables.py
7Resource          ../lib/openbmc_ffdc.robot
8Resource          ../lib/bmc_redfish_resource.robot
9Resource          ../lib/boot_utils.robot
10
11Test Setup        Printn
12Test Teardown     FFDC On Test Case Fail
13Suite Teardown    Pldmtool Platform Suite Cleanup
14
15Force Tags        Pldm_Platform
16
17*** Test Cases ***
18Verify GetPDR
19    [Documentation]  Verify GetPDR (Platform Descpritor Record) response message.
20    [Tags]  Verify_GetPDR
21
22    ${record_handle}=  Set Variable  ${1}
23    # Note: Record handle count is unknown and it is dynamic in nature.
24    #       Assuming there are 100 record handle.
25    FOR   ${i}  IN RANGE  100
26       ${next_record_handle}=  Run Keyword  Verify GetPDR For Record Handle  ${record_handle}
27       Exit For Loop If  ${next_record_handle} == 0
28       ${record_handle}=  Set Variable  ${next_record_handle}
29    END
30
31Verify SetStateEffecterStates
32    [Documentation]  Verify set state effecter states response message.
33    [Tags]  Verify_SetStateEffecterStates
34    [Template]  Verify SetStateEffecterStates For Effecter States
35
36    # EffecterHandle  Count  EffecterStates (effecterID effecterState)
37
38    '1'              '1'    '1 1'  # (effecterState -> 1 -> 'Boot Not Active')
39    '1'              '1'    '1 2'  # (effecterState -> 2 -> 'Boot Completed')
40    '2'              '1'    '1 9'  # (effecterState -> 9 -> 'System Power is in soft off mode')
41    '3'              '1'    '1 6'  # (effecterState -> 6 -> 'Graceful Restart Requested')
42
43*** Keywords ***
44
45Verify GetPDR For Record Handle
46    [Documentation]  Verify GetPDR (Platform Descpritor Record) for given input
47    ...              record handle and return next record handle.
48    [Arguments]  ${record_handle}
49
50    # Description of argument(s):
51    # ${record_handle}  Record handle.
52    #                   e.g. '1' is record handle 'Boot Progress' (196).
53    #                        '2' is record handle 'System Power State (260)'.
54    #                        '3' is record handle 'Software Termination Status (129)'.
55
56    # pldm_output:
57    # [responseCount]:                               29
58    # [recordHandle]:                                1
59    # [PDRHeaderVersion]:                            1
60    # [PDRType]:                                     11
61    # [recordChangeNumber]:                          0
62    # [dataLength]:                                  19
63    # [PLDMTerminusHandle]:                          0
64    # [effecterID]:                                  1
65    # [entityType]:                                  33
66    # [entityInstanceNumber]:                        0
67    # [containerID]:                                 0
68    # [effecterSemanticID]:                          0
69    # [effecterInit]:                                0
70    # [effecterDescriptionPDR]:                      false
71    # [compositeEffecterCount]:                      1
72    # [stateSetID]:                                  196
73    # [possibleStatesSize]:                          1
74    # [possibleStates]:                              6
75
76    ${pldm_cmd}=  Evaluate  $CMD_GETPDR % ${record_handle}
77    ${pldm_output}=  Pldmtool  ${pldm_cmd}
78    Rprint Vars  pldm_output
79
80    Run Keyword If  '${pldm_output['PDRType']}' == '${PLDM_PDR_TYPES['PLDM_STATE_EFFECTER_PDR']}'
81    ...  Valid Dict  pldm_output  valid_values=${RESPONSE_DICT_GETPDR_SETSTATEEFFECTER}
82
83    ...  ELSE IF  '${pldm_output['PDRType']}' == '${PLDM_PDR_TYPES['PLDM_PDR_FRU_RECORD_SET']}'
84    ...  Valid Dict  pldm_output  valid_values=${RESPONSE_DICT_GETPDR_FRURECORDSETIDENTIFIER}
85
86    ...  ELSE IF  '${pldm_output['PDRType']}' == '${PLDM_PDR_TYPES['PLDM_PDR_ENTITY_ASSOCIATION']}'
87    ...  Log To Console  "Found PDR Type - PLDM_ENTITY_ASSOCIATION_PDR"
88
89    ...  ELSE IF  '${pldm_output['PDRType']}' == '${PLDM_PDR_TYPES['PLDM_STATE_SENSOR_PDR']}'
90    ...  Valid Dict  pldm_output  valid_values=${RESPONSE_DICT_GETPDR_STATESENSORPDR}
91
92    ...  ELSE IF  '${pldm_output['PDRType']}' == '${PLDM_PDR_TYPES['PLDM_NUMERIC_EFFECTER_PDR']}'
93    ...  Valid Dict  pldm_output  valid_values=${RESPONSE_DICT_GETPDR_NUMERICEFFECTERPDR}
94
95    ...  ELSE IF  '${pldm_output['PDRType']}' == '${PLDM_PDR_TYPES['PLDM_TERMINUS_LOCATOR_PDR']}'
96    ...  Valid Dict  pldm_output  valid_values=${RESPONSE_DICT_GETPDR_TERMINUSLOCATORPDR}
97
98    ...  ELSE IF  '${pldm_output['PDRType']}' == '${PLDM_PDR_TYPES['PLDM_COMPACT_NUMERIC_SENSOR_PDR']}'
99    ...  Log To Console  "Found PDR Type - PLDM_COMPACT_NUMERIC_SENSOR_PDR'
100
101    ...  ELSE  Fail  msg="Unknown PDR Type is received"
102
103    Should be equal as strings  ${pldm_output['recordHandle']}  ${record_handle}
104    [Return]  ${pldm_output['nextRecordHandle']}
105
106Verify SetStateEffecterStates For Effecter States
107    [Documentation]  Verify set state effecter states for given input effecter states.
108    [Arguments]  ${effecter_handle}  ${count}  ${effecter_states}
109
110    # Description of argument(s):
111    # ${effecter_handle}   A handle that is used to identify and access the effecter (e.g. '1').
112    #                      e.g. '1' is effecter handle 'Boot Progress'.
113    #                           '2' is effecter handle 'System Power State'.
114    # ${count}             The number of individual sets of effecter information (e.g. '1').
115    # ${effecter_states}   (effecterID effecterState).
116    #                      e.g. '1 1'.
117
118    # Example output:
119    # {
120    #     "Response": "SUCCESS"
121    # }
122
123    ${pldm_cmd}=  Evaluate  $CMD_SETSTATEEFFECTERSTATES % (${effecter_handle}, ${count}, ${effecter_states})
124    ${pldm_output}=  Pldmtool  ${pldm_cmd}
125    Rprint Vars  pldm_output
126    Valid Value  pldm_output['Response']  ['SUCCESS']
127
128Pldmtool Platform Suite Cleanup
129    [Documentation]    Reset BMC at suite cleanup.
130
131    Redfish.Login
132    Redfish OBMC Reboot (off)
133