Tool Set

Besides the extension features developed in the SoC system, tool sets developed in the host are also provided in the sdk\tool directory for extended feature development, user application development, or mass production.

This document provides a brief introduction to these tools and their usage methods. For the user manual for each tool, please refer to the tool user manual in the specific directory.

The brief descriptions of each tool are as follows:

Tool Name	Description	Path	Note
MPPG Tool	Used for RD programming and mass production programming.	\tool\MPPGTool-vx.x.x.x	Common Usage
Flash	Keil flash algorithm for downloading applications.	\tool\flash	Common Usage
MD5	Generate an MD5 checksum for the image file, which will be further verified by the MP tool sets.	\tool\Gadgets\md5	Common Usage
Prepend Header	Generate the OTA header and MP header, which will be verified by the MP tool sets.	\tool\Gadgets\prepend_header	Common Usage
Version Generation	Generate a version header file for the user application using Git or SVN.	\tool\Gadgets\version_generation	Common Usage
Resign Tool	Re-sign the images using the provided private key.	\tool\Gadgets\resign_tool	Common Usage
Debug Analyzer	Used for system logging and debugging.	\tool\DebugAnalyzer-vx.x.x.x	Common Usage
MCUConfig Tool	Used for OEM system configuration and application UI parameter configuration.	\tool\MCUConfigTool-vx.x.x.x	Common Usage
DSPConfig Tool	Generate DSP configuration images.	\tool\DspConfigTool-vx.x.x.x	Common Usage
ANC Design Tool	Generate ANC images.	\tool\AncDesignTool-vx.x.x.x	For Headset
ANC MP Tool	Support read gain, write gain to RAM, and download gain to Flash for feedforward and/or feedback filters.	\tool\ANCMPTool-vx.x.x.x	For Headset
Android Audio Connect	Used for extended feature development on Android phones.	\tool\AudioConnect Android	Common Usage
iOS Audio Connect	Used for extended feature development on iOS phones.	\tool\AudioConnect iOS	Common Usage
MP Kit Setup Package	Verify RF performance and certification.	\tool\MPKitSetupPackage-vx.x.x.x	Common Usage
Realtek Bluetooth MP Tool	Match with Realtek’s Genesis production version used in mass-production.	\tool\RealtekBTMPTool-vx.x.x.x	Common Usage
Fast MP Tool	Match with Realtek’s Fast MP production board used in mass-production.	\tool\FastMPTool-vx.x.x.x	Common Usage
ACI Host CLI Tool	Used for cmd/event communication test with ACI Device through USB serial port.	\tool\AciHostCLI-vx.x.x.x	Common Usage
CFU Download Tool	Used for firmware upgrade of the chip using USB.	\tool\CFUDownloadTool-vx.x.x.x	Common Usage
OTA Dongle Tool	Prepare the OTA tooling board for performing SPP OTA on Realtek Audio chips.	\tool\OtaDongleTool-vx.x.x.x	Common Usage

Note

Realtek Bluetooth MP Tool and Fast MP Tool will be provided in Realtek SDK later.

MPPG Tool

MPPG Tool supports mass production and debug mode.

1. The debug mode allows developers to use the tool for debugging and feature development.

2. The MP mode supports various features, including downloading up to 8 devices simultaneously and changing the Bluetooth address of the device.

MP Pack, Flash Map Generator and OTA Header Generator functions are integrated into the MPPG Tool chain. For instructions on how to use these functions, please refer to MPPG Tool Chain User Guide available on the Realtek official website at RealMCU.

In the following section, a brief overview of the usage of the MPPG Tool in debug mode is provided. RTL8763ESE will be used as an example to illustrate the steps involved in the downloading process. Please refer to MPPG Tool User Guide available on the Realtek official website at RealMCU for more details.

1. Set the EVB to Download Mode (refer to Download Mode).

   Note

   The download connection varies for different RTL87x3 ICs. Please refer to the respective Evaluation Board User Guide available on the Realtek official website at RealMCU for detailed instructions.

2. Double-click to run MPPGTool.exe located in \tool\MPPGTool-vx.x.x.x. Then, choose the chip type and click the [Confirm] button.

3. Click on [Type] in the menu bar and choose [Debug] mode, and the following interface will be displayed.

