README.md · microcolin/UltraLink

# UltraLink：迷你多功能调试器&离线下载器

![image-20220820212032105](_Images/20220820212032.png)

### 0. 功能概述

**UltraLink是基于CMSIS DAP设计的一款多功能调试下载器，特性如下：**

* 基于STM32F4高性能主控，168MHz主频，1MB内置Flash
* 支持高速Bootloader用于系统固件升级（可用于后续扩展更多APP和支持的芯片型号）
* 板载USB-HS PHY芯片，支持高速USB通信，且完全免驱即插即用
* 使用标准的CMSIS-DAP在线调试下载协议，兼容各种DAP-Link，支持Keil、支持基于OpenOCD的CLion、STM32CubeIDE、VS Code等各种IDE
* 支持大量Cortex-M系列芯片的离线固件下载，支持设置下载地址
* 板载64MB外置Flash芯片用于MSC设备，可以模拟U盘直接管理需要离线下载的固件文件
* 支持USB虚拟调试串口功能，支持超高波特率（921600）无丢包
* 搭载128x128的超高刷新率Sharp Memory LCD，120Hz的流畅，MLCD长时间显示不烧屏
* 3.5x3.4x1.0CM超小尺寸，全铝CNC+阳极氧化机身
* 搭载极致丝滑的MonoUI交互系统
* 持续集成更多扩展功能（电压表、逻辑分析仪、CAN调试器等）

### 1. 硬件说明

![](_Images/20220820230427.png)

| LED指示 | 状态 | 功能说明                  |
| ------- | ---- | ------------------------- |
| 红色    | 常亮 | 未连接电脑（或驱动错误）  |
| 蓝色    | 闪烁 | 下载器与MCU或者电脑通信中 |
| 蓝色    | 呼吸 | 已进入Bootloader模式      |
| 绿色    | 常亮 | 已连接电脑                |
| 白色    | 闪烁 | 串口接收到数据            |

#### 连接电脑

UltraLink通过USB TypeC数据线连接电脑后，会自动安装虚拟串口以及CMSIS-DAP驱动，Windows10以上系统完全免驱。

安装完成之后，打开电脑的文件管理器会看到识别出来的一个 **64MB** 大小的 **U盘设备** （可以自行重命名），通过该设备可以直接把**离线烧录的文件**和其他**配置文件**拖入U盘，来写入到UltraLink板载的Flash中。

![](_Images/20221207101623.png)

> 初次使用UltraLink会自动进行系统初始化，U盘目录下会建立一些系统文件夹， **请勿删除这些文件！** 
>
> **系统文件说明：**
>
> * **SETTING**：用于备份用户设置（未来会用到）
> * **SRC**：储存一些系统资源比如图片、metadata等
> * **LICENSE**：设备的授权文件，出厂会对设备进行激活，该文件和每台设备唯一绑定，因此建议收到机器后首先将此文件进行备份，以防止未来格式化磁盘后文件丢失。

此外打开设备管理器，可以在`端口（COM和LPT）`中看到多出来一个串口号，可以使用电脑上的各种串口调试工具打开该串口号进行调试，和其他USB转串口模块的使用是一样的。

> 设备管理器中还会在`通用串行总线设备`中识别出一个名为`UltraLink REF`的设备，这是预留的USB Bulk通信设备，用于实现更多高速USB通信应用，比如屏幕镜像APP和未来的一些其他应用。

#### 引脚说明

UltraLink有两排10Pin的排针，排针的引脚功能定义在屏幕的主界面有说明。

> 靠近屏幕的一排是`Row-1`，下面的一排是`Row-2`，`Row-1`和`Row-2`最左边的第一个引脚都是**Gnd**，对应于外壳上面的凹刻图标指示。

![](_Images/20220820231926.png)

### 2. 操作说明

第一次使用UltraLink时会进行操作指引，如果后续还想看到引导画面，请在设置中恢复出厂设置。

