转自公众号：香山开源处理器
http://mp.weixin.qq.com/s?__biz=Mzg5MTY4MjgyNg==&mid=2247486452&idx=1&sn=05aa8f0d81094f36ab3d6d93c206220d
欢迎来到我们的香山技术沙龙系列，我们会分享香山开发技术科普、以及香山设计介绍，亦或邀请行业大佬分享经验等等。希望与大家共同学习，一起进步。欢迎大家通过公众号留言的方式与我们交流！
在往期文章中，我们介绍了基于香山（南湖）处理器核的 FPGA 开源最小系统构建。本期文章我们将介绍如何在该 FPGA 系统上使用 OpenOCD 和 GDB 进行程序调试，作者为香山团队的王洋、胡钰、秦少青、杨云枫。
欢迎大家试用相关流程，如遇到问题可及时与我们反馈，我们将尽力解决。受微信公众号规则限制，我们可能无法及时同步本文档的最新修改，最新版请以香山文档（阅读原文链接）为准。
1. 安装J-Link (SEGGER公司开发的JTAG仿真器)
1.1 安装J-Link软件包
1）下载deb包 https://www.segger.com/downloads/jlink/
2） sudo dpkg -i JLink_Linux_V750a_x86_64.deb
3） 检测有没有安装上：找到路径 /opt/SEGGER/JLink/ ；终端执行JLinkExe，能进入则成功。
1.2 引出JTAG信号
香山FPGA最小系统的工程已经引出了CPU JTAG的相关信号，如果要用到自己FPGA平台的外设还需要修改对应的约束文件(https://github.com/OpenXiangShan/env-scripts/blob/main/xs_nanhu_fpga/src/constr/xiangshan.xdc)，用来配合自己的FPGA环境。
与JTAG相关的约束，如果和我们的环境不同，需要按照自己的环境进行修改。
set_property PACKAGE_PIN F54 [get_ports JTAG_TCK]
set_property PACKAGE_PIN A54 [get_ports JTAG_TMS]
set_property PACKAGE_PIN H54 [get_ports JTAG_TDI]
set_property PACKAGE_PIN C54 [get_ports JTAG_TDO]
set_property PACKAGE_PIN G54 [get_ports JTAG_TRSTn]
set_property IOSTANDARD LVCMOS18 [get_ports JTAG_TCK]
set_property IOSTANDARD LVCMOS18 [get_ports JTAG_TMS]
set_property IOSTANDARD LVCMOS18 [get_ports JTAG_TDI]
set_property IOSTANDARD LVCMOS18 [get_ports JTAG_TDO]
set_property IOSTANDARD LVCMOS18 [get_ports JTAG_TRSTn]2. 安装OpenOCD软件
2.1 下载OpenOCD 源码仓库
链接：https://github.com/wxjstz/riscv-openocd.git
切换到riscv 分支, 当前HEAD: a50b28055 (origin/riscv, origin/HEAD, riscv) Properly track selecting multiple harts at once. (#743)
git clone https://github.com/wxjstz/riscv-openocd.git
git checkout -b riscv origin/riscv2.2 搭建OpenOCD源码编译环境
? 帮助信息: openocd-config-help.txt:
https://raw.githubusercontent.com/OpenXiangShan/XiangShan-doc/main/docs/integration/resources/openocd-config-help.txt
? 安装编译环境需要的依赖包
? make
? libtool
? libusb-1.0-0-dev
? pkg-config >= 0.23 (or compatible)
? Additionally, for building from git:
? autoconf >= 2.69
? automake >= 1.14
? texinfo >= 5.0
? 生成编译配置文件并执行
./bootstrap
./configure --prefix=<OpenOCD源码文件夹路径>/riscv-openocd/openocd-bin --enable-verbose --enable-verbose-usb-io --enable-verbose-usb-comms --enable-remote-bitbang --enable-ftdi --disable-werror # 必须要加上--disable-werror, 否则之后的源码编译会因为警告而失败2.3 编译OpenOCD源码
make
make install此时可以在<OpenOCD源码文件夹路径>/riscv-openocd/openocd-bin/中看到可执行文件openocd:
root@:~/src/riscv-openocd> ll openocd-bin/bin/
total 19M
drwxrwxr-x 2 root root 4.0K 1月 19 15:34 ./
drwxrwxr-x 4 root root 4.0K 1月 17 12:46 ../
-rwxr-xr-x 1 root root 19M 1月 19 15:34 openocd*
root@:~/src/riscv-openocd>
3、使用指导
https://openocd.org/doc/html/index.html
https://openocd.org/doc/doxygen/html/index.html
遇到问题1：使能--enable-ftdi 如下问题
configure: error: libusb-1.x is required for the MPSSE mode of FTDI based devices
解决办法：
sudo apt install libusb-1.0-0-dev3.1 烧写支持JTAG功能的硬件镜像
生产硬件连接正确的bit，并确保外部连线正确
3.2 启动OpenOCD (记得传入运行时配置脚本作为参数)
南湖双核版: xs-jlink.config.dualcore.txt:
https://raw.githubusercontent.com/OpenXiangShan/XiangShan-doc/main/docs/integration/resources/xs-jlink.config.dualcore.txt
./openocd-bin/bin/openocd -f ./xs-jlink.config.dualcore.txt3.3 创建并编译测试用小程序
创建c代码文件: hello.c
char buf[0x100];
int main(void)
{
int f = 0x33;
asm volatile("nop");
asm volatile("li s0, 0x0");
asm volatile("li sp, 0x80000100");
asm volatile("addi sp, sp, -32");
asm volatile("sd s0, 24(sp)");
asm volatile("addi s0, sp, 32");
asm volatile("nop");
asm volatile("nop");
asm volatile("j .");
asm volatile("nop");
f++;
asm volatile("nop");
while(f){}
asm volatile("nop");
asm volatile("nop");
asm volatile("nop");
asm volatile("nop");
while(1){}
return 0;
}
创建链接脚本: hello.lds
OUTPUT_ARCH( "riscv" )
SECTIONS
{
. = 0x80000000;
.text : { *(.text) }
. = 0x80000400;
.data : { *(.data) }
}
编译
riscv64-unknown-linux-gnu-gcc -g -O0 -o hello.o -c hello.c # 生成目标文件
riscv64-unknown-linux-gnu-gcc -g -Og -T hello.lds -nostartfiles -o hello.elf hello.o # 生成elf可执行文件至此用于加载的测试程序文件hello.elf已经生成好了, 之后可以用GDB命令(load hello.elf)加载到DDR内存中指定位置进行测试, 此外也请将hello.c文件拷贝到GDB工作文件夹中, 以便后续的单步调试可以显示C代码信息.
涉及到写8字节数据，需修改编译参数：
如下代码13行
#define REG32(addr) (*(volatile unsigned long*)(unsigned long)(addr))
#define read_csr(reg) ({unsigned long __tmp; \
asm volatile("csrr %0, "#reg : "=r"(__tmp)); \
__tmp;})
#define write_csr(reg, val)({ \
asm volatile("csrw "#reg ", %0" :: "rK"(val)); })
int main(void)
{
unsigned long pmp = 0;
int data = 0, i = 0;
write_csr(0x7c0, 0x80b080f08000000UL);
// pmp = read_csr(0x7c0);
data = 1;
for(i = 0; i < 1000; i++)
data++;
return 0;
}
对应编译参数如下：
riscv64-unknown-elf-gcc -g -MMD -MP -Wall -Werror -D__NO_INLINE__ -mcmodel=medany -O2 -std=gnu99 -Wno-unused -Wno-attributes -fno-delete-null-pointer-checks -fno-PIE -march=rv64imac -mabi=lp64 -fno-stack-protector -U_FORTIFY_SOURCE -g -c hello.c
riscv64-unknown-elf-gcc -g -Wl,--build-id=none -nostartfiles -nostdlib -static -march=rv64imac -mabi=lp64 -fno-stack-protector -o hello hello.o -g -lgcc -Wl,--defsym=MEM_START=0x80000000,-T,./hello.lds
riscv64-linux-gnu-objdump -l -S hello > he.lst3.4 启动GDB (client)
source /home/tools/scripts/env.sh # 添加工具链路径到环境变量$PATH中
riscv64-unknown-linux-gnu-gdb # 在这里可以根据需要决定是否添加参数 "./hello.elf" 添加后会在后面的单步调试时显示对应c代码的信息? 注: 如果启动gdb时遇到找不到libpython2.7.so.1.0的错误, 可尝试安装以下包解决:
sudo apt-get install libpython2.7
sudo apt-get install libatlas3-base进入GDB命令行后, 使用以下命令连接CPU core
target remote:3333 # 这里连接的是core 0 ,如果想连接core 1, 请另运行一个GDB程序, 3333改成3334至此可以调试了。
3.5 GDB常用命令
加载bbl,24M，大约加载8min
(gdb) load gdbload/bbl
Loading section .text, size 0x360 lma 0x80000000
Loading section .text, size 0x67b4 lma 0x80000360
Loading section .rodata, size 0xee5 lma 0x80006b18
Loading section .htif, size 0x10 lma 0x80008000
Loading section .data, size 0x1f13 lma 0x80009000
Loading section .sdata, size 0x4 lma 0x8000af14
Loading section .payload, size 0x19a lma 0x80025000
Start address 0x0000000080000000, load size 39610
Transfer rate: 48 KB/sec, 4951 bytes/write.
(gdb) i r pc
pc 0x800000000x80000000
(gdb) si
[riscv.cpu.0] writing 0x4000b0c3 to register dcsr
[riscv.cpu.0] writing 0xffffffe05911a920 to register s0
[riscv.cpu.0] writing 0x1715314d1d7a4 to register s1
Program received signal SIGINT, Interrupt.
0x0000000080000220 in ?? ()
(gdb) i r pc
pc 0x800002200x80000220
(gdb) x /20i 0x80000000
0x80000000: j 0x80000220
0x80000004: csrrw sp,mscratch,sp
0x80000008: beqz sp,0x800001e0
0x8000000c: sd a0,80(sp)
0x80000010: sd a1,88(sp)
0x80000014: csrr a1,mcause
0x80000018: bgez a1,0x800000bc
0x8000001c: slli a1,a1,0x1
0x80000020: li a0,14
...
0x00000000800022d8 in ?? ()
(gdb) i r sp
sp 0x8000cdc00x8000cdc0
(gdb) x /20i 0x80000310
0x80000310: j 0x800022d8
0x80000314: li a2,8
0x80000318: csrw mie,a2
0x8000031c: wfi
0x80000320: auipc a4,0x14
0x80000324: addi a4,a4,-800
0x80000328: ld a4,0(a4)
0x8000032c: beqz a4,0x8000031c
0x80000330: auipc a4,0x14
0x80000334: addi a4,a4,-808
0x80000338: ld a4,0(a4)
0x8000033c: srl a4,a4,a3
0x80000340: andi a4,a4,1
0x80000344: bnez a4,0x8000031c
0x80000348: fence
0x8000034c: li a2,8
0x80000350: bgeu a3,a2,0x80000358
0x80000354: j 0x8000243a
0x80000358: wfi
0x8000035c: j 加载被调试程序到DDR中, 同时读取程序的符号信息
load hello.elf读取并显示有CPU寄存器值
i registers读pc寄存器
i r pc修改pc寄存器, 使其指向地址0x8000000e
set var $pc=0x8000000e读取DDR指定区域指令或数据 (help x可以看更多帮助信息)
x /20i 0x80000000 # 读取20条指令, 用汇编语言显示
x /10xb 0x80000000 # 读取10字节数据, 用十六进制显示
x /10cb 0x80000000 # 读取10字节数据, 用十进制及ASCII码显示
x /10xh 0x80000000 # 读取10个双字节数据, 用十六进制显示
x /10xw 0x80000000 # 读取10个四字节数据, 用十六进制显示
x /20xg 0x80000000 # 读取20个八字节数据, 用十六进制显示
x /20i $pc-14写入DDR指定区域
set {char}0x80000000=0x11 # char类型是写入一个字节
set {short}0x80000000=0x2222 # short类型是写入两个字节
set {int}0x80000000=0x44444444 # int类型是写入四个字节
set {long}0x80000000=0x8888888888888888 # long类型是八个字节
x/4g 0x80000000 # 查看上述结果单步执行指令
n # 或者si在指定内存地址上设置软件断点
b * 0x80000020清除指定地址上的软件断点
clear * 0x80000020从当前位置继续执行程序
c3.6 gdb读取csr指令
(gdb) i r satp
satp 0x0 0
(gdb) i r mcause
mcause 0x9 9
(gdb) i r scause
scause 0x8000000000000005 -9223372036854775803
openocd使用手册 https://openocd.org/doc/pdf/openocd.pdf
作者：王洋、胡钰、秦少青、杨云枫
编辑：林志达、徐易难、李贤飞
我们已开启公众号文章留言及自动精选公开功能，欢迎大家在文章下方留言交流。
受微信公众号规则限制，我们可能无法及时同步本文档的最新修改，最新版请以香山文档（点击下方“阅读原文”链接）为准。