4. Load the flash map.ini file located in \bin\rtl87x3e\flash_map_config\4M\flash_4M.

5. Browse the folder and load the required bin files listed in Required Files in the following interface.

   The corresponding files for RTL8763ESE are shown in the following table.

   File Type	File Name	File Path
   OTA Header Image	OTAHeader_Bank0_xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   Boot Patch Image	boot_patch_MP-xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   DSP APP Image	dsp_app_image_xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   DSP SYS Image	dsp_sys_image_xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   DSP Config Image	dsp_config_image-xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   FSBL Image	fsbl_bank0_MP-xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   Bluetooth Controller EXT Image	lowerstack_ext_image_4M_MP-xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   Platform EXT Image	platform_ext_image_MP-xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   Stack Patch Image	stack_patch_4m_bank0_MP-xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   SYS Patch Image	sys_patch_bank0_MP-xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   Bluetooth Host Image	upperstack_4M_MP-xxx.bin	\bin\rtl87x3e\8763ESE\4M\BANK0
   APP Config Image	APP_Config_xxx.bin	\bin\rtl87x3e\8763ESE\4M\rcfg\For EVB
   System Config Image	SYSTEM_Config_xxx.bin	\bin\rtl87x3e\8763ESE\4M\rcfg\For EVB
   VPData Config Image	VPData_xxx.bin	\bin\rtl87x3e\8763ESE\4M\rcfg\For EVB
   APP Demo Image	Refer to the Actual Situation	\bin\rtl87x3e\app_demo_bin\mdk

6. Click [Detect], the interface will display the detected COM port of the device.

7. Click [Open], if the COM port can be opened successfully, the progress bar on the right side will display ‘OK’, otherwise, it will display ‘Failed’. If ‘Failed’, users should go through the following checklist to ensure all conditions are met, then click [Detect] and [Open] again.

   Tip

   Conditions to Check:

   1. The TX/RX pins of the serial port are connected correctly.

   2. The Log Pin (TP6) of the device is grounded before powering on.

   3. The serial port converter board supports a 1M baud rate.

   4. The COM port is not occupied.

8. Click [Chip Erase] button to erase the chip before downloading. The status will indicate ‘Success’.

   Note

   MPPG Tool can download single or multiple files.

   1. During the initial downloading process, users need to Chip Erase and then download all the images.

   2. If later on users want to update only a single file, such as the APP Demo Bin, please skip this step.

   

9. Click the [Detect] and [Open] button in tool UI again.

10. After the serial port is successfully opened, Click [Download], the progress bar on the right of the COM port displays the current download progress.

    1. After the download is completed, it will display ‘Success’.

    2. If ‘Failed’ is displayed, please press the Reset button on the EVB or power cycle the EVB, and then repeat the above steps.

11. Open the Factory Reset tool integrated into the MPPG Tool chain.

    Note

    1. After the initial downloading process or updating the MCUConfig bin, it is necessary to Factory Reset using the MPPG Tool.

    2. If it is not the above-mentioned case, please skip this step.

    

12. Load the corresponding flash map.ini file and click [Factory Reset] Button.

    

Gadgets

Some small tool sets for application development are also provided in the SDK.

1. Flash: Flash algorithm for Keil download option.

2. MD5: Generate the MD5 file format, which is used to add MD5 to the file name of the image.

3. Prepend Header: Prepend header information with OTA and MP header for further MP process.

4. Version Generation: Generate version for user application which may be useful for OTA and version track.

5. Resign Tool: Re-sign all the images with the provided private key.

Debug Analyzer

Debug Analyzer is developed to capture system logs via several transport layers and decode them for user-friendly debugging.

Key features supported in this tool include:

1. Support multiple input ways.

   1. UART

   2. Binary file

2. Support both MCU and DSP logs.

3. Log saving and parsing.

4. Generate Bluetooth snoop log for further analysis by Frontline capture tool.

5. Support Ellisys injection.

A brief introduction to the usage of Debug Analyzer is described as follows. RTL8763ESE is taken as an example to illustrate the steps. Please refer to Debug Analyzer User Guide available on the Realtek official website at RealMCU for more details.