**具体操作逻辑非常简单：**

1. 滚动UltraLink右侧的滚轮，上下滚动用于切换选中条目，**短按压**为**确认**操作，**长按压**为**返回**操作。

上电默认进入的是`Home界面`：

![](_Images/20220820232451.png)

2. 短按滚轮为**确认**，在`Home界面`短按会进入`APP菜单界面`，上下滚动滚轮切换所需的APP功能：

![image-20220820232617060](_Images/20221207113409.png)

3. 在任意界面长按滚轮为`取消`或者`返回上一级页面`。

###  3. APP使用说明

#### 1. CMSIS-DAP在线下载&调试

UltraLink是一个扩展性非常强的多功能调试器，设备的每一项功能都作为一个**APP**。

其中**CMSIS-DAP调试器**功能是最特殊的APP，该APP无需开启，在任意APP功能页面下，UltraLlink都具备在线调试器功能。

也就是说UltraLink支持**同时运行**CMSIS-DAP的在线下载调试功能以及其他APP。

> **只有一个场景不能同时使用**，也就是当在使用离线下载功能进行固件下载过程中，此时SWD的IO是被离线下载功能占用的，因为不可能同时进行在线下载和离线下载。

![](_Images/20221207105047.png)

DAP在线下载调试功能使用的引脚是`SWCLK`和`SWDIO`，也就是标准的SWD接口。

> 设备也支持JTAG接口，不过该接口我用得比较少所以还没有大量测试。

UltraLink作为在线调试器的使用和ST-Link、J-Link等都一样。

**对于Keil**，只需要在项目设置中选择CMSIS-DAP即可：

![](_Images/snipaste20221215_183926.jpg)

