1@page trace trace
2
3[更正文档](https://gitee.com/alios-things/trace/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6
7SystemView 是一个用于分析嵌入式系统性能的trace工具。SystemView可以分析系统中有哪些中断、任务执行了，以及它们的先后关系。 可以完整的深入观察一个应用程序运行时的行为，它揭示了在任务运行中发生了什么，哪个中断触发了任务切换，中断和任务调用了哪个底层系统的API函数。SystemView 不但可以实时分析和展示数据，而且可以帮助用户进行系统调试和问题诊断，尤其是在开发和处理具有多个任务的复杂系统时。
8
9SystemView 由两个部分组成：
10
11SystemView 嵌入式端程序：用于记录嵌入式系统的行为，通过实时传输(Real Time Transfer, RTT)技术将记录的数据通过J-link工具传输到PC机上。
12
13SystemView PC端程序：用于收集目标板上传的数据信息，并在不同的窗口中显示这些信息。这些记录可以保存到文件中，用于以后的分析。
14
15## 版权信息
16
17> Apache license v2.0
18
19## 目录结构
20
21```tree
22├── Config
23│   ├── Global.h                             # Global 数据类型定义
24│   ├── SEGGER_RTT_Conf.h                    # SYSTEMVIEW RTT配置文件
25│   ├── SEGGER_SYSVIEW_AliOSThings.c         # SYSTEMVIEW AliOSThings 适配代码
26│   ├── SEGGER_SYSVIEW_Conf.h                # SYSTEMVIEW配置文件
27│   ├── SEGGER_SYSVIEW_Config_AliOSThings.c  # SYSTEMVIEW AliOSThings 相关配置
28│   └── SYSVIEW_AliOSThings.txt              # SEGGER SYSTEMVIEW PC端配置文件
29├── SEGGER
30│   ├── SEGGER.h
31|   ├── SEGGER_RTT.c                         # SEGGER RTT 模块源代码
32|   ├── SEGGER_RTT.h                         # SEGGER RTT 模块头文件
33|   ├── SEGGER_SYSVIEW.c                     #  SEGGER SYSTEMVIEW 模块源代码
34|   ├── SEGGER_SYSVIEW.h                     # SEGGER SYSTEMVIEW 模块头文件
35|   ├── SEGGER_SYSVIEW_ConfDefaults.h        # SEGGER SYSTEMVIEW 默认配置头文件
36|   ├── SEGGER_SYSVIEW_Int.h                 # SEGGER SYSTEMVIEW 内部头文件
37|   ├── SEGGER_RTT_printf.c                  # SEGGER RTT 模块 printf 源代码
38│   └── SEGGER_RTT_ASM_ARMv7M.S              # 针对Cotex-M 优化RTT模块
39├── k_trace.c                                # 核心逻辑代码
40├── uart_send.c                              # 用串口传输数据的示例代码
41├── README.md                                # 说明文档
42└── package.yaml                             # 编译配置文件
43```
44
45## 依赖组件
46
47* 无
48
49# 常用配置
50
51系统中相关配置已有默认值，如需修改配置，统一在package.yaml中**def_config**节点修改，具体如下：
52
53> RTT 缓存大小，默认1024,  可修改为4096，修改yaml配置如下：
54
55```yaml
56def_config:
57     SEGGER_SYSVIEW_RTT_BUFFER_SIZE: 4096
58```
59
60更多配置可以参考[SystemView用户手册](https://www.segger.com/downloads/free-utilities/UM08027) 第4.5章 Generic configuration
61
62# API说明
63
64使用 SEGGER_SYSVIEW_PrintfTarget  API通过J-link打印log 信息到时序图和Terminal窗口。
65
66```sh
67void SEGGER_SYSVIEW_PrintfTarget(const char *s, ...);
68```
69
70例子：SEGGER_SYSVIEW_PrintfTarget("hello world! count %d \r\n", count);
71
72更多的API说明参考[SystemView用户手册](https://www.segger.com/downloads/free-utilities/UM08027) 第7章 API reference
73
74# 使用示例
75
76将HaaS100 SWDIO、SWCLK和地GND共3根线与J-Link仿真器连接。
77
78| HaaS引脚编号 | HaaS引脚说明 | J-link引脚说明 |J-link引脚编号 |
79| -------- | -------- | -------- |-------- |
80| 41     | SWCLK     | CLK     | 9     |
81| 42     | SWDIO     | TMS     | 7     |
82| 40     | GND     | GND     | 8     |
83
84
85硬件连接图：
86
87<div align=left display=flex>     <img src="https://img.alicdn.com/imgextra/i4/O1CN01RD9QyS1zD1zYKLKxv_!!6000000006679-2-tps-976-671.png" style="max-width:800px;" />
88</div>
89
90
91组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
92待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
93
94## 步骤1 创建或打开工程
95
96**打开已有工程**
97
98如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
99
100**创建新的工程**
101
102组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
103
104## 步骤2 添加组件
105
106案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
107
108```yaml
109depends:
110  - trace: master # helloworld_demo中引入trace组件
111```
112
113## 步骤3 下载组件
114
115在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
116
117```shell
118
119aos install trace
120
121```
122
123上述命令执行成功后，组件源码则被下载到了./components/trace路径中。
124
125## 步骤4 添加示例
126
127修改文件solutions/helloworld_demo/helloworld.c
128
129
130添加头文件
131```c
132#include "SEGGER_SYSVIEW.h"
133```
134将
135```c
136printf("hello world! count %d \r\n", count++);
137```
138改为；
139```c
140SEGGER_SYSVIEW_PrintfTarget("hello world! count %d \r\n", count++);
141```
142
143## 步骤5 编译固件
144
145在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
146
147## 步骤6 烧录固件
148
149helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
150
151## 步骤7 打开串口
152
153固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
154
155当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
156
157## 步骤8 测试示例
158
159**1 下载安装SystemView**
160[SystemView下载地址](www.segger.com/downloads/systemview)
161
162根据你所用的操作系统下载对应版本的SystemView，然后进行安装。
163
164**2 配置SystemView**
165
166拷贝components/trace/Config/SYSVIEW_AliOSThings.txt文件到PC机SystemView软件安装目录 C:\Program Files\SEGGER\SystemView\Description下。
167
168
169**3 打开SystemView PC软件**
170点击菜单栏Target打开 Recorder Configuration。
171
172<div align=left display=flex>     <img src="https://img.alicdn.com/imgextra/i2/O1CN01szknPD1ogNbBQBZEU_!!6000000005254-2-tps-488-266.png" style="max-width:800px;" />
173</div>
174
175参考下图配置参数信息，其中 Address 信息可以从开机串口log 中获取：
176例如开机串口log中显示：_SEGGER_RTT:0x34683a1c。
177
178<div align=left display=flex>     <img src="https://img.alicdn.com/imgextra/i3/O1CN01aiPYrd1Ij4DVZLR9h_!!6000000000928-2-tps-640-762.png" style="max-width:800px;" />
179</div>
180
181**4 开始采集**
182
183点击菜单栏Target打开 Start Recording
184
185<div align=left display=flex>     <img src="https://img.alicdn.com/imgextra/i2/O1CN01E4UIcZ24f2Hwl6Hco_!!6000000007417-2-tps-452-258.png" style="max-width:800px;" />
186</div>
187
188采集效果界面显示如下：
189
190<div align=left display=flex>     <img src="https://img.alicdn.com/imgextra/i3/O1CN01YKD6fE1Pg2uvaaGmx_!!6000000001869-2-tps-2826-1754.png" style="max-width:800px;" />
191</div>
192
193# 注意
194
195如果SystemView PC端软件提示overflow，可以通过修改package.yaml 文件增大设备端缓存大小。
196
197修改方式如下：
198
199def_config: 下添加一行
200     SEGGER_SYSVIEW_RTT_BUFFER_SIZE: 4096
201
202# FAQ
203
204无
205