The mlxtokengenerator tool allows the user to create Token XML files automatically. The Token XML file will be filled with all the required data. The generated Token XML file is ready to be used for sign and installation commands.
mlxtokengenerator Synopsis
# mlxtokengenerator [Options] <commands>
where:
|
-d|--dev <device> |
Performs operation for a specified mst device |
|
-t|–-device_type <Switch/HCA/LinkX> |
Mst device type |
|
-k|--token_type <CS/DBG/CRCS/CRDT/RMCS/RMDT> |
Token type |
|
-o|--output_file <Path> |
Path to output Token XML file |
|
-f|--debug_fw <Path> |
Path to debug fw file |
|
-n|--nested_token |
Get nested token for Retimer |
|
-e|--nested_debug_fw |
Path to debug fw file for Retimer nested token |
|
-p|--tokens_dir <Path> |
Path to a directory of tokens for aggregation |
|
-v|--version |
Displays version info |
|
-h|--help |
Displays help message |
|
-s|--i2c_secondary <i2c_secondary> |
I2C secondary address |
|
--b|--blob |
Path to challenge blob file (relevant for CRCS/CRDT token types) |
|
--debug_fw_dir <path> |
Path to a directory with debug firmware files |
|
--output_zip <path> |
Path to zip output file |
|
--output_dir |
Path to output directory |
Examples:
To create a CS token:
# mlxtokengenerator -d /dev/mst/mt4123_pciconf0 -k CS -t HCA -o /tmp/cs_token.xml generate_token
To create a DBG token:
# mlxtokengenerator -d /dev/mst/mt4123_pciconf0 -k DBG -t HCA -f /tmp/dbg_fw.bin -o /tmp/dbg_token.xml generate_token
To create a CRDT token with nested Retimer:
# mlxtokengenerator -d mt54004_pciconf0_cable_1 -k CRDT -t LinkX -debug_fw /tmp/dbg_fw.bin --nested_debug_fw /tmp/retimer_dbg_fw.bin --nested_token -o /tmp/dbg_token.xml generate_token
To create challenge based tokens with blob option:
# mlxtokengenerator -b <bllob_file> -k CRCS -t HCA -o <out.xml> generate_token
Token Generation Process
The token generation process consists of three main stages:
-
Generating a token XML.
-
Signing the token on a dedicated signing server.
-
Applying the signed token to the device.
The mlxtokengenerator tool will streamline this flow by enabling batch token generation either into a directory or a zip file. It operates on all applicable MST devices discoverable from the host, while filtering by device type (HCA or Switch only) and token type (CRCS or CRDT only). If the specified output directory already exists, the generated files are simply added to it.
Generate in a directory:
mlxtokengenerator -t <Switch/HCA> -k <CRCS/CRDT> -o <directory path> auto_generate_tokens
Generate in a zip file:
mlxtokengenerator -t <Switch/HCA> -k <CRCS/CRDT> --zip_output -o <zip path> auto_generate_tokens
Generate CRDT tokens:
mlxtokengenerator -t <Switch/HCA> -k CRDT -o <directory path> --debug_fw_dir <path> auto_generate_tokens
Once tokens are signed and converted to binary, the mlxconfig tool supports automatically applying them from a given directory or a zip file, attempting to match and apply the appropriate token to all discoverable MST devices on the host.
Apply tokens automatically:
mlxconfig -t <Switch/HCA> auto_apply <zip/directory>
Last updated: