1 OpenNoC 介绍

OpenNoC 是基于 AMBA CHI 协议实现的，协议版本为 0050E.b，用来进行连接多核、内存控制器和外设的一个总线。目前 OpenNoC 实现了 HNF, HNI, RNI, SNF 和 XP, 该仓库主要包含 HNF & HNI & RNI & SNF, SXP 源码以及一些 testbench.

2 目录说明

.
├── doc                       // design documents
│   ├── hnf                   // hnf design overview
├── README.md                 // README
├── rtl
│   ├── include               // verilog code
│   ├── misc                  // header files, including macro definitions.
│   ├── src                   // SXP and miscellaneous files
│   │   ├── hnf               // HN-F Component code
│   │   ├── hni               // HN-I Component code
│   │   ├── rni               // RN-I Component code
│   │   └── snf               // SN-F Component code
│   │── tb                    // test top
│   │── case                  // test case
│   │── Makefile              // compile script
│   └── file_list_tb.f        // list of all src and header files
└── tools
    ├── mesh_generator        //Mesh topology router configure tool
    └── ring_generator        //Ring topology router configure tool

3 使用说明

为确保正确使用相关内容，请阅读以下说明

3.1 参数配置说明

以下是各个组件的参数说明，使用者可以按照需求在例化相应模块时指定。

3.1.1 SXP 参数配置

目前 SXP 将REQ, RSP, DAT, SNP 都当做了相同处理，其中 CHI 中 snp 报文并没有 tgtid 字段，SXP 在标准的 snp 报文后增加了 tgtid 字段用作路由，长度固定为7bit。SXP 只是根据 tgtid 进行路由，并不对 flit 进行任何修改，包括snp报文.

SXP中代码只有单个通道的功能: rtl/misc/chi_xp_channel.v ,如何组织成一个SXP交给了使用者。使用时需要根据通道类型参数化配置 FLIT_WIDTH 和 FLIT_TGT_OFFSET (这个目前只有SNP通道需要配置，其他通道使用默认的4就好).

3.1.2 HNF 参数配置

以下是一些 HNF 参数配置，可根据需求修改 rtl/include/hnf_param.v 文件下的 HNF_PARAM 宏包含内容。除了以下说明的参数，HNF_PARAM 宏下的其他参数请使用默认值。需要额外说明的是 L3 CacheLineSize 固定为64字节。

