background image

American Megatrends, Inc. 
AMIDebug

™ Rx – User Manual 

 

 

 

 
 

Copyright ©2017 

American Megatrends Inc. ● Public Document  

Page 26 of 36 

Debug Mode Functionality 

AMIDebug Products for Source-Code Development 

AMIDebug  software  solutions  are  powerful  tools  for 
debugging  AMIBIOS8  &  Aptio  4.x  BIOS  projects, 
offering  source-level  debugging  without  the  need  for 
an  expensive  in-circuit  emulator  (ICE)  or  in-target 
probe  (ITP)  hardware  solution.  Developers  have 
access  to  source-level  debugging  and  control  the 
debug  target  hardware  through  a  GUI  application  for 
Microsoft Windows. 

AMIDebug  for  AMIBIOS8  provides  functionality 
similar 

to  hardware-based 

development 

tools, 

including,  source-level  symbolic  debugging  and 
access  to  hardware  resources  (CPU  registers,  PCI 
config space, memory and I/O locations). 

AMIDebug for UEFI offers the same debugging capabilities for Aptio 4.x firmware, as well as debugging 
UEFI drivers and pre-boot applications running in the EFI Shell. 

For more information on AMI Debug software products, 

contact an AMI Software Sales Associate

USB Debug Mode 

AMIDebug Rx functions as a generic USB debug descriptor device when the OPTION SWITCH is set to 
debug mode (LEFT). This function allows host-to-host communication for various debug applications. 




Note that checkpoint display is disabled in this mode. 

AMI Debug Unlock Code 

The  AMIDebug  Rx 

product  can  be  used  as  a  “debug  transport”  to  connect  a  system  under  test  with 

debug  host  software  (AMIDebug  for  UEFI  and  AMIDebug  for  AMIBIOS8).  This  feature  is  disabled  by 
default but can be unlocked by customers licensing AMIDebug software from AMI. More information on 
using AMIDebug Rx is included in the AMIDebug user manual. 

An AMI software sales associate will provide an unlock code based on the unit serial number. The serial 
number can be found using the 

info

 terminal command. 

Summary of Contents for AMIDebug Rx

Page 1: ...ser Manual Document Revision 1 43 April 27th 2017 Public Document Copyright 2017 American Megatrends Inc 5555 Oakbrook Parkway Suite 200 Norcross GA 30093 USA All Rights Reserved Property of American Megatrends Inc ...

Page 2: ...bility In no event shall American Megatrends be held liable for any loss expenses or damages of any kind whatsoever whether direct indirect incidental or consequential arising from the design or use of this product or the support materials provided with the product Limited Warranty No warranties are made either expressed or implied with regard to the contents of this work its merchantability or fi...

Page 3: ...G PORT 9 CHECKPOINT FUNCTIONALITY 9 CHANGING THE CHECKPOINT DISPLAY FORMAT 9 VIEWING CHECKPOINT HISTORY 10 AMIDEBUG RX MENU REFERENCE 11 USING THE DEVICE MENU 11 MENU STRUCTURE 11 EXIT MENU 11 START NEW SESSION 12 SAVE SESSION 12 LOAD SESSION 12 ERASE SESSION 13 INFO 14 SETTINGS 14 USING AMIDEBUG RX VCOM FUNCTIONALITY 16 USB VIRTUAL COM VCOM TERMINAL 16 CONFIGURING THE DEVICE MICROSOFT WINDOWS 16 ...

Page 4: ...rends Inc Public Document Page 4 of 36 USB DEBUG MODE 26 AMI DEBUG UNLOCK CODE 26 WINDOWS KERNEL DEBUGGING 27 TERMINAL OUTPUT EXAMPLES 29 EXAMPLE STRING TABLE USING DOWNLOAD DISPLAY COMMAND 29 EXAMPLE SESSION OUTPUT USING DOWNLOAD DISPLAY COMMAND 32 LIMITED HARDWARE WARRANTY 36 ...

Page 5: ...e debugging messages than the checkpoint card along with extended features such as boot performance timing and UEFI debug message redirection Key Features USB based replacement for the PCI port 80h POST Checkpoint card Checkpoints can be captured and stored to one of four sessions for later review Measures elapsed time between checkpoints to analyze boot performance timing Display descriptive text...

