This document describes the functionality of the TPS659xx Application Customization Tool from Texas
Instruments. This tool can be used for generating configuration images for the host controller, for generating
configuration images for external flash memory and for debugging the TPS659xx device.
1.1 Related Documents............................................................................................................................................................3
1.4 Installation and Launch...................................................................................................................................................... 3
1.5 Features of the TPS659xx Application Customization Tool............................................................................................... 9
2 Using the TPS659xx Application Customization Tool.......................................................................................................10
2.2 Beginning a New Project..................................................................................................................................................12
2.3 Loading and saving configuration settings as a Project File............................................................................................ 15
2.4 Importing configuration settings from a Project File......................................................................................................... 16
2.5 Loading an updated base firmware image....................................................................................................................... 16
2.6 Changing the adapter settings to connect to the device.................................................................................................. 17
2.7 Importing Configuration Settings from a TPS659xx......................................................................................................... 19
2.8 Exporting project configuration settings as a JSON file................................................................................................... 19
2.9 Loading Configuration Image Onto a TPS659xx..............................................................................................................21
2.10 Loading Configuration Image onto a TPS659xx device's RAM......................................................................................22
2.11 Using the Debug Mode...................................................................................................................................................23
3 Using the Aardvark® ............................................................................................................................................................35
3.1 Software and Driver Installation....................................................................................................................................... 35
3.2 Connecting Aardvark® to TPS659xx-EVM....................................................................................................................... 36
Figure 2-1. Start Window of TPS659xx Application Customization Tool................................................................................... 10
Figure 2-2. Device To Be Used Selection.................................................................................................................................. 12
Figure 2-3. Template Type Selection......................................................................................................................................... 13
Figure 2-4. Port Type Selection................................................................................................................................................. 13
Figure 2-5. TPS659xx Application Customization Tool with Project.......................................................................................... 14
Figure 2-6. Loading a Project.................................................................................................................................................... 15
Figure 2-7. Changing the Firmware Base Image (Low-Region Binary File).............................................................................. 16
Figure 2-8. Display of an Updated Configuration image Image.................................................................................................17
Figure 2-9. USB to I2C/SPI Adapter Configuration Window......................................................................................................18
Figure 2-18. Sample Connection Status and Method in Debug Mode...................................................................................... 23
Figure 2-19. Sample Debug Mode tabs While Connected........................................................................................................ 24
Figure 2-20. Sample Debug Mode Tabs With Manual Command............................................................................................. 24
Figure 2-22. Example Raw Register Read Window.................................................................................................................. 26
Figure 2-23. Example of Successful Raw Register Read..........................................................................................................27
Figure 2-24. Successfully Entered the Script Tab Window........................................................................................................ 28
Figure 2-25. Example of Adding a New Script Task.................................................................................................................. 29
Figure 2-26. Successfully Adding a New Script Task................................................................................................................ 30
Figure 2-28. Save Snapshot Window........................................................................................................................................ 32
Figure 2-29. Sample Snapshot Text Output...............................................................................................................................32
Figure 2-30. Editing the VBUS Mapping....................................................................................................................................33
Figure 2-31. Consistency Check Information Box..................................................................................................................... 34
Figure 3-1. Texas Instruments TPS65988 Booster Pack J3 and J4 Pin Connections for I2C and SPI..................................... 36
Figure 3-2. Aardvark 10-Pin Header Connection on TPS65988-EVM.......................................................................................37
www.ti.com
List of Tables
Table 2-1. Features of the configuration tool..............................................................................................................................11
Trademarks
BoosterPack™ are trademarks of Texas Instruments.
Aardvark® and Total Phase®, are registered trademarks of Total Phase, Incorporated.
Microsoft® and Windows® are registered trademarks of Microsoft Corporation.
All other trademarks are the property of their respective owners.
2TPS659xx Application Customization ToolSLVUB60C – JUNE 2018 – REVISED SEPTEMBER 2020
This user’s guide describes the installation procedure, the process of using TI-provided configuration image
projects to create usable configuration images, and how to use this tool to debug TPS659xx devices. In addition,
the process of importing configuration settings both to a TPS659xx device is described.
Details regarding each configuration setting are not within the scope of this user’s guide. For information on
which settings to choose for the application, refer to the corresponding TPS659xx Host Interface TechnicalReference Manual (TRM) for the specific device.
1.1 Related Documents
The following related documents will be helpful for the device-specific part number:
•Microsoft® Windows® based PC with at least one USB 2.0 (or later) port
•TPS659xx-EVM
•Barrel-jack laptop charger power-supply AC adapter (20 V)
•USB Micro-B to USB Standard-A cable for USB2.0 Low-speed (for TIVA Adapter option)
•FTDI USB-to-SPI/I2C Host adapter + USB standard-B to -A cable + jumper wires or LaunchPad EVM to
Aardvark (for FTDI Adapter option)
•Total Phase® Aardvark® USB-to-SPI/I2C Host adapter + USB standard-B to -A cable + jumper wires (for
Aardvark Adapter option)
Note
Only one of these adapter options is required: Total Phase Aardvark, FTDI or USB Micro-B to USB
Standard-A cable. The hardware and setup will be different depending on the adapter selected.
1.3 Software
The required software packages and drivers are bundled into a single Windows installer. See Section 1.4 for
installation instructions using the bundled installer.
Additional software, Aardvark driver and software, is needed only if the user intends to use the Aardvark adapter.
See Section 3 for instructions on the Total Phase Aardvark driver and software installation.
1.4 Installation and Launch
Once the software is downloaded, perform the following steps to install the software:
1. Follow the onscreen instructions which are detailed as follows:
a. Read the Source and Binary Code license agreement.
b. If accepted, select the appropriate radio button and then click the Next button.
f. Select or deselect the options in Figure 1-4 by checking the corresponding boxes or radio buttons. This
step allows the user to install the desired driver depending on which adapter is used to interface with the
TPS659xx-EVM. TI recommends uninstalling any previous versions of these drivers before installation.
Getting Started
Figure 1-4. Miscellaneous Installation Options
Note
Uninstalling all previous FTDI driver installations will allow the tool to install the FTDI version
2.12.26.
g. Review the selected options and then click Install to start the installation of the tool.
7. Save configuration register settings to a zip file.
The tool includes TI-provided projects, which are configuration templates that contain settings that are specific to
various applications. These projects are to be used as a starting point in generating configuration images. Users
can select a project that corresponds to the user’s intended device and application.
Note
Projects have a varying level of configurability, depending on the application.
www.ti.comUsing the TPS659xx Application Customization Tool
The starting page is a TPS659xx empty template that contains no configuration settings or Firmware Base
Image.
Once you select a “New Project” or “Load Project”, the page updates to show all the menu options which are
listed in Table 2-1
Table 2-1. Features of the configuration tool
FeatureDescription
ProjectSelect to begin a new project, open an existing project, save the project, export configuration settings as JSON
BinarySelect to save the binary or flash from an already saved binary file or current configuration settings
DeviceSelect to import configuration settings from a device
SettingsSelect to show bitfield ranges, raw field values, or the raw combined configured values
AdapterSelect which USB to I2C/SPI adapter (TIVA,FTDI or Aardvark) is used to connect to the TPS659xx EVM
DebugSelect to view and edit debug registers and send commands
DocumentsSelect to open application customization tool users guide, application customization tool manifest,
HelpSelect to open an About window, which describes version information
Change FileAllows user to load a new configuration image base image (.bin format). This is primarily applicable when a
Number of Connected
Devices
Port X SettingsClick this tab to customize the various configuration settings of an uploaded project. Additional tabs will appear
Firmware Base Image
or import settings from project
configuration image release notes
user has an updated configuration image base image
Allows user to save unique configurations for up to three devices in a single image to flash simultaneously
(through UART)
if more than one device is selected under Device Initialization Chain or if the device has multiple ports
Displays the loaded base binary file that is pre-loaded with the project. This image can be changed by
selecting Change File. Note that no file will be present until a project is selected.
When beginning a new project, new users can open default templates (.tpl) which are provided by Texas
Instruments. The default templates cover primary use cases for all TPS659xx applications. At any time a user
can use the Import Settings from Project feature to help move from one type of template to another as described
in Section 2.4.
Note
The following steps walk through the general process for selecting a default TI template. The
questions asked vary from device to device and may not perfectly match the exact questions shown
below. As an example, the TPS65988DH device is used to walk through the process below. The
devices listed in the application will vary over time based on application updates and as new products
are launched.
To load and use one of the default TI templates, use the following instructions:
Click the Project tab in the menu. Then select New Project from the drop-down. The pop-up window allows the
user to filter, select, and open a default project.
1. Select the device to be used.
Figure 2-2. Device To Be Used Selection
2. Select the template type to be started with.
Note
Texas Instruments recommends users begin with a “Standard” template. A “Standard” template
preconfigures and hides complex registers while an “Advanced” template will show these registers
and be available for edit.
12TPS659xx Application Customization ToolSLVUB60C – JUNE 2018 – REVISED SEPTEMBER 2020