Switchtec-user v4.2 Release

About this Release

This release supports the following Switchtec devices and releases:

Generation	Variant	Release
Gen5	PFX/PSX	RevB Beta (F/W version: 07.06.0.045)
Gen4	PFX/PSX	MR5 Patch3 (F/W version: 03.90.0.06C)

Note:

• The Switchtec-user was tested with Switchtec-kernel driver on Ubuntu 20.04.2 LTS with kernel 5.15.0-91-generic.

What is New Since v4.0 Release?

This release introduces the following new features, changes and fixes

Andrew Maier (1):
      cli/progress: Fix int overflow with progress bar

Davide Cavalca (1):
      cli: Fix format security warning

Kelvin Cao (31):
      Revert "Revert "Add unknown type in enum switchtec_fw_part_type_gen4""
      lib: Add Gen5 revB support in switchtec_fw_part_summary
      cli: Fix 'fw-info' display indentation
      cli: Return zero on success for 'fw-read' command
      lib: Add Gen 5 support in switchtec_get_device_id_bl2
      cli: Fix help message for 'fw_read' command
      lib: Return error on log def reading failure
      lib: Update header for parsed log file
      cli: Add '--no-progress, -p' option to mfg fw-transfer
      lib: Return -1 on MRPC failure in switchtec_status
      cli: Display I2C device option only in help
      lib: Fix SPI clock rate parsing issue
      cli: Fix invalid SPI Clock Rate issue for 'mfg config_set'
      cli: Apply ristriction on GAS access
      cli: Add boot phase info in help messages for some main menu commands
      cli: Add help message to 'mfg config-set' command
      build: Fix ncurses static linking issue
      lib: Fix bug in gasop_noretry_cmds_count calculation
      lib: Update Gen5 device IDs per revB changes
      installer: Use Inno Setup 6 to build installer
      lib: Use local PAX ID for Gen/Variant setup
      lib: Add Gen5 MRPC IDs into gasop_noretry_cmds
      cli: Move command debug_unlock_token to the front of debug-unlock
      cli: Add token file generation for secure unlock version update
      Update version to 4.2
      Reject duplicate KMSK key programming
      cli: Fix an 'events -r' issue
      cli: Add option [-s | --show-settings-only] to mfg config-set
      cli: support temp command for Gen5
      lib: Add API switchtec_die_temps for multiple die sensor readings
      cli: Add verbose mode for 'temp' command

Paul Yan (28):
      Introduce new GEN5 security config read functions
      Add 'debug mode valid' flag
      Change max number of KMSK from 4 to 10
      Add attestation settings in Gen5 devices
      Add extended OTP valid flags for Gen5 devices
      Use new MRPC command IDs for Gen5 devices
      Use new command to read security version from Gen5 devices
      Use new MRPC command to set KMSK entry on Gen5 device
      Use new MRPC command to set security state for Gen5 device
      Use new MRPC command to read mailbox log from Gen5 device
      Use new MRPC command to resume booting on Gen5 device
      Use new MRPC command to unlock debug port on Gen5 device
      Introduce security setting function for Gen5 device
      Add function to read Gen5 security setting file
      Print attestation settings in security settings display
      Add function to read UDS file
      Add option to specify UDS file in 'config-set'
      Use new MRPC command to read active image index on Gen5
      Add RIOT image active index to image list print
      Use new MRPC command to set active image index on Gen5
      Add '-r' option to 'image-select' command
      Use new firmware update MRPC command for Gen5 device
      Add Gen5 firmware image header type support
      Add support for Gen5 images in switchtec image types
      Introduce function to get Gen5 secure versions
      Add RIOT secure version display in 'mfg info' output
      Fix 'mfg info' command under BL2 boot phase
      lib: Fix switchtec_security_config_set() fail issue

c52484 (1):
      cli: Fix 'mfg info' display indentation

Limitations

• GAS dump
  Switchtec-user command gas dump might impact system performance or cause instability

• FABRIC commands
  fabric submenu commands are not yet supported on Gen5 device

