分区表
partition_table（分区表）模块是一个编译脚本工具，用于解析分区表描述文件ptab.json，生成头文件ptab.h，ptab.h中包含了与分区信息相关的一系列宏定义，该头文件可被工程引用以获取分区信息。
分区表可以描述所有memory的地址规划，包括NOR Flash、NAND Flash、eMMC、TF卡、PSRAM和片内SRAM等。每个板子会有一个ptab.json，描述了该板子的分区信息，使用该板子编译的工程都遵循这个分区表定义的地址规划，
工程也可以使用自定义的ptab.json以覆盖板子的默认配置。
使能分区表
选中middleware中的Use partition table to manage all memory layout使能分区表功能
同时还需要在工程的Kconfig.proj中定义如下开关，所有示例工程的Kconfig.proj都已包含了这段代码
#APP specific configuration.
config CUSTOM_MEM_MAP
bool
select custom_mem_map
default y if !SOC_SIMULATOR
分区表格式
分区表描述文件ptab.json是一个json格式的文本文件，遵循json语法，可以使用任意文本编辑器编辑。分区表使用列表定义了系统中用到的所有memory，列表中每个元素对应一块memory，比如下面的示例中有flash5、psram1、flash4、hpsys_ram等memory，每个memory有如下属性：
mem：memory的名称base：memory的基地址，十六进制数值，需保证正确性regions：memory中的分区列表
regions定义了memory中有哪些分区，每个分区有如下属性：
offset：偏移，字节单位，十六进制max_size：大小，字节单位，十六进制tags：标签列表，列表中的名称用于生成相应的宏定义，用于表示分区大小和起始地址，比如tag为FLASH_BOOT_LOADER，生成的头文件会定义FLASH_BOOT_LOADER_START_ADDR、FLASH_BOOT_LOADER_OFFSET和FLASH_BOOT_LOADER_SIZE三个宏,START_ADDR由base加上offset的属性值得到，OFFSET等于offset属性值，SIZE等于max_size属性值ftab：flash table条目信息，可选img：本分区存放的镜像文件名，用于生成烧写脚本，可选exec：本分区上运行的程序名，可选custom：自定义宏字典，可选
ptab.json示例
[
{
"mem": "flash5",
"base": "0x1C000000",
"regions": [
{
"offset": "0x00020000",
"max_size": "0x00020000",
"tags": [
"FLASH_BOOT_LOADER"
],
"ftab": {
"name": "bootloader",
"address": [
"base",
"xip"
]
},
"img": "bootloader",
"exec": "bootloader"
}
]
},
{
"mem": "psram1",
"base": "0x60000000",
"regions": [
{
"offset": "0x00000000",
"max_size": "0x00200000",
"tags": [],
"ftab": {
"name": "main",
"address": [
"xip"
]
}
},
{
"offset": "0x00200000",
"max_size": "0x00200000",
"tags": [
"PSRAM_DATA"
]
},
]
},
{
"mem": "psram1_cbus",
"base": "0x10000000",
"regions": [
{
"offset": "0x00000000",
"max_size": "0x00200000",
"tags": [
"HCPU_FLASH_CODE"
],
"exec": "main"
}
]
},
{
"mem": "flash4",
"base": "0x18000000",
"regions": [
{
"offset": "0x00000000",
"max_size": "0x00200000",
"tags": [
"HCPU_FLASH_CODE_LOAD_REGION"
],
"img": "main",
"ftab": {
"name": "main",
"address": [
"base"
]
}
},
{
"offset": "0x00200000",
"max_size": "0x00100000",
"tags": [
"FS_REGION"
]
}
]
},
{
"mem": "hpsys_ram",
"base": "0x20000000",
"regions": [
{
"offset": "0x00000000",
"max_size": "0x0006BC00",
"tags": [
"HCPU_RAM_DATA"
]
},
{
"offset": "0x0006BC00",
"max_size": "0x00014000",
"tags": [
"HCPU_RO_DATA"
]
},
]
}
]
属性详解
ftab
ftab属性定义了flash table中某一个条目的参数，以此生成flash table的描述文件ftab.c用于编译。flash table会影响程序的启动，因此需要确保正确填写ftab属性。ftab包含以下属性：
name：程序名称，bootloader表示二级bootloader，main表示主程序，dfu表示dfu程序，他们是系统预留的名称，不能随便使用，除此以外的名字可以由用户随意指定，如acpu_region1可以用来表示ACPU的代码分区address：地址类型列表，如果分区是用于存放程序的镜像文件，则填写"base"，如果程序运行在分区所在的memory上，则填写"xip"，如果两者都是（即存储地址与执行地址相同，程序可XIP执行（execution in place）），则需要同时填写"base"和"xip"
下面为flash5的一段描述，由代码可知，bootloader即二级bootloader存放于flash5中，地址段为0x1C020000~0x1C03FFFF，同时二级bootloader的代码也运行在flash5上，即XIP执行，
{
"mem": "flash5",
"base": "0x1C000000",
"regions": [
{
"offset": "0x00020000",
"max_size": "0x00020000",
"tags": [
"FLASH_BOOT_LOADER"
],
"ftab": {
"name": "bootloader",
"address": [
"base",
"xip"
]
},
"img": "bootloader",
"exec": "bootloader"
}
]
},
非系统预留的程序（即name不是main、bootloader和dfu）将依次使用flash table中以下条目描述flash中存放的镜像信息
DFU_FLASH_HCPU_EXT2： 11
DFU_FLASH_LCPU_EXT1： 12
DFU_FLASH_LCPU_EXT2： 13
例如下面这段ptab.json中定义了acpu_region1使用flash4的0x00300000偏移地址作为ACPU程序的base地址，hpsys_ram的0x00200000偏移地址作为ACPU程序的xip地址，生成的ftab.c文件使用DFU_FLASH_HCPU_EXT2项描述了ACPU程序镜像文件的存放和执行地址，length（需要搬移的数据长度）则由img属性（详细说明见img）指定的程序文件名按照实际文件大小填写（示例中实际长度为0x7d4字节）。
acpu_region1示例代码
{
"mem": "flash4",
"base": "0x18000000",
"regions": [
{
"offset": "0x00300000",
"max_size": "0x00010000",
"tags": [
"ACPU_CODE_LOAD_REGION1"
],
"img": "acpu",
"ftab": {
"name": "acpu_region1",
"address": [
"base"
]
}
}
]
},
{
"mem": "hpsys_ram",
"base": "0x20000000",
"regions": [
{
"offset": "0x00200000",
"max_size": "0x00020000",
"tags": [
"ACPU_CODE_REGION1_SBUS"
],
"ftab": {
"name": "acpu_region1",
"address": [
"xip"
]
}
}
]
},
下面是由以上的ptab.json示例代码生成的ftab.c文件的内容
1RT_USED const struct sec_configuration sec_config =
2{
3 .magic = SEC_CONFIG_MAGIC,
4 .ftab[0] = {.base = FLASH_TABLE_START_ADDR, .size = FLASH_TABLE_SIZE, .xip_base = 0, .flags = 0},
5 .ftab[1] = {.base = FLASH_CAL_TABLE_START_ADDR, .size = FLASH_CAL_TABLE_SIZE, .xip_base = 0, .flags = 0},
6 .ftab[3] = {.base = 0x1C020000, .size = 0x00020000, .xip_base = 0x1C020000, .flags = 0},
7 .ftab[4] = {.base = 0x18000000, .size = 0x00200000, .xip_base = 0x60000000, .flags = 0},
8 .ftab[5] = {.base = FLASH_BOOT_PATCH_START_ADDR, .size = FLASH_BOOT_PATCH_SIZE, .xip_base = BOOTLOADER_PATCH_CODE_ADDR, .flags = 0},
9 .ftab[7] = {.base = 0x1C020000, .size = 0x00020000, .xip_base = 0x1C020000, .flags = 0},
10 .ftab[8] = {.base = 0x18000000, .size = 0x00200000, .xip_base = 0x60000000, .flags = 0},
11 .ftab[9] = {.base = BOOTLOADER_PATCH_CODE_ADDR, .size = FLASH_BOOT_PATCH_SIZE, .xip_base = BOOTLOADER_PATCH_CODE_ADDR, .flags = 0},
12 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_HCPU)] = {.length = 0x000FB1F8, .blksize = 512, .flags = DFU_FLAG_AUTO},
13 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_LCPU)] = {.length = 0xFFFFFFFF},
14 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_BL)] = {.length = 0x80000, .blksize = 512, .flags = DFU_FLAG_AUTO},
15 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_BOOT)] = {.length = 0xFFFFFFFF},
16 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_LCPU2)] = {.length = 0xFFFFFFFF},
17 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_BCPU2)] = {.length = 0xFFFFFFFF},
18 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_HCPU2)] = {.length = 0xFFFFFFFF},
19 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_BOOT2)] = {.length = 0xFFFFFFFF},
20 .ftab[DFU_FLASH_HCPU_EXT2] = {.base = 0x18300000, .size = 0x00020000, .xip_base = 0x20200000, .flags = 0},
21 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_HCPU_EXT2)] = {.length = 0x000007D4, .blksize = 512, .flags = DFU_FLAG_AUTO},
22 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_LCPU_EXT1)] = {.length = 0xFFFFFFFF},
23 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_LCPU_EXT2)] = {.length = 0xFFFFFFFF},
24 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_RESERVED)] = {.length = 0xFFFFFFFF},
25 .imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_SINGLE)] = {.length = 0xFFFFFFFF},
26 .running_imgs[CORE_HCPU] = (struct image_header_enc *) &sec_config.imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_HCPU)],
27 .running_imgs[CORE_LCPU] = (struct image_header_enc *)0xFFFFFFFF,
28 .running_imgs[CORE_BL] = (struct image_header_enc *) &sec_config.imgs[DFU_FLASH_IMG_IDX(DFU_FLASH_IMG_BL)],
29 .running_imgs[CORE_BOOT] = (struct image_header_enc *)0xFFFFFFFF,
30};
下图说明了ftab.c中ACPU程序的存放与执行地址是如何从ptab.json提取的。
img
img属性指定分区存放的程序镜像文件名，烧写脚本根据该属性得到镜像文件的烧写地址，当ftab属性描述的base与xip地址相同时不必使用img属性，因为编译生成的hex文件中包含的地址信息可以直接用于烧写。例如下面的示例代码中，由主程序main的ftab定义可知，它的base地址为0x18000000，xip地址为0x60000000，即二级bootloader会将主程序代码由0x18000000搬到0x60000000地址后跳转执行，因此flash4的第一个分区使用img属性表示该分区存放了主程序main的镜像文件。指定的镜像文件名必须是当前工程生成的二进制镜像文件，如果生成的二进制文件只有一个，可以省略扩展名.bin，直接以main、bootloader和lcpu等命名，如果有多个文件，则以proj_name:binary_name格式指定文件名，proj_name为工程名，主工程为main，子工程则与编译脚本配置的名称一致，比如acpu作为子工程加入编译，子工程名为acpu，生成的两个二进制文件分别为ER_IROM1.bin和ER_IROM2.bin，可以用acpu:ER_IROM1.bin表示ACPU编译生成的ER_IROM1.bin文件，用acpu:ER_IROM2.bin表示ACPU编译生成的ER_IROM2.bin文件。
{
"mem": "flash4",
"base": "0x18000000",
"regions": [
{
"offset": "0x00000000",
"max_size": "0x00200000",
"tags": [
"HCPU_FLASH_CODE_LOAD_REGION"
],
"img": "main",
"ftab": {
"name": "main",
"address": [
"base"
]
}
}
]
},
{
"mem": "psram1",
"base": "0x60000000",
"regions": [
{
"offset": "0x00000000",
"max_size": "0x00200000",
"tags": [],
"ftab": {
"name": "main",
"address": [
"xip"
]
}
}
]
},
{
"mem": "psram1_cbus",
"base": "0x10000000",
"regions": [
{
"offset": "0x00000000",
"max_size": "0x00200000",
"tags": [
"HCPU_FLASH_CODE"
],
"exec": "main"
}
]
},
exec
exec属性指定分区上存放的可执行程序的名称，其目的是为了复用同一个链接脚本编译主程序和子程序，比如二级bootloder、dfu和主程序main都使用同一个链接脚本，代码地址由CODE_START_ADDR指定，当编译二级bootloader时，生成的ptab.h如下，CODE_START_ADDR指向了FLASH_BOOT_LOADER_START_ADDR
#undef FLASH_BOOT_LOADER_START_ADDR
#define FLASH_BOOT_LOADER_START_ADDR (0x1C020000)
#undef FLASH_BOOT_LOADER_SIZE
#define FLASH_BOOT_LOADER_SIZE (0x00020000)
#undef FLASH_BOOT_LOADER_OFFSET
#define FLASH_BOOT_LOADER_OFFSET (0x00020000)
#define CODE_START_ADDR (FLASH_BOOT_LOADER_START_ADDR)
#define CODE_SIZE (FLASH_BOOT_LOADER_SIZE)```
而编译主程序生成的ptab.h则是这样：
#undef HCPU_FLASH_CODE_START_ADDR
#define HCPU_FLASH_CODE_START_ADDR (0x10000000)
#undef HCPU_FLASH_CODE_SIZE
#define HCPU_FLASH_CODE_SIZE (0x00200000)
#undef HCPU_FLASH_CODE_OFFSET
#define HCPU_FLASH_CODE_OFFSET (0x00000000)
#define CODE_START_ADDR (HCPU_FLASH_CODE_START_ADDR)
#define CODE_SIZE (HCPU_FLASH_CODE_SIZE)
备注
需要注意的是，对于PSRAM分区，存在CBUS和SBUS两个地址空间，例如上面的例子中CBUS地址是0x10000000，SBUS地址是0x60000000，exec属性需要填写在CBUS分区中，以确保代码执行地址使用CBUS地址空间，而ftab属性的"xip"类型则填写在SBUS分区中，以确保使用SBUS地址搬移代码
custom
使用custom属性可在生成的ptab.h中加入自定义的宏定义，custom属性值为字典数据类型，例如下面这行代码，定义了三个宏，分别为PSRAM_BL_MODE、PSRAM_BL_SIZE和PSRAM_BL_MPI。
"custom": {
"PSRAM_BL_MODE": 3,
"PSRAM_BL_SIZE": 8,
"PSRAM_BL_MPI": 2
}
#define PSRAM_BL_MODE (3)
#define PSRAM_BL_SIZE (8)
#define PSRAM_BL_MPI (1)
备注
字典key的value值必须为整数