Page 6: ...ted firmware version in info command example v2 2 1 2009 08 12 1 00 Updated firmware version in info command example v2 3 0 Added info command example to unlock procedure Added footnote for UEFI Debug Strings pg 8 2009 11 05 1 10 Updated for v2 3 1 firmware Added Erase Session and Info menu commands Added marker for stored sessions in Save Session and Load Session dialogs 2010 02 01 1 20 Updated f...

Page 7: ...r USB CONNECTOR 0 USB1 LED indicates connection ON activity BLINK for USB CONNECTOR 1 SHIFT Used in checkpoint mode to change checkpoint display format SELECT Used in menu navigation also used in checkpoint mode to checkpoint display format MENU Used to enter exit menu Used in menus to select next entry also used in checkpoint mode to navigate buffer Used in menus to select previous entry also use...

Page 8: ...ns to local memory 2 Connect AMIDebug Rx to a computer after boot and use the Virtual COM VCOM terminal to retrieve checkpoint sessions upload new checkpoint string tables and view UEFI debug strings in real time during the boot process 3 Use AMIDebug Rx to connect a debug host target for use with AMI Debug source level debugging tools AMIDebug for UEFI or AMIDebug for AMIBIOS8 3 UEFI debug string...

Page 9: ...to locate this port Checkpoint Functionality Turn off the system under test SUT Set the OPTION SWITCH to checkpoint mode RIGHT and connect the AMIDebug Rx to the USB debug port on the SUT Turn on the SUT AMIDebug Rx will power on and start displaying data sent to the USB debug port By default POST checkpoints are displayed in a right justified format Changing the Checkpoint Display Format The SELE...

Page 10: ...ican Megatrends Inc Public Document Page 10 of 36 When using string displays SHIFT switches the word based checkpoint value between big endian and little endian byte order Viewing Checkpoint History Checkpoints in a current session are viewed using the UP DOWN buttons ...

Page 11: ...When operating in checkpoint mode use the MENU button to enter the device menu Use the arrow keys to navigate The SELECT switch is used to select options and sub menus The SHIFT key has no assigned function in the sub menus Use the MENU key to exit any sub menu Menu Structure Exit Menu The option is used to exit the menu and return to the current checkpoint session ...

Page 12: ... the session number Note Saving over a session already containing data will prompt the user to overwrite the session or cancel the save operation Select Y to continue or N to cancel the operation Once a session is saved the device will display a confirmation message and then return to the menu To retrieve a saved session use the menu command or the download display terminal commands The saved sess...

Page 13: ...ommands UEFI debug strings from a saved session can only be viewed using the download display terminal commands Erase Session The option allows the user to erase any stored checkpoint session in the four data areas 1 2 3 4 This performs the same function as the erase command in the VCOM terminal Use the SELECT button to select a session or use the MENU button to return to the previous menu without...

Page 14: ...n be accessed without resetting the device After viewing the information press SELECT or MENU to return to the previous menu Settings The menu sub menus allows the user to customize the look feel of various features Chk Pnt Tbl Select The Checkpoint Table Select option determines the checkpoint string table used to translate POST Checkpoint values For more information on string tables refer to the...

Page 15: ...e checkpoint string lookups to use a user provided table string table 3 Boot Logo The option determines if the sign on message is displayed at power on The option will enable the displaying of the sign on message including the current firmware version The option will disable the displaying of the sign on message Save Settings The option will store user preferences in the Settings menu for use at t...

Page 16: ...der Microsoft Windows XP Vista to map the device to a COM port address This driver is available via Microsoft Update so the Found New Hardware Wizard can connect to the Internet and install the proper driver If prompted to connect to Windows Update use the Yes this time only option to automatically locate and load the device driver The Silicon Labs CP210x USB to UART driver can also be downloaded ...

Page 17: ...user will see the following prompt Invalid command Enter help for a list of valid commands Terminal Commands A summary of terminal commands is generated by typing help at the command prompt help Command list Help This help menu Upload Upload a string file to the device Download Download a session or string file from the device Display Dump a session or string table to the console Erase erase a ses...

Page 18: ... selected in the menu String table 1 is reserved for AMI Aptio 4 x String table 2 is reserved for AMIBIOS8 String table 3 is set aside for custom checkpoint string tables To generate a custom checkpoint string table use the download command to extract an existing string file as the starting point for the new checkpoint string table After issuing the upload command in the terminal an XMODEM send tr...

Page 19: ... of session 3 to host Sessions 1 4 correspond to the checkpoint capture sessions used by the and menu commands String table 1 is reserved for AMI Aptio 4 x String table 2 is reserved for AMIBIOS8 String table 3 is set aside for custom checkpoint string tables After issuing the download command in the terminal an XMODEM receive transfer must be initiated to transfer the text file from the AMIDebug ...