• DIAGNOSTIC commands
  diag submenu command are for Gen4 device only

Switchtec-user v4.0 Release

About this Release

This release supports the following Switchtec devices and releases:

Generation	Variant	Release
Gen5	PFX/PSX	RevA FCA (F/W version: 06.01.0.01f), RevA Alpha (F/W version: 06.03.0.031)
Gen4	PFX/PSX	MR-1 (F/W version: 03.60.0.049), MR-2 (F/W version: 03.70.0.04f), MR-3 (F/W version: 03.80.0.056), MR-4 (F/W version: 03.90.0.05b)
Gen4	PAX	MR-1 (F/W version: 04.60.0.449), MR-2 (F/W version: 04.70.0.450), MR-3 (F/W version: 04.80.0.456), MR-4 (F/W version: 04.90.0.45b)

What is New Since v3.1 Release?

This release introduces the following new features, changes and fixes

Anita Zhang (2):
      lib: Correct iterator variable used
      lib: Correct and use helper to determine max number of ports

Cliff Pajaro (1):
      Fix BDF search by matching a single character for function

Kelvin Cao (6):
      lib: Fix boot phase setup in set_gen_variant()
      lib: Introduce function switchtec_get_device_id_bl2
      cli: Fix command info for variant and device ID
      lib: Make helper phase_id_to_string global
      cli: Fix command info for version report in BL1
      cli: Report 'N/A' in command info for N/A information

Logan Gunthorpe (2):
      lib: Fallback on EBADMSG error code
      lib/platform/linux: Ensure entire switchtec_event_summary struct is set

Michael Piszczek (1):
      Fixed invalid pointer in cli list when no devices found

Paul Yan (3):
      Revert "Add fw redundancy flag setup feature"
      Revert "Add unknown type in enum switchtec_fw_part_type_gen4"
      Revert "Display fw partition redundancy flag in fw-info"

William A. Kennington III (1):
      build: Don't strip binary by default

c52484 (5):
      lib: add 32 GT/s link rate for Gen5 device
      lib: add Gen5 data rate definition
      Update version to 4.0
      Add subcommand-level 'no retry' in gasop_cmd function
      Add reading status retries in i2c_gas_write_no_retry function

Limitations

• GAS dump
  Switchtec-user command gas dump might impact system performance or cause instability

• FABRIC commands
  fabric submenu commands are not yet supported on Gen5 device

• DIAGNOSTIC commands
  diag submenu command are for Gen4 device only

Switchtec-user v3.1 Release

About this Release

This release supports the following Switchtec devices and releases:

Generation	Variant	Release
Gen5	PFX/PSX	FCA (F/W version: 06.01.0.01f)
Gen4	PFX/PSX	MR-1 (F/W version: 03.60.0.049), MR-2 (F/W version: 03.70.0.04f), MR-3 (F/W version: 03.80.0.056), MR-4 (F/W version: 03.90.0.05b)
Gen4	PAX	MR-1 (F/W version: 04.60.0.449), MR-2 (F/W version: 04.70.0.450), MR-3 (F/W version: 04.80.0.456), MR-4 (F/W version: 04.90.0.45b)

What is New Since v3.0 Release?

This release introduces the following new features, changes and fixes

Features and Changes

• diag submenu: added the following new diagnostic commands
          eye: display eye diagram of a port
          crosshair: measure eye cross hair of a port
          list-mrpc: list permissible MRPC commands
          loopback: enable loop back test on specified ports
          pattern: enable pattern generation and monitor
          port-eq-txcoeff: dump port equalization coefficients
          port-eq-txfslf: dump FS/LF output data
          port-eq-txtable: dump far end port equalization table
          rcvr-extended: dump RX mode and DTCLK
          rcvr-obj: dump analog RX coefficients/adaptation objects
          refclk: enable or disable the output reference clock of a stack
          ltssm-log: display LTSSM log

• log-dump: added Event ID field in text log files