对于STM32IDE、VS Code、CLion等使用OpenOCD调试的IDE，可以参考仓库中的 [2.配套软件/OpenOCD配置文件](https://gitee.com/referencez/ultralink/tree/master/2.配套软件/OpenOCD配置文件) ，修改`.cfg`文件中的接口为**cmsis-dap**即可。

> 不熟悉操作的同学可以搜索DapLink相关的教程，UltraLink的操作流程和方法是一样。

#### 2.离线固件下载

该功能用于脱机下载固件，也即**不需要连接电脑**即可给MCU烧写固件，很适合用于自制设备的量产烧写。

将需要下载的固件拖入UltraLink的U盘设备，**重启UltraLink**之后可以在`选择固件文件`中看到固件文件。

> 固件文件的文件名只能是英文，而且长度最好不大于32字符，建议只使用`字母`、`-`、`_`的组合。

![image-20221207105242740](_Images/20221207105257.png)

`选择芯片型号`用于设置对应的下载算法，默认内置了`STM32F1`、`STM32F4`、`STM32F7`等芯片，后续会持续扩展更多的芯片型号支持。大家有想要适配的芯片型号可以在本仓库的[Issues](https://gitee.com/referencez/ultralink/issues/I65G0H)里面提出，这边会根据实际情况适配。

> 更新支持芯片型号需要通过Bootloader更新UltraLink的固件来实现。

`设置下载地址`用于修改烧录的起始地址，该功能正常使用保持默认即可。对于一些需要配合Bootloader使用的固件可以通过该功能设置地址偏移。

> 一般Bootloader固件会放在芯片Flash最开始的启动地址，而实际应用代码会放在一个偏移地址，这样就能实现上电后首先进入BL，由BL判断是否进行一些特殊操作，或者直接跳转到APP地址。
>
> 因此用下载器这类应用烧写固件时，一般会烧录两次，一次在默认地址烧写BL，一次在偏移地址烧写APP。

`自动触发下载`用于开启或关闭连续固件下载功能，当不开启时，需要手动点击`开始下载`进行固件下载，当开启时，只需将光标移动到指示位置，然后把SWD引脚接触目标板卡，就会自动触发下载。用此方法可以快速连续下载多个板卡的固件，可以大幅提高批量下载的效率，很适合用于量产固件烧录。

`储存当前设置`可以将当前配置好的下载设置（芯片型号、下载地址）进行断电保存，下次上电就会加载该配置。

`擦除芯片`用于单独擦除整个目标芯片。

#### 3.USB转串口

UltraLink使用USB转串口来实现很多调试功能，**在不同界面下串口的功能可能有所不同**。

在Home界面下，UltraLink支持**标准USB转串口**功能，也就是说当用串口调试助手对UltraLink识别出来的COM口进行数据发送时，数据会被发送到设备的`Tx`引脚，反之，`Rx`引脚接收到的数据会被发送到USB虚拟COM口号上。

> 支持设置常用波特率：9600、14400、19200、38400、56000、57600、115200、128000、256000、460800、512000、750000、921600

![image-20221207104212737](_Images/20221207105054.png)

![image-20221207104307325](_Images/20221207105059.png)

#### 4.CAN转串口调试

该APP为一个方便的CAN调试功能，无需安装三方软件，直接通过串口调试助手即可以调试CAN，非常方便。

> 由于该功能会占用USB串口号，因此进入该APP之后默认的**标准USB转串口**功能会失效。

![image-20221207111125687](_Images/20221207111125.png)

进入APP后可以看到显示的UltraLink本机的CAN节点地址，目前只支持标准ID，也即**0x000~0x7FF**，默认地址是`0x7FF`，可以通过滚轮进行修改，**修改实时生效**。

向下滚动滚轮直到黑色条处显示`Baud`则进入了设置波特率功能，此时短按滚轮可以在不同波特率之间进行切换，**修改实时生效**。

在Baud界面再次向下滚动滚轮会显示`Exit`，此时短按滚轮确认可以退出APP。

> 任意界面长按滚轮都会跳转到Exit界面，再次短按即可退出。

![](_Images/20221207111204.png)

在该APP开启后，打开串口调试助手，当`CAN-H`和`CAN-L`引脚有数据接收时，串口助手会打印出接收到的CAN消息，包括消息节点的ID以及数据。

而当使用串口助手发送格式形如 `12 33 67 78 99`格式的字符串数据时，也会通过`CAN-H`和`CAN-L`引脚把数据转发给CAN总线。

> 注意发送的数据为16进制格式，每次可以是1~8个字节，比如上面的例子中是发送5个字节。

使用串口协议的好处是使用直观，不依赖其他软件，而且大家也可以根据需要自己写代码调用COM口进行协议自定义，比如可以用PySerial写一个脚本来收发自定义格式的CAN数据。

**v3.7**之后的版本固件初步增加了对于CAN调试APP的扩展帧ID支持，无需在下载器上设置，直接串口输入指令即可修改参数，比如：

* 输入指令`#SET_MODE 0`或者`#SET_MODE 1`来切换标准帧和扩展帧

* 输入指令`#SET_ID 12345`来设置ID为0x12345

> 注意指令需要加换行。

#### 5. 简易电压表

该功能用于进行电压测量，支持的测量范围为**0~20V**，测量过程会同时显示电压波形数据。

> 由于UltraLink的控制器芯片IO电平为3.3V，因此除了指示的ADC引脚之外，**别的引脚接入高压都可能导致芯片烧毁**，请务必注意不要接错测量引脚。

![image-20221207111445041](_Images/20221207111453.png)

#### 6. 简易逻辑分析仪

该功能用于进行简易的数字波形采集以及协议分析，具备**4通道采集**功能，需要配合上位机软件**PulseView定制版**使用。

由于SRAM限制，UltraLink的采集参数为：

* 采样深度最大**10.24k**
* 采样率可以设置为**20KHz~5MHz**，此时支持**4通道采集**
* 采样率可以设置为**20MHz**，此时支持**2通道采集**

> 采样参数的配置完全依靠上位机操作，UltraLink上无需任何配置，但是会显示当前的参数。
>

![image-20221207111543972](_Images/20221207111544.png)

由于芯片的SRAM大小限制采样深度，因此本设备只适合用于简易场景的逻辑分析，并不能替代专业分析仪。很常用的场景是分析一些总线协议，或者进行波形时间测量。

我个人需要逻辑分析仪的一个常用场景是：想测量一段代码的执行时间，但是代码执行的频率很高，用printf打印时间戳的方式不可行，那么可以用逻辑分析仪检测IO电平反转时间来准确得到时间间隔。

> 大家可能经常用printf打印一些调试数据，但是实际上printf本身的执行时间是很长的（接近ms级别），因此如果测量的代码执行时间很短，那么printf其实完全不可用；此外printf的实现方式也导致其效率差别很大（阻塞输出、DMA输出等）。
>
> 因此比如我在调试电机的时候，需要在每个PWM周期（20kHz）中执行一遍处理代码，我希望测出代码执行时间，那么显然printf是无法使用的；我可以用寄存器方式操作一个GPIO进行翻转，代码开始时置高电平，结束时置低电平，再使用逻辑分析仪测出波形，就可以精确地得到代码运行时间了。

上位机软件**PulseView定制版**安装方法，直接运行安装包即可。

再连接设备之前需要给UltraLink配置一下串口驱动，使用**Zadig**软件完成：

![image-20220821000642238](_Images/20220821000642.png)

List All Devices后，选择`UltraLink CMSIS-DAP (Interface 1)`设备，注意确认此时Driver栏显示的是`usbser`才是正确的设备号。

![image-20221207112515936](_Images/20221207112515.png)

点击下箭头选择`USB Serial (CDC)`，然后勾选上方的Edit框，把左边的名称改为`UltraLink VCP`，再点击`Upgrade Driver`即可，等待一分钟左右。

> 正确操作的话此时设备管理器中的串口设备名称以及变为`UltraLink VCP`。

![image-20221207112611603](_Images/20221207112611.png)

然后进入UltraLink的逻辑分析仪APP界面，再打开PulseView软件，依次点击：

![image-20220821001143048](_Images/20220821001143.png)

![image-20220821001211981](_Images/20220821001212.png)

即可连接设备。

> **注意此时UltraLink一定要是在DLA的APP页面下，否则上位机是识别不到设备的**。
>
> 如果在非DLA的界面下点击了Scan可能会卡住，那么需要先切换到DLA界面，再关闭PulseView重新进入一下即可。

连接后可以点击PulseView中的Run进行一次波形采集，也可以软件中设置不同采样深度和采样率。

![image-20221207112935731](_Images/20221207112935.png)

> 采样深度的意思是每次最多可以采样几个点，采样率的意思是采集的速度。
>
> 举个例子，以10K的采样深度，1MHz的采样率进行采样，那么就可以采集10K/1M=0.01s钟的波形。所以采样率越高对于信号的分析能力越强，但是过高的采样率会导致采样时间变短。
>
> 一般需要选取采样率为被测信号的最高频率5倍以上。

#### 其他APP

待持续更新。

> 参考资料：
>
> * [ARMmbed/DAPLink](https://github.com/ARMmbed/DAPLink)
> * [olikraus/u8g2: U8glib library for monochrome displays, version 2](https://github.com/olikraus/u8g2)
> * [opencv/opencv: Open Source Computer Vision Library](https://github.com/opencv/opencv)
> * [createskyblue/OpenT12: T12 Soldering Station](https://github.com/createskyblue/OpenT12)
> * [不咸不要钱](https://blog.csdn.net/weixin_42378319?type=blog)提供的Hex2Bin工具：[hex文件转bin文件小工具](https://blog.csdn.net/weixin_42378319/article/details/117628806)

microcolin/UltraLink

About

Releases

Contributors

Activities