pldm/pldmtool/README.md

1 # Overview of pldmtool
3 pldmtool is a client tool that acts as a PLDM requester which runs on the BMC.
4 pldmtool sends the request message and displays the response message also
8 pldmtool supports the subcommands for PLDM types such as base, platform, bios,
21 Source files in pldmtool repository are named with respect to the PLDM type.
29 pldmtool commands for corresponding PLDM type is constructed with the help of
34 Given a PLDM command "foo" of PLDM type "base" the pldmtool should consume
42 If PLDM commands are not yet supported in the pldmtool repository user can
43 directly send the request message with the help of **pldmtool raw -d \<data\>**
48 User can see the pldmtool supported PLDM types in the usage output available
52 $ pldmtool -h
54 Usage: pldmtool [OPTIONS] SUBCOMMAND
69 pldmtool command prompt expects a PLDM type to display the list of supported
74 pldmtool <pldmType> -h
80 $ pldmtool base -h
83 Usage: pldmtool base [OPTIONS] SUBCOMMAND
101 pldmtool <pldmType> <commandName> -h
107 $ pldmtool base GetPLDMTypes -h
110 Usage: pldmtool base GetPLDMTypes [OPTIONS]
118 ## pldmtool raw command usage
120 pldmtool raw command option accepts request message in the hexadecimal bytes and
124 $ pldmtool raw -h
126 Usage: pldmtool raw [OPTIONS]
135 **pldmtool request message format:**
138 pldmtool raw --data 0x80 <pldmType> <cmdType> <payloadReq>
144 **pldmtool response message format:**
156 $ pldmtool raw -d 0x80 0x00 0x04 0x00 0x00
165 ## pldmtool output format
167 In the current pldmtool implementation response message from pldmtool is parsed
173 $ pldmtool base GetPLDMTypes
198 ## Understanding pldmtool output error scenario
200 When the pldmtool receives the wrong response for the request sent it errors out
212 $ pldmtool platform getpdr -d 17
216 ## pldmtool with mctp_eid option
219 end point and by default pldmtool consider mctp_eid value as **'08'**.
223 pldmtool <pldmType> <cmdType> -m <mctpId>
225 # pldmtool raw command format
226 pldmtool raw -d 0x80 <pldmType> <cmdType> <payloadReq> -m <mctpId>
233 pldmtool base GetPLDMTypes -m 8
235 # pldmtool raw command
236 pldmtool raw -d 0x80 0x00 0x04 0x00 0x00 -m 0x08
240 ## pldmtool verbosity
242 By default verbose flag is disabled on the pldmtool.
249 pldmtool base GetPLDMTypes -v