• fw-read: changed default output file name to image.fwimg for Gen4 and later devices

Fixes

• status: fixed segmentation fault found on ARM platform only
• log-parse: fixed missing Firmware/SDK version number when parsing mailbox log files

Limitations

• GAS dump
  Switchtec-user command gas dump might impact system performance or cause instability

• FABRIC commands
  fabric submenu commands are not yet supported on Gen5 device

• DIAGNOSTIC commands
  diag submenu command are for Gen4 device only

Switchtec-user v3.0 Release

About this Release

This release supports the following Switchtec devices and releases:

Generation	Variant	Release
Gen5	PFX/PSX	FCA (F/W version: 06.01.0.01f)
Gen4	PFX/PSX	MR-1 (F/W version: 03.60.0.049), MR-2 (F/W version: 03.70.0.04f), MR-3 (F/W version: 03.80.0.056), MR-4 (F/W version: 04.90.0.05b)
Gen4	PAX	MR-1 (F/W version: 04.60.0.449), MR-2 (F/W version: 04.70.0.450), MR-3 (F/W version: 04.80.0.456), MR-4 (F/W version: 04.90.0.45b)

What is New Since v2.6 Release?

This release introduces the following new features, changes and fixes

Features and Changes

• Added switchtec_list_free function
• Added support for Gen5 device
• Added firmware image generation checking before upgrading firmware to the device
• Changed SPI clock rate field in security settings from enum to float
• Added security setting file generation checking before writing OTP settings to the device
• Merged OTP state structure into security state and delete redundant switchtec_security_cfg_state_ext structure
• Added device hardware revision information to info command output
• Deleted boot phase information from mfg ping command output
• Added API function to dump log definition file
• Added -f option in log-dump to allow dumping parsed RAM and flash log
• Added firmware and SDK version numbers in RAM and flash log files
• Added version checking in log-parse to ensure the input log file and log definition file have matching versions
• Added SEEPROM information in fw-info command output

Fixes

• Fixed fw-read segmentation fault found when flash is empty
• Fixed log-parse segmentation fault found when module name is empty
• Fixed calculation of timestamp in log files
• Fixed mailbox log parsing issues

Limitations

• GAS dump
  Switchtec-user command gas dump might impact system performance or cause instability

• FABRIC commands
  fabric submenu commands are not yet supported on Gen5 devices

• DIAGNOSTIC commands
  diag submenu command are experimental and are not fully supported on all devices

Switchtec-user v2.6 Release for Switchtec Gen4 PFX/PSX/PAX MR3

About this Release

This release supports the following Switchtec devices and releases:

Generation	Variant	Release
Gen4	PSX/PFX	Beta (F/W version: 03.50.0.03e), MR-1 (F/W version: 03.60.0.049), MR-2 (F/W version: 03.70.0.04f), MR-3 (F/W version: 03.80.0.056)
Gen4	PAX	Beta (F/W version: 04.50.0.440), MR-1 (F/W version: 04.60.0.449), MR-2 (F/W version: 04.70.0.450), MR-3 (F/W version: 04.80.0.456)

What is New?

This release introduces the following new features, changes and fixes.

Features and Changes

• Added support for Gen4 automotive devices
• Improved error handling and provided more accurate error messages for the fw-update command

Fixes

N/A

Limitations

• GAS dump
  Switchtec-user command gas dump might impact system performance or cause instability

Switchtec-user Early FCA Release for Switchtec Gen5 PFX/PSX

About this Release

This release supports the following Switchtec devices and releases:

Generation	Variant	Release
Gen5	PFX/PSX	Early FCA (F/W version: 06.01.0.00c)

What is New?

This release introduces the following new features, changes and fixes.

Features and Changes

• Add support for Gen5 device
• Add support for Gen5 device firmware images
• Add firmware image generation checking before upgrading firmware to the device

Fixes

N/A

Limitations

• GAS dump
  Switchtec-user command 'gas dump' may impact system performance or cause instability

