package hw.trezor.messages.debug

Get desktop application:
View/edit binary Protocol Buffers messages

* Request: "Press" the button on the device @start @next DebugLinkLayout

• optional DebugLinkDecision.DebugButton button = 1

  button press

• optional DebugLinkDecision.DebugSwipeDirection swipe = 2

  swipe direction

• optional string input = 3

  keyboard input

• optional uint32 x = 4

  touch X coordinate

• optional uint32 y = 5

  touch Y coordinate

• optional bool wait = 6

  wait for layout change

• optional uint32 hold_ms = 7

  touch hold duration

• optional DebugLinkDecision.DebugPhysicalButton physical_button = 8

  physical button press

• optional DebugLinkDecision.DebugTouchEventType touch_event_type = 9

* Structure representing button presses

Used in: DebugLinkDecision

• NO = 0

• YES = 1

• INFO = 2

TODO: probably delete the middle_btn as it is not a physical one

Used in: DebugLinkDecision

• LEFT_BTN = 0

• MIDDLE_BTN = 1

• RIGHT_BTN = 2

* Structure representing swipe direction

Used in: DebugLinkDecision

• UP = 0

• DOWN = 1

• LEFT = 2

• RIGHT = 3

* Explicit touch event type, used to separate TOUCH_START and TOUCH_END If not set, defaults to full click behavior (TOUCH_START + optional hold + TOUCH_END)

Used in: DebugLinkDecision

• TOUCH_FULL_CLICK = 0

• TOUCH_START = 1

• TOUCH_END = 2

* Request: Erase the SD card @start @next Success @next Failure

• optional bool format = 1

  if true, the card will be formatted to FAT32.

* Request: Erase block of flash on device WARNING: Writing to the wrong location can irreparably break the device. @start @next Success @next Failure

• optional uint32 sector = 1

* Response: GC heap information details. @end

• repeated DebugLinkGcInfo.DebugLinkGcInfoItem items = 1

* Key-value pair.

Used in: DebugLinkGcInfo

• required string name = 1

• required uint64 value = 2

* Request: Get GC heap information. @start @next DebugLinkGcInfo

(message has no fields)

* Request: Host asks for device pairing info @start @next DebugLinkPairingInfo

• optional bytes channel_id = 1

  ID of the THP channel to get pairing info from

• optional bytes handshake_hash = 2

  handshake hash of the THP channel

• optional bytes nfc_secret_host = 3

  host's NFC secret (In case of NFC pairing)

* Request: Host asks for device state @start @next DebugLinkState

• optional bool wait_word_list = 1

  Trezor T < 2.6.0 only - wait until mnemonic words are shown

• optional bool wait_word_pos = 2

  Trezor T < 2.6.0 only - wait until reset word position is requested

• optional DebugLinkGetState.DebugWaitType wait_layout = 3

  trezor-core only - wait until current layout changes changed in 2.6.4: multiple wait types instead of true/false.

• optional bool return_empty_state = 4

  Responds immediately with an empty `DebugLinkState` (used for client-side synchronization).

/ Wait behavior of the call.

Used in: DebugLinkGetState

• IMMEDIATE = 0

  / Respond immediately. If no layout is currently displayed, the layout / response will be empty.

• NEXT_LAYOUT = 1

  / Wait for next layout. If a layout is displayed, waits for it to change. / If no layout is displayed, waits for one to come up.

• CURRENT_LAYOUT = 2

  / Return current layout. If no layout is currently displayed, waits for / one to come up.

* Response: Device text layout as a list of tokens as returned by Rust @end

• repeated string tokens = 1

* Response: Device wants host to log event @ignore

• optional uint32 level = 1

• optional string bucket = 2

• optional string text = 3

* Response: Device sends memory back @end

• optional bytes memory = 1

* Request: Read memory from device @start @next DebugLinkMemory

• optional uint32 address = 1

• optional uint32 length = 2

* Request: Write memory to device. WARNING: Writing to the wrong location can irreparably break the device. @start @next Success @next Failure

• optional uint32 address = 1

• optional bytes memory = 2

• optional bool flash = 3

* Request: Set Optiga's security even counter to maximum @start @next Success

(message has no fields)

* Response: Device pairing info @end

• optional bytes channel_id = 1

  ID of the THP channel the pairing info is from

• optional bytes handshake_hash = 2

  handshake hash of the THP channel

• optional uint32 code_entry_code = 3

  CodeEntry pairing code

• optional bytes code_qr_code = 4

  QrCode pairing code

• optional bytes nfc_secret_trezor = 5

  NFC secret used in NFC pairing

* Request: Start or stop recording screen changes into given target directory @start @next Success

• optional string target_directory = 1

  empty or missing to stop recording

• optional uint32 refresh_index = 2

  which index to give the screenshots (after emulator restarts)

* Request: Re-seed RNG with given value @start @next Success

• optional uint32 value = 1

* Request: Remove all the previous debug event state @start @next Success

(message has no fields)

* Request: Set logging filter string. @start @next Success

• optional string filter = 1

  filter string

* Response: Device current state @end

• optional bytes layout = 1

  raw buffer of display

• optional string pin = 2

  current PIN, blank if PIN is not set/enabled

• optional string matrix = 3

  current PIN matrix

• optional bytes mnemonic_secret = 4

  current mnemonic secret

• optional common.HDNodeType node = 5

  current BIP-32 node

• optional bool passphrase_protection = 6

  is node/mnemonic encrypted using passphrase?

• optional string reset_word = 7

  word on device display during ResetDevice workflow

• optional bytes reset_entropy = 8

  current entropy during ResetDevice workflow

• optional string recovery_fake_word = 9

  (fake) word on display during RecoveryDevice workflow

• optional uint32 recovery_word_pos = 10

  index of mnemonic word the device is expecting

• optional uint32 reset_word_pos = 11

  during RecoveryDevice workflow

  index of mnemonic word the device is expecting during ResetDevice workflow

• optional management.BackupType mnemonic_type = 12

  current mnemonic type (BIP-39/SLIP-39)

• repeated string tokens = 13

  current layout represented as a list of string tokens

* Request: Ask device to restart @start

(message has no fields)

* Request: Start or stop tracking layout changes @start @next Success

• optional bool watch = 1

  if true, start watching layout.