1. Set the EVB to Log Print Mode (refer to Log Pin Wiring) and then power on the EVB (refer to Power Supply).

   Note

   Log debugging connection varies for different RTL87x3 ICs. Please refer to the respective Evaluation Board User Guide available on the Realtek official website at RealMCU for detailed instructions.

2. Double-click to run DebugAnalyzer.exe located in \tool\DebugAnalyzer-vx.x.x.x.

3. Click [Settings] to set parameters.

4. Set parameters in the following UI according to requirements and click [Confirm]. Taking bt_audio_receiver demo bin as an example, the trace path is shown as follows.

5. Click [Start] to capture log.

6. Press the reset button in EVB, and log will be printed by Debug Analyzer as shown in the following figure.

7. Users can switch the ARM log and DSP log by clicking the arrow in the lower left corner of UI.

Note

To generate system log, [Log output] should be set to Enable in System Configuration tab of MCUConfig Tool, as shown in the following figure.

MCUConfig Tool

MCUConfig Tool is used for changing application and system behaviors without any modification in source code.

1. The system configuration is used to change system-wide configuration, such as logging, link numbers for different profile links, etc.

   • Stack options: Bluetooth stack and profile options.

   • Platform options: System options, including internal charger.

2. The application configuration is designed to provide vendors a simple way to change application UI parameters on its binary image.

In the following section, the common operations of MCUConfig Tool are briefly introduced. Users can make customized modification based on the default RCFG bin provided by Realtek SDK. For more information, please refer to MCUConfig Tool User Guide available on the Realtek official website at RealMCU.

1. Double-click to run McuConfigTool.exe located in \tool\MCUConfigTool-vx.x.x.x. Choose the chip type and click [Import Bin File] button.

2. Load the default RCFG bin in SDK. Taking RTL8763ESE as an example, the path is shown as follows.

3. Users can modify corresponding settings according to requirements, such as device name.

4. After setting the configurations, click [Save as] to export the MCUConfig bin.

   

5. If users need to re-import the RCFG bin during the configuration process, please click [Reset] to return to the main interface and select the required RCFG bin again to import.

Note

If the flash layout in the SDK is changed, the new flash_map.ini should be imported by clicking [Import flash map.ini] in the System Configuration tab, as shown below.

DSPConfig Tool

The DSPConfig Tool allows developers to configure parameters of built-in signal processing algorithms for phone calls, music playback, and VAD. In addition, this DSPConfig Tool also provides user-friendly parameter fine-tuning functions, which can greatly shorten the turnaround time of parameter tuning. This tool also supports the generation of DSP configuration images.

As for how to use the DSPConfig Tool, please refer to DSPConfig Tool User Guide available on the Realtek official website at RealMCU.

ANC Design Tool

The ANC Design Tool is convenient for users to choose the actual number of biquad filters used in a filter, design coefficients of biquad filters, and visualize the overall response of a filter.

As for how to use the ANC Design Tool, please refer to its user guide in the \tool\AncDesignTool-vx.x.x.x directory.

ANC MP Tool

The ANC MP Tool supports the functionality to read gain, write gain to RAM, and download gain to Flash for feedforward and/or feedback filters. Additionally, the write gain function can be used to enable or disable the feedforward and/or feedback filters.

As for how to use the ANC MP Tool, please refer to its user guide in the \tool\ANCMPTool-vx.x.x.x directory.

Android Audio Connect

An Android tool set for Bluetooth audio could implement features such as TTS, OTA, and renaming device. With the apk installed on an Android phone, the Android tool set could communicate with Bluetooth audio devices and support the corresponding features described as follows:

1. Device Information Display: Display the device name and battery level information.

2. Rename: Modify device name.

3. Language Switch: Change the voice language of the device.

4. Channel Switch: Provide three modes for users to switch.

5. OTA: Upgrade device firmware to keep the device running the latest version.

6. Real Hearing Enhancement: Adjust hearing effect by switching the listening mode and adjusting the configuration in each mode.

7. Equalizer: Adjust the built-in sound effect of music.

8. TTS: Help users obtain caller’s information before answering the call.

9. Gaming Mode: Control whether to open the game mode and provides five delay levels to choose.

10. Key Mapping: Show the mapping between key actions and the functions they triggered.