Page 20: ...rminal The display command dumps a stored session or string table from the device s local memory This differs from the download command since it directly outputs the data into the terminal buffer This allows the data to be captured and saves using the terminal s memory buffer Sessions 1 4 correspond to the checkpoint capture sessions used by the and menu commands String table 1 is reserved for AMI...

Page 21: ...he and menu commands String table 1 is reserved for AMI Aptio 4 x String table 2 is reserved for AMIBIOS8 String table 3 is set aside for custom checkpoint string tables Erasing string tables 1 or 2 is not recommended Keep a backup of any string table using the download or display commend prior to using the erase command Info The info command displays information about the AMIDebug Rx device such ...

Page 22: ...file is being transferred After the upload is successful remove power from the unit by disconnecting all USB cables Press hold all three buttons on the left side of the device SHIFT MENU SELECT then reconnect the USB cable used for the VCOM terminal This will supply power to the device Release the SHIFT MENU SELECT buttons once the device powers on After releasing the SHIFT MENU SELECT buttons the...

Page 23: ...er or EHCI interface AMIDebug Rx Does Not Power On AMIDebug Rx is a bus powered USB device so it draws power from the USB connection USB0 and USB1 If the computer connected to AMIDebug Rx is powered off then the device will shutdown AMIDebug Rx can draw power from the USB0 USB1 connectors at the same time If one of the connectors is attached to a running system then power will not be lost of the o...

Page 24: ...okups to use Aptio 4 x data string table 1 force checkpoint string lookups to use AMIBIOS8 data string table 2 force checkpoint string lookups to use a user provided table string table 3 AMIDebug Rx Checkpoint Strings Are Corrupted or Blank If checkpoint strings are corrupted or the area where the string should be is blank then the string tables stored in AMIDebug Rx device may be corrupted These ...

Page 25: ...e following Close any terminal sessions used to access AMIDebug Rx via USB VCOM Ayera TeraTerm Pro Microsoft Hyperterminal or similar program The driver will fail to install if any terminal programs are open and trying to access the AMIDebug Rx device Change the OPTION SWITCH on AMIDebug Rx from CHECKPOINT to DEBUG Ayera TeraTerm Does Not Recognize Ports above COM4 The USB VCOM port produced by AM...

Page 26: ...e debugging capabilities for Aptio 4 x firmware as well as debugging UEFI drivers and pre boot applications running in the EFI Shell For more information on AMI Debug software products contact an AMI Software Sales Associate USB Debug Mode AMIDebug Rx functions as a generic USB debug descriptor device when the OPTION SWITCH is set to debug mode LEFT This function allows host to host communication ...

Page 27: ...luded with the AMI Debug software distribution licensed from AMI to access VCOM functionality Windows Kernel Debugging AMI Debug Rx can be used as a generic USB debug transport for Windows Kernel Debugging Requirements for using Debug Rx as USB transport for Kernel Debugging Target platform with USB 2 0 Debug Port running Microsoft Windows Vista or higher Host running Debugging Tools for Windows W...

Page 28: ... The debug host must use the USB 2 0 Debug Connection Device driver supplied with WINDBG not the PLX debug driver supplied with AMIDebug Rx PCI bus device function numbers are in hexadecimal format for Microsoft Windows Vista but are in decimal format for Microsoft Windows 7 Please be aware of this when using bcdedit ...

Page 29: ...U INIT 12 CPU PRE MEM INIT 13 CPU PRE MEM INIT 14 CPU PRE MEM INIT 15 PRE MEM NB INIT 16 PRE MEM NB INIT 17 PRE MEM NB INIT 18 PRE MEM NB INIT 19 PRE MEM SB INIT 1A PRE MEM SB INIT 1B PRE MEM SB INIT 1C PRE MEM SB INIT 1D OEM PRE MEM INIT 1E OEM PRE MEM INIT 1F OEM PRE MEM INIT 2A OEM PRE MEM INIT 2B MEM INIT SPD READ 2C MEM INIT MEM DETECT 2D PROG MEM TIMING INFO 2E CONFIGURING MEMORY 2F MEM INIT...