• MFG commands
  Only the following mfg submenu commands are supported:

  • ping
  • fw-transfer
  • fw-execute
  • boot-resume
  • image-list
  • image-select
  • mailbox

• FABRIC commands
  fabric submenu commands are not yet supported

Switchtec-user v2.5 release for Switchtec Gen4 PFX/PSX/PAX MR-2

About this Release

This release supports the following Switchtec devices and releases.

Generation	Variant	Release
Gen4	PSX/PFX	Beta (F/W version: 03.50.0.03e), MR-1 (F/W version: 03.60.0.049), MR-2 (F/W version: 03.70.0.04f)
Gen4	PAX	Beta (F/W version: 04.50.0.440), MR-1 (F/W version: 04.60.0.449), MR-2 (F/W version: 04.70.0.450)

What is New?

This release introduces the following new features, changes and fixes.

Features and Changes

• Cli: Add option to 'fw-update' command for not printing progress bar
• Cli: Add option '-v | --verbose' to command 'mfg info'
• Lib: Add API switchtec_nvme_admin_passthru()

Fixes

This release includes the following fixes.

• Fix a PCIe address parsing issue 339e9a5
• Fix an I2C adapter address parsing issue da0c1e9
• Fix linux PCIe Bus-Dev-Func display issue 44f11d6
• Skip checking device secure version if update image is unsigned b925802

Limitations

• GAS dump
  Switchtec-user command 'gas dump' may respond very slowly and cause the delay of subsequent command
  responses.
  Workaround: Use command 'gas read' to read a GAS location, instead of dumping all of the GAS locations.

Switchtec-user v2.4 release for Switchtec Gen4 PFX/PSX/PAX MR-1

v2.4-rc3

Tag for v2.4 build on Aug/14/2020

Switchtec-user v2.0 release for Trident RevB FCA

In this release

This is the release of switchtec-user v2.0 utility for Trident RevB FCA, which includes the following new features.

• Add New Commands to support secure boot and firmware recovery
  * recovery ping - Ping firmware and get current boot phase
  * recovery info - Display security settings (BL1 and Main Firmware only)
  * recovery mailbox - Retrieve mailbox logs
  * recovery image-list - Display active image list (BL1 only)
  * recovery image-select - Select active image index (BL1 only)
  * recovery fw-transfer - Transfer a firmware image to device (BL1 only)
  * recovery fw-execute - Execute the firmware image tranferred (BL1 only)
  * recovery config-set - Set the device security settings (BL1 and Main Firmware only)
  * recovery kmsk-entry-add - Add a KMSK entry (BL1 and Main Firmware only)
  * recovery state-set - Set the secure state (BL1 and Main Firmware only)
  * recovery boot-resume - Resume device boot (BL1 and BL2 only)
  * recovery dport-unlock - Unlock debug port
  * recovery dport-lock-update - Update secure unlock version
• Extend existing command to support secure boot and firmware recovery
  * fw-update - Upload a new firmware image, add support for BL2 boot phase
  * fw-info - Return information on currently flashed firmware, add support for BL2 boot phase
  * fw-toggle - Toggle the active and inactive firmware partition, add support for BL2 boot phase

Limitaion

Openssl dependency

This release depends on and only works with openssl versoin 1.0.x. We will support other openssl versions in future release.

Switchtec-user v1.0 release for Linux platform

In this release

This is the release of switchtec-user v1.0 utility, which includes the following new features.

• TWI-based switchtec-user
• UART-based switchtec-user
• Option to count TLP bandwidth (Payload bandwidth counting mode or Raw bandwidth counting
  mode) using performance monitor utility
• Allow to start a new firmware download operation when last firmware download is timeout, e.g.,
  there is no firmware download activities in 30 seconds (this is configurable in firmware config file)
• Abort Real Time Eye Capture (VHIST) Command

Known issues

F/W download issue

• Description
  If a F/W download is in progress, another execution of switchtec-user utility would result in unexpected behaviors.

• Workaround
  Please do not execute another instance of switchtec-user utility when a F/W download is in progress.