11. VP/Ringtone Volume: Adjust Voice Talk/Ringtone Volume.

12. Download/Apply ANC_APT Param: Write ANC or LLAPT parameters to the device.

13. SPP Data Capture: Capture DSP logs via SPP.

14. APT: Transparent mode in listening mode, including EQ, scenario switching, volume adjustment, etc.

15. ANC: Noise reduction mode in listening mode, including EQ, scenario switching, etc.

As for how to use the Android tool set, please refer to Android Audio Connect App User Guide available on the Realtek official website at RealMCU.

iOS Audio Connect

An iOS tool set is designed for the iOS platform. With the ipa installed on an iOS phone, the iOS tool set could communicate with Bluetooth audio devices and support the corresponding features described as follows:

1. Device Information Display: Display the device name and battery level information.

2. Rename: Modify device name.

3. Language Switch: Change the voice language of the device.

4. Channel Switch: Provide three modes for users to switch.

5. OTA: Upgrade device firmware to keep the device running the latest version.

6. Real Hearing Enhancement: Adjust hearing effect by switching the listening mode and adjusting the configuration in each mode.

7. Hearing Aid Adjustment: Adjust Hearing Aid configuration settings.

8. Hearing Assessment Test: Provide a simple and easy-to-use Hearing Assessment test to have knowledge of the user’s hearing condition.

9. Equalizer: Adjust the built-in sound effect of music.

10. Voice EQ: Adjust the EQ parameter in the call.

11. TTS: Help users obtain caller’s information before answering the call.

12. Gaming Mode: Control whether to open the game mode and provides five delay levels to choose.

13. Key Mapping: Show the mapping between key actions and the functions they triggered.

14. VP/Ringtone Volume: Adjust Voice Talk/Ringtone Volume.

15. Download/Apply ANC_LLAPT Parameters: Write ANC or LLAPT parameters to the device.

16. Data Capture V2: Capture DSP logs via Bluetooth Low Energy.

As for how to use the iOS tool set, please refer to iOS Audio Connect User Manual available on the Realtek official website at RealMCU.

MP Kit Setup Package

The MP Kit Setup Package is used to verify RF performance and certification. This tool can generate non-signaling Bluetooth signals of various modulation for regulatory certification and enter the direct test mode of Bluetooth.

As for how to use the MP Kit Setup Package, please refer to its user guide in the \tool\MPKitSetupPackage-vx.x.x.x directory.

Realtek Bluetooth MP Tool

The Realtek Bluetooth MP Tool is matched with Realtek’s Genesis production version used in mass-production. The tool supports functions such as writing image, measuring voltage, simple frequency calibration, audio loopback, and modifying configuration data during mass-production. The MP tool can support up to 1 to 8 mass production modes.

As for how to use the Bluetooth MP Tool, please refer to RF Test and MP Tool User Manual available on the Realtek official website at RealMCU.

Fast MP Tool

The Fast MP Tool must be matched with Realtek’s FastMP production board used in mass-production. RTK Fast MP Tool allows for simultaneous functional testing of the Windows 10/11 system on a computer, and the application is multithreaded. It can support testing of up to 24 DUTs, including functions such as writing image, RF calibration, and modifying configuration data.

As for how to use the Fast MP Tool, please refer to RF Test and MP Tool User Manual available on the Realtek official website at RealMCU.

ACI Host CLI Tool

The ACI Host CLI Tool is a test tool running on PC, which is used to demo ACI usage. It can perform cmd/event communication test with ACI Device through USB serial port.

As for how to use the ACI Host CLI Tool, please refer to ACI Host CLI Tool.

CFU Download Tool

The CFU Download Tool is used to upgrade the firmware of Realtek’s chips that adhere to the CFU protocol.

As for how to use the CFU Download Tool, please refer to its user guide in the \tool\CFUDownloadTool-vx.x.x.x directory.

OTA Dongle Tool

The OTA Dongle Tool is used for downloading OTA images in the OTA tooling board to follow the SPP OTA procedure for Realtek Audio chips. The tool also supports controlling the OTA tooling board for SPP connection, force engagement, and SPP OTA testing.

As for how to use the OTA Dongle Tool, please refer to its user guide in the \tool\OtaDongleTool-vx.x.x.x directory.