Page 30: ...ED 57 CPU MISMATCH 58 CPU SELF TEST FAILED 59 CPU MICRO NOT FOUND 5A INTERNAL CPU ERROR 5B RESET PPI NOT AVAIL 5C AMI RESERVED 5D AMI RESERVED 5E AMI RESERVED 5F AMI RESERVED 60 DXE CORE STARTED 61 NVRAM INITIALIZATION 62 INSTALL SB RUNTIME 63 CPU DXE INIT 64 CPU DXE INIT 65 CPU DXE INIT 66 CPU DXE INIT 67 CPU DXE INIT 68 PCI HB INIT 69 NB DXE INIT 6A NB DXE SMM INIT 6B NB DXE INIT 6C NB DXE INIT ...

Page 31: ...USB DETECT 9D USB ENABLE 9E AMI RESERVED 9F AMI RESERVED A0 ASL RESERVED A1 IDE INIT A2 IDE RESET A3 IDE DETECT A4 IDE ENABLE A5 SCSI INIT A6 SCSI RESET A7 SCSI DETECT A8 SCSI ENABLE A9 SETUP VERIFY PASS AA ASL RESERVED AB START OF SETUP AC SETUP INPUT WAIT AD READY TO BOOT EVENT AE LEGACY BOOT EVENT AF EXIT BOOT SERVICES B0 VIRTUAL ADDR MAP BEG B1 VIRTUAL ADDR MAP END B2 LGCY OPTION ROM INIT B3 S...

Page 32: ... OS S3 WAKE VECTOR E4 AMI RESERVED E5 AMI RESERVED E6 AMI RESERVED E7 AMI RESERVED E8 S3 RESUME PEI FAIL E9 S3 PPI NOT FOUND EA S3 BOOT SCRIPT ERROR EB S3 OS WAKE ERROR EC AMI RESERVED ED AMI RESERVED EE AMI RESERVED EF AMI RESERVED F0 RECOVERY FIRMWARE F1 RECOVERY USER F2 RECOVERY STARTED F3 RECOVERY FW STARTED F4 RECOVERY FW LOADED F5 AMI RESERVED F6 AMI RESERVED F7 AMI RESERVED F8 RECOVERY PPI ...

Page 33: ...43ms USB INIT 26 0x0090 17 063ms BDS STARTED 27 0x0091 17 094ms DRIVER CONNECTING 28 0x0092 17 096ms PCI BUS INIT 29 0x0094 17 097ms PCI BUS ENUMERATION 30 0x0094 17 097ms PCI BUS ENUMERATION 31 0x0094 17 097ms PCI BUS ENUMERATION 32 0x0094 17 098ms PCI BUS ENUMERATION 33 0x0095 17 098ms PCI BUS REQUEST 34 0x0096 17 099ms PCI BUS ASSIGN 35 0x0097 17 400ms CONSOLE OUTPUT CON 36 0x00B2 17 401ms LGCY...

Page 34: ...S Addr 0466 Val 0000 AmiDbg TCO1_CNT Addr 0468 Val 0800 AmiDbg TCO2_CNT Addr 046A Val 0008 AmiDbg TCO_MESSAGE1 Addr 046C Val 00 AmiDbg TCO_MESSAGE2 Addr 046D Val 00 AmiDbg TCO_WDCNT Addr 046E Val 00 AmiDbg SW_IRQ_GEN Addr 0470 Val 03 AmiDbg TCO_MESSAGE2 Addr 0472 Val 0004 AmiDbg AmiDbg PM Registers After GPIO Init AmiDbg PM Registers dump AmiDbg PM1a_EVT_BLK PM1_STS Addr 0400 Val 0001 AmiDbg PM1a_...

Page 35: ...y FFFEE19D AmiDbg NumCpus 2 AmiDbg Register PPI Notify 605ea650 c65c 42e1 ba80 91a52ab618c6 AmiDbg PEIM 8401a046 6f70 4505 8471 7015b40355e3 was not started AmiDbg PEIM e008b434 0e73 440c 8612 a143f6a07bcb was not started AmiDbg PEIM 32505be8 6469 4f79 9b01 66b3f9617e7d was not started AmiDbg PEIM a47438d5 94e9 49b3 bc31 7e6bc9363814 was not started AmiDbg DXE IPL Entry AmiDbg CORE_DXE Entry 1F579...

Page 36: ...ith notification of the status of your board i e warranty or non warranty Remember non warranty boards will incur a minimum charge of 100 00 plus parts and shipping Please retain a copy of your notification for your files and future references Upon receipt of the RMA number return the Product together with a the return authorization number b proof and date of purchase C a description of the proble...

Reviews: