以SMMUv2为例，使用Trace32可视化操作SMMU的常用命令详解

Trace32支持一系列的SMMU命令，可以帮助用户更好地配置、查看和分析SMMU。换句话说，就是让SMMU的配置变得可视化。
在添加SMMU实例之前，需要选择一个CPU来激活该SMMU实例的相关命令。Trace32让SMMU的配置可视化的本质是，操纵CPU读取SMMU的寄存器，然后进行解码显示。
下面的代码是一个最基本的示例，先选择CPU type，然后添加SMMU实例：

SYStem.CPU CortexA53 ;for example, the ‘CortexA53’ CPU is SMMU-capable
SMMU.ADD ... ;you can now define an SMMU, e.g. an SMMU for a graphics processing unit (GPU)

当然也有一些SOC CPU将SMMU预定义成了一个组件，可以直接在SYStem.CONFIG窗口里看见。
Trace32支持MMU-400, MMU-401 ，MMU-500 和 MMU-600，其中MMU-500指的是ARM SMMU架构第二代，简称SMMUv2，MMU-600指的是ARM SMMU架构第三代，简称SMMUv3。
Trace32的SMMU 相关命令带来的最大好处是，将SMMU的配置可视化，其中包括：
- SMMU相关配置寄存器，总结起来有三大部分：Stream mapping table相关寄存器；TCU相关寄存器（global）；Context Bank相关寄存器。
- Pagetable的可视化，其中包括dump和list
- Stream mapping table的可视化。
下面我们以SMMUv2为例，解释Trace32 SMMU相关指令的用法。让Trace32显示SMMU的stream mapping table（或称Stream table），是一个最基本的做法，并且可以通过这个stream table打开SMMU其他配置功能窗口。
在这里插入图片描述

A 为stream table的完整窗口.
B Each row stands for a stream map register group (SMRG). 比如在SMMUv2中的Stream mapping table里，最多支持128个entry，也就是SMR和S2CR等寄存器有128个，即reg.grp index可以是从0x0到0x7F。
C Index of a translation context bank. 通过S2CR寄存器可以指定当前这个stream entry指定的是哪个CB.
D Data from stream matching registers. 这部分信息来自SMR寄存器，通过这个寄存器可以知道传入的stream id是否 match该entry。

下面笔者将总结Trace32常用的SMMU指令。

Trace32常用的SMMU指令

一，SMMU实例创建： SMMU.ADD
- <name>
- <smmu_type>
- <base_address>
二，SMMU实例删除：SMMU.Clear <name> 和 SMMU.RESet
三，SMMU 寄存器可视化：SMMU.Register
- SMMU.Register.Global
- SMMU.Register.ContextBank
- SMMU.Register.StreamMapRegGrp
四，SMMU pagetable的可视化：SMMU.StreamMapRegGrp
- SMMU.StreamMapRegGrp.ContextReg
- SMMU.StreamMapRegGrp.Dump 和 SMMU.StreamMapRegGrp.list
五，SMMU.StreamTable 或者 SMMU.StreamMapTable
- stream matching的硬件逻辑
- Trace32 stream matching 函数：SMMU.StreamID2SMRG()
- Stream Table窗口显示字段详解
六，SMMU Global Faults 或者 Global Errors 的显示

一，SMMU实例创建： SMMU.ADD

用于定义一个新的SMMU实例，Trace32最多支持添加20个SMMU 实例，

Format: SMMU.ADD "<name>" <smmu_type> <base_address>

它需要传入三个参数：

为SMMU实例设置一个独一无二的名字是必须的，名字不能超过9个字符长度，并且需要用双引号括起来，但是这只针对于SMMU.ADD指令，在执行完SMMU.ADD后，之后对该实例操作的SMMU指令不需要使用双引号。

<smmu_type>

用于指定SMMU的类型：<smmu_type>: MMU400 | MMU401 | MMU500 | MMU600

<base_address>

这是SMMU寄存器空间的基址，如果SMMU支持secure和non-secure两种安全状态，那么我们可以在这个基址前加上访问类型的修饰符，比如表示以CPU secure状态下去访问，可以用AZSD: 或者 ZSD:，以CPU non-secure去访问，则使用 NSD:, NUD:, HD:。需要注意的是Trace32访问SMMU空间，是以CPU为主体进行访问的，所以访问类型不可以是AXI这种。

以下是一个具体的使用实例：

;define a new SMMU named "myGPU" for a graphics processing unit
SMMU.ADD "myGPU" MMU500 AZSD:0x50000000
;display the stream table of the SMMU named “myGPU”
SMMU.StreamTable myGPU

二，SMMU实例删除：SMMU.Clear 和 SMMU.RESet

clear 和reset都可以删除之前用SMMU.ADD创建的SMMU实例，不同的是，clear只能删除指定的那一个，而reset可以删除所有的实例。

三，SMMU 寄存器可视化：SMMU.Register

通过Trace32的 SMMU.Register指令，可以可视化SMMU里最主要的三部分寄存器：

TCU部分，也就是Global部分，用于控制全局的SMMU配置。
CB部分，用于配置Context bank相关的寄存器。
SMR部分，主要用于stream matching，包括SMR和S2CR。

这三部分寄存器的内容都可以通过Trace32命令显示出来。

SMMU.Register.Global

用于显示SMMU global寄存器，用法如下：

SMMU.Register.Global <name>

在这里插入图片描述

SMMU.Register.ContextBank

用于显示CB相关的寄存器，需要指定CB的index，MMU-400, MMU-401 and MMU-500 only.
用法如下：

SMMU.Register.ContextBank <name> <cbndx>
SMMU.Register.ContextBank myGPU 0x16

在这里插入图片描述

SMMU.Register.StreamMapRegGrp

关于Stream mapping，也有两个关键寄存器SMR和S2CR，需要指定Stream table entry的index，MMU-400, MMU-401 and MMU-500 only.
用法如下：

SMMU.StreamMapRegGrp.Register myGPU 0x06

在这里插入图片描述
除了使用相关命令之外，还可以在打开的Streamtable窗口下，选中指定的Stream table entry后，直接右键打开菜单进行操作：

四，SMMU pagetable的可视化：SMMU.StreamMapRegGrp

通过SMMU.StreamMapRegGrp命令可以打开SMMU指定SMR index的pagetable。
我们先捋一下逻辑，如下图所示，一笔带有stream ID的transaction进入SMMU，首先在stream mapping table里进行stream matching，它会遍历SMT里的所有SMR，逐一进行匹配，匹配成功后，比如匹配上SMR0，再通过S2CR0寄存器里先前指定好的CBNDX，选择CB，而pagetable的基址就保存在CB的TTBR里。所以通过传入SMR的index来可视化pagetable的本质是：读取对应S2CR寄存器找到指定的CB，再从该CB里找到pagetable的基址进行解码。
在这里插入图片描述
SMMU.StreamMapRegGrp指令有三个选项：

SMMU.StreamMapRegGrp.ContextReg， Shows the registers of the context bank associated with the stage 1 and/or stage 2 translation.
SMMU.StreamMapRegGrp.Dump Dumps the page table associated with the stage 1 and/or stage 2 translation page wise.
SMMU.StreamMapRegGrp.list Lists the page table entries associated with the stage 1 and/or stage 2 translation in a compact format.

SMMU.StreamMapRegGrp.ContextReg

SMMU.StreamMapRegGrp.ContextReg和SMMU.Register.ContextBank 这两个指令都可以将CB的配置寄存器显示出来，但是也有一点不同：

SMMU.Register.ContextBank 传入的参数是 CBNDX，CB的index，直接指定CB进行显示。
SMMU.StreamMapRegGrp.ContextReg 传入的参数是 SMRG_INDEX, stream table entry的index，正如我上文提到过，通过 SMRG_INDEX找到S2CR，然后读取对应S2CR寄存器找到指定的CB，属于间接访问，并且还可以增加 /IntermediatePT 选项，来选择显示 stage1 还是 stage2的CB。

SMMU.StreamMapRegGrp.Dump 和 SMMU.StreamMapRegGrp.list

SMMU.StreamMapRegGrp.Dump 和 SMMU.StreamMapRegGrp.list这两个指令，传入smrg_index参数用来选择stream table entry，并将该entry里指定的CB 的pagetable解码出来。

Format: SMMU.StreamMapRegGrp.Dump <args>
<args>: <name> <smrg_index> [<address> | <range> [<ttb_address>]] [/<option>]Format: SMMU.StreamMapRegGrp.list <args>
<args>: <name> <smrg_index> [<address> | <range> [<ttb_address>]] [/IntermediatePT]

SMMU.StreamMapRegGrp.Dump命令需要指定SMMU实例的名字以及Stream mapping table的index。如果没有指定地址或者范围，默认是dump所有的内容。其中还可以指定ttb_address，也就是Pagetable 的基址，如果没有指定，那就从SMRG中抽取。intermediatePT 选项主要用于Stage2，对于stage1，它将被忽略。
在这里插入图片描述

SMMU.StreamMapRegGrp.Dump myGPU 0x0C

也可以直接右键打开list和dump窗口：
在这里插入图片描述

以下是smmu Pagetable dump窗口显示出的个字段释义：

五，SMMU.StreamTable 或者 SMMU.StreamMapTable

SMMU.StreamTable 或者 SMMU.StreamMapTable，二者是等同的，

Format: SMMU.StreamTable <args>
SMMU.StreamMapTable <args> (as an alias)
<args>: <name> [/StreamID <value>]
(for MMU-400, MMU-401 and MMU-500)

SMMU.StreamTable命令可以传入 StreamID到Stream table里进行匹配，Trace32的Stream ID匹配逻辑是模拟真实的SMMU硬件逻辑做的。原理就是将该StreamID与所有StreamTable SMR寄存器里的ID和mask进行匹配，如果匹配成功，则会高亮该Stream table entry。
在这里插入图片描述

;define a new SMMU named "myGPU" for a graphics processing unit
SMMU.ADD "myGPU" MMU500 AZSD:0x50000000
;open the window and highlight the matching SMRG in yellow
SMMU.StreamTable myGPU /StreamID 0x324A

在这里插入图片描述

stream matching的硬件逻辑

这里简单介绍一下stream matching的硬件逻辑，stream ID的匹配主要是根据 SMR寄存器里的三个字段：valid，id 和mask进行的。valid为1，说明该stream table entry有效，可以进行stream matching。比如传入的stream ID为0x324A ，SMR.id = 0x24A, SMR.mask=0x7000，匹配是否会成功？
首先看 mask 字段，0x7000 = 0y0111_0000_0000_0000，这说明传入的streamID的第12,13,14三个bit不会参与stream matching，换言之，这三个bit会被忽略，stream ID 0x324A 将这三个bit忽略后，变成0x24A，与SMR.id = 0x24A相同，所以匹配成功。
在这里插入图片描述

Trace32 stream matching 函数：SMMU.StreamID2SMRG()

Trace32提供了一个 stream matching 函数：SMMU.StreamID2SMRG(name, stream_id)，通过传入SMMU实例的名字，以及需要匹配的stream ID，来查找是否有匹配成功的stream table entry。

SMMU.StreamID2SMRG()的返回值有三种情况：

没有匹配上，返回 -1
匹配上了多个SMT entry，返回 -2
有且只匹配上了一个，返回对应entry的index，比如有128个entry，那么返回值在0到127之间。

使用示例：

;open the window and highlight the matching SMRG in yellow
SMMU.StreamMapTable myGPU /StreamID 0x3464
;return the index of the SMRG as a decimal value
&index=SMMU.StreamID2SMRG("myGPU",0x3464)
;print the index as hex and decimal to the AREA window
PRINT "hex: 0x" CONVert.INTTOHEX(&index) " decimal: &index"
AREA.view

在这里插入图片描述

Stream Table窗口显示字段详解

在这里插入图片描述

六，SMMU Global Faults 或者 Global Errors 的显示

如下图所示，Trace32的SMMU.StreamTable窗口可以显示 SMMU的 Global faults，其原理就是解码SMMU_sGFSR寄存器，该寄存器里保存着各种Global faults的状态信息。
SMMU.StreamID2SMRG()
关于 CB的错误信息，SMMU.StreamTable窗口里也有显示，在state列中以一个红色字母，比如 F，M或者S显示：