1b1b4d261SWilliam A. Kennington IIIdescription: > 2b1b4d261SWilliam A. Kennington III Implement this to add Resource dump management. 3b1b4d261SWilliam A. Kennington III 4a1347418SPatrick Williams The resource dumps are special types of dumps generated by host hypervisor. 5a1347418SPatrick Williams The dump is generated based on the resource selector. Hyperviosr needs a 6a1347418SPatrick Williams password to validate the request before creating the dump. 7b1b4d261SWilliam A. Kennington III 8b1b4d261SWilliam A. Kennington IIIproperties: 9b1b4d261SWilliam A. Kennington III - name: SourceDumpId 10b1b4d261SWilliam A. Kennington III type: uint32 11b1b4d261SWilliam A. Kennington III description: > 12a1347418SPatrick Williams The dump id provided by the source of the dump. There are dumps which 13a1347418SPatrick Williams get generated outside the BMC, like a resource dump which gets 14a1347418SPatrick Williams generated and stored in the host memory. All dumps will have a unique 15a1347418SPatrick Williams id but when communicating to the source of the dump the SourceDumpId 16a1347418SPatrick Williams will be used. 17b1b4d261SWilliam A. Kennington III - name: VSPString 18b1b4d261SWilliam A. Kennington III type: string 19b1b4d261SWilliam A. Kennington III description: > 20b1b4d261SWilliam A. Kennington III The resource selector for generating the dump. 21b3563c1eSDhruvaraj Subhashchandran - name: UserChallenge 22b1b4d261SWilliam A. Kennington III type: string 23b1b4d261SWilliam A. Kennington III description: > 24b3563c1eSDhruvaraj Subhashchandran On some host implementations a user-challenge need to be provided by 25b3563c1eSDhruvaraj Subhashchandran the user and it flows through BMC and up to the host as a part of the 26b3563c1eSDhruvaraj Subhashchandran dump request. Non-disruptive dumps consume significant host resources 27b3563c1eSDhruvaraj Subhashchandran and involve the collection of host memory data. To safeguard these 28b3563c1eSDhruvaraj Subhashchandran operations and ensure they are initiated only by authorized personnel, 29b3563c1eSDhruvaraj Subhashchandran the provided passphrase is employed. In some systems, an Access 30b3563c1eSDhruvaraj Subhashchandran Control List (ACL) file, provided through the Platform Level Data 31b3563c1eSDhruvaraj Subhashchandran Model (PLDM), is used. The host validates the provided user-challenge 32b3563c1eSDhruvaraj Subhashchandran against this ACL. If the user-challenge doesn't match any entry in the 33b3563c1eSDhruvaraj Subhashchandran ACL, the host will reject the dump request. This field is needed so 34b3563c1eSDhruvaraj Subhashchandran the host can check that only authorized users are allowed to perform 35b3563c1eSDhruvaraj Subhashchandran certain dump operations. 3627afd1f2SDhruvaraj Subhashchandran - name: Token 3727afd1f2SDhruvaraj Subhashchandran type: uint32 3827afd1f2SDhruvaraj Subhashchandran description: > 3927afd1f2SDhruvaraj Subhashchandran A token exchanged with an external firmware subsystem when creating a 4027afd1f2SDhruvaraj Subhashchandran dump outside of the BMC. This token can be used to identify the dump 4127afd1f2SDhruvaraj Subhashchandran entry once the collection is completed. 42980fb7b5SDhruvaraj Subhashchandran - name: DumpRequestStatus 43980fb7b5SDhruvaraj Subhashchandran type: enum[self.HostResponse] 44980fb7b5SDhruvaraj Subhashchandran description: > 45980fb7b5SDhruvaraj Subhashchandran The host will send a response code for each request to create a 46980fb7b5SDhruvaraj Subhashchandran resource dump to indicate whether the request is successful or there 47980fb7b5SDhruvaraj Subhashchandran is an error. 48*cb82dfb6SDhruvaraj Subhashchandran default: Unknown 49980fb7b5SDhruvaraj Subhashchandran 50980fb7b5SDhruvaraj Subhashchandranenumerations: 51980fb7b5SDhruvaraj Subhashchandran - name: HostResponse 52980fb7b5SDhruvaraj Subhashchandran description: > 53980fb7b5SDhruvaraj Subhashchandran These are the possible response codes from the host after sending a 54980fb7b5SDhruvaraj Subhashchandran resource dump request. 55980fb7b5SDhruvaraj Subhashchandran values: 56*cb82dfb6SDhruvaraj Subhashchandran - name: Unknown 57*cb82dfb6SDhruvaraj Subhashchandran description: > 58*cb82dfb6SDhruvaraj Subhashchandran The status of the request is unknown, or not initialized 59980fb7b5SDhruvaraj Subhashchandran - name: Requested 60980fb7b5SDhruvaraj Subhashchandran description: > 61980fb7b5SDhruvaraj Subhashchandran Requested for resource dump and awaiting the host response 62980fb7b5SDhruvaraj Subhashchandran - name: Success 63980fb7b5SDhruvaraj Subhashchandran description: > 64980fb7b5SDhruvaraj Subhashchandran Resource dump parameters and ACF data are successfully validated 65*cb82dfb6SDhruvaraj Subhashchandran - name: ACLFileInvalid 66980fb7b5SDhruvaraj Subhashchandran description: > 67*cb82dfb6SDhruvaraj Subhashchandran Invalid Access Control List file 68980fb7b5SDhruvaraj Subhashchandran - name: UserChallengeInvalid 69980fb7b5SDhruvaraj Subhashchandran description: > 70980fb7b5SDhruvaraj Subhashchandran User challenge provided is not valid 71980fb7b5SDhruvaraj Subhashchandran - name: PermissionDenied 72980fb7b5SDhruvaraj Subhashchandran descVSPtion: > 73980fb7b5SDhruvaraj Subhashchandran Caller does not have enough privileges to execute the requested 74*cb82dfb6SDhruvaraj Subhashchandran resource selector(VSP string) 75980fb7b5SDhruvaraj Subhashchandran - name: ResourceSelectorInvalid 76980fb7b5SDhruvaraj Subhashchandran description: > 77980fb7b5SDhruvaraj Subhashchandran Resource selector(VSP String) provided is not valid 78