参数名称	说明	默认值
CHIE_REQ_ADDR_WIDTH_PARAM	REQ 报文地址位宽	44
CHIE_SNP_ADDR_WIDTH_PARAM	SNP 报文地址位宽。CHI e.b 协议规定该值为 (CHIE_REQ_ADDR_WIDTH_PARAM-3)	41
CHIE_NID_WIDTH_PARAM	CHI e.b 协议规定该值为（7-11）	7
CHIE_DATA_WIDTH_PARAM	CHI DAT通道的数据位宽（暂不支持配置）	256
CHIE_BE_WIDTH_PARAM	CHI DAT通道的BE位宽，需与数据位宽对应（CHIE_DATA_WIDTH_PARAM/8）	32
CHIE_DATACHECK_WIDTH_PARAM	CHI DAT通道的DataCheck位宽，需与数据位宽对应（0 或 CHIE_DATA_WIDTH_PARAM/8）	32
CHIE_POISON_WIDTH_PARAM	CHI DAT通道的Poison位宽，需与数据位宽对应（0 或 CHIE_DATA_WIDTH_PARAM/64）	4
CHIE_REQ_RSVDC_WIDTH_PARAM	CHI REQ通道用户自定义位宽	0
CHIE_DAT_RSVDC_WIDTH_PARAM	CHI DAT通道用户自定义位宽	0
HNF_MSHR_RNF_NUM_PARAM	NoC 中 RNF 个数	4
HNF_MSHR_RNI_NUM_PARAM	NoC 中 RNI 个数	0
RNF_NID_LIST_PARAM	NoC 中 RNF nodeid 列表	{7'd48,7'd16,7'd40,7'd8}
RNI_NID_LIST_PARAM	NoC 中 RNI nodeid 列表	{7'd1}
HNF_NID_PARAM	HNF nodeid	0
SNF_NID_PARAM	SNF nodeid	32
XP_LCRD_NUM_PARAM	HNF 各通道的 L-Credit 最大计数值。最大值为15	15
HNF_SF_ENTRIES_NUM_PARAM	Snoop Filter Entry 总数目	131072
HNF_SF_WAY_NUM_PARAM	Snoop Filter Way	16
HNF_MSHR_EXCL_RN_NUM_PARAM	用于表示 Global Monitor 模块中的数据标签的项数，最大项数取决于RN个数及RN支持的LP个数，LP个数默认支持8项	32
HNF_MSHR_EXCL_RN_WIDTH_PARAM	用于表示 Global Monitor 模块中的数据标签的项数位宽，需与HNF_MSHR_EXCL_RN_NUM_PARAM对应	5
HNF_MSHR_ENTRIES_NUM_PARAM	支持处理队列Entry的项数	32
HNF_MSHR_ENTRIES_WIDTH_PARAM	支持处理队列Entry的项数位宽，需与HNF_MSHR_ENTRIES_NUM_PARAM对应	5
HNF_L3_CACHE_SIZE_PARAM	L3 Cache 总大小，单位为KB	4096
HNF_L3_WAY_NUM_PARAM	L3 Cache way	16

3.1.3 RNI 参数配置

以下是一些 RNI 参数配置，可根据需求修改 rtl/include/rni_param.v 文件下的 RNI_PARAM 宏包含内容。除了以下说明的参数，RNI_PARAM 宏下的其他参数请使用默认值。

参数名称	说明	默认值
AXI4_PA_WIDTH_PARAM	AXI4 地址位宽	44
AXI4_AXDATA_WIDTH_PARAM	AXI4 数据位宽（暂不支持配置）	128
CHIE_NID_WIDTH_PARAM	NODEID 的位宽，CHI e.b 协议规定该值为（7-11）	11
CHIE_REQ_RSVDC_WIDTH_PARAM	REQ 报文用户自定义位宽	0
CHIE_DAT_RSVDC_WIDTH_PARAM	DAT 报文用户自定义位宽	0
CHIE_REQ_ADDR_WIDTH_PARAM	REQ 报文地址位宽	44
CHIE_SNP_ADDR_WIDTH_PARAM	SNP 报文地址位宽。CHI e.b 协议规定该值为 (CHIE_REQ_ADDR_WIDTH_PARAM-3)	41
CHIE_PA_WIDTH_PARAM	PA 报文地址位宽	44
CHIE_DATA_WIDTH_PARAM	DAT 报文数据位宽（暂不支持配置）	256
CHIE_BE_WIDTH_PARAM	DAT 报文BE位宽，需与数据位宽对应（CHIE_DATA_WIDTH_PARAM/8）	32
CHIE_POISON_WIDTH_PARAM	DAT 报文Poison位宽，需与数据位宽对应（0 或 CHIE_DATA_WIDTH_PARAM/64）	0
CHIE_DATACHECK_WIDTH_PARAM	DAT 报文DataCheck位宽，需与数据位宽对应（0 或 CHIE_DATA_WIDTH_PARAM/8）	0
RNI_NID_PARAM	RNI nodeid	6
HNF_NID_PARAM	HNF nodeid	0

3.1.4 HNI 参数配置

以下是一些 HNI 参数配置，可根据需求例化时指定。

参数名称	说明	默认值
CHIE_REQ_ADDR_WIDTH_PARAM	CHI REQ通道请求的地址位宽	44
CHIE_NID_WIDTH_PARAM	CHI REQ通道请求的NodeID位宽	7
CHIE_DATA_WIDTH_PARAM	CHI DAT通道的数据位宽（暂不支持配置）	256
CHIE_BE_WIDTH_PARAM	CHI DAT通道的BE位宽，需与数据位宽对应（CHIE_DATA_WIDTH_PARAM/8）	32
CHIE_DATACHECK_WIDTH_PARAM	CHI DAT通道的DataCheck位宽，需与数据位宽对应（CHIE_DATA_WIDTH_PARAM/8）	32
CHIE_POISON_WIDTH_PARAM	CHI DAT通道的Poison位宽，需与数据位宽对应（CHIE_DATA_WIDTH_PARAM/64）	4
HNI_MSHR_RNF_NUM_PARAM	RNF的数量	4
AXI4_PA_WIDTH_PARAM	AXI通道的地址宽度	32
AXI_AXDATA_WIDTH_PARAM	AXI通道的数据宽度（暂不支持配置）	128
XP_LCRD_NUM_PARAM	单通道L-Credit总数	15
HNI_MSHR_EXCL_RN_NUM_PARAM	用于表示 Global Monitor 模块中的数据标签的项数，最大项数取决于RN个数及RN支持的LP个数，LP个数默认支持8项	32
HNI_MSHR_EXCL_RN_WIDTH_PARAM	用于表示 Global Monitor 模块中的数据标签的项数位宽，需与HNI_MSHR_EXCL_RN_NUM_PARAM对应	5
HNI_MSHR_ENTRIES_NUM_PARAM	支持处理队列Entry的项数	32
HNI_MSHR_ENTRIES_WIDTH_PARAM	支持处理队列Entry的项数位宽，需与HNI_MSHR_ENTRIES_NUM_PARAM对应	5
HNI_NODEID_PARAM	HNI的NodeID	0
HNI_ADDR_REGION_NUM	AXI的地址区域数量，对应AXID的数量	16
HNI_ADDR_REGION_LSB	各AXI地址区域的起始地址，需为地址宽度的整数倍	{44'hf000, 44'he000, 44'hd000, 44'hc000, 44'hb000, 44'ha000, 44'h9000, 44'h8000, 44'h7000, 44'h6000, 44'h5000, 44'h4000, 44'h3000, 44'h2000, 44'h1000, 44'h0000}
HNI_ADDR_REGION_SIZE	各AXI地址区域的宽度，最小允许为12（4KB）	{12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12}

3.1.4 SNF 参数配置

以下是一些 SNF 参数配置，可根据需求例化时指定。

参数名称	说明	默认值
CHIE_REQ_ADDR_WIDTH_PARAM	CHI REQ通道请求的地址位宽	44
CHIE_NID_WIDTH_PARAM	CHI REQ通道请求的NodeID位宽	7
CHIE_DATA_WIDTH_PARAM	CHI DAT通道的数据位宽（暂不支持配置）	256
CHIE_BE_WIDTH_PARAM	CHI DAT通道的BE位宽，需与数据位宽对应（CHIE_DATA_WIDTH_PARAM/8）	32
CHIE_DATACHECK_WIDTH_PARAM	CHI DAT通道的DataCheck位宽，需与数据位宽对应（CHIE_DATA_WIDTH_PARAM/8）	32
CHIE_POISON_WIDTH_PARAM	CHI DAT通道的Poison位宽，需与数据位宽对应（CHIE_DATA_WIDTH_PARAM/64）
CHIE_REQ_RSVDC_WIDTH_PARAM	CHI REQ通道用户自定义位宽	0
CHIE_DAT_RSVDC_WIDTH_PARAM	CHI DAT通道用户自定义位宽	0
SNF_MSHR_HNF_NUM_PARAM	HNF数量	4
XP_LCRD_NUM_PARAM	单通道L-Credit最大数量	15
SNF_MSHR_ENTRIES_NUM_PARAM	支持处理队列Entry的项数	32
SNF_NID_PARAM	SNF的NodeID	7'd3
AXI4_AXDATA_WIDTH_PARAM	AXI通道的数据宽度,可配置为128/256	128
AXI4_PA_WIDTH_PARAM	AXI通道的地址宽度	32
SNF_MSHR_ENTRIES_WIDTH_PARAM	支持处理队列Entry的项数位宽，需与SNF_MSHR_ENTRIES_NUM_PARAM对应	5

3.2 RTL 编译说明

1. 'make com' 编译 file_list 内所有的文件。
2. 'make sim' 运行 testcases。
3. 'make run_dve' 查看波形图。
4. 'make clean' 清除掉所有编译和仿真生成的文件。