# git_vivado

**Repository Path**: xs_226/git_vivado

## Basic Information

- **Project Name**: git_vivado
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-17
- **Last Updated**: 2022-01-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

master branch 							：主分支拓扑示例
	Algorithm							：用来存储算法相关工程，拓扑结构需要跟后续的开发者进一步确认	
	KU060								：存放KU060 Sensor子板相关的FPGA工程文件
		doc								：用来存放工程说明文件
		mcs								：用来存放工程的bit文件，如果子分支推送时候需要bit文件，以branch.bit命名
			top_level.bit				：存放顶层工程对应的bit文件
			system_ctrl_zdm.bit 		：从大明创建的system_ctrl_zdm分支的mcs文件夹合并而来的内容
			flash_spi_ztw.bit 			：从探伟创建的flash_spi_ztw分支的mcs文件夹合并而来的内容
			xxxxx.bit 					：其他分支的bit文件，其中xxxx为分支名称
			...
		scripts							：用来存放工程的TCL脚本文件，如果子分支推送时候需要生成工程的TCL文件，以branch.tcl命名
			gen_top_level.tcl 			：存放顶层工程对应的tcl文件
			gen_system_ctrl_zdm.tcl		：从大明创建的system_ctrl_zdm分支的scripts文件夹合并而来的内容
			gen_flash_spi_ztw.tcl		：从探伟创建的flash_spi_ztw分支的scripts文件夹合并而来的内容
			gen_xxxx.tcl 				：其他分支的tcl文件，其中xxxx为分支名称
			...
		src 							：用来存放工程的源文件
			bd							：用来存放block design源文件
			bfm 						：用来存放外设器件的模型文件
			hdl							：用来存放工程源码文件
				top_level 				：存放顶层源文件对应的文件夹
				system_ctrl_zdm			：从大明创建的system_ctrl_zdm分支合并而来的内容
				flash_spi_ztw			：从探伟创建的flash_spi_ztw分支合并而来的内容
				...
			ipcore						：用来存放IP核文件，IP核的源文件不再按照分支内容存放到单独的文件夹中
				user_ip_def				：用户自定义IP核源文件
				inst_ip					：ip核的例化文件
			tb							：用来存放仿真tb顶层文件，由于每个分支的tb可能存在多个文件，这里也需要按照子功能分支名称分文件夹存放
				top_level 				：存放顶层tb源文件对应的文件夹
				system_ctrl_zdm			：从大明创建的system_ctrl_zdm分支的tb文件夹合并而来的内容
				flash_spi_ztw			：从探伟创建的flash_spi_ztw分支的tb文件夹合并而来的内容
				...
			xdc							：用来存放顶层工程的约束文件
		vivado							：用来存放vivado工程相关文件
		vsim 							：用来存放顶层工程的modelsim仿真相关文件
			sim_output					：modelsim的仿真输出文件
			sim_script					：modelsim的启动TCL脚本
			sim_task					：modelsim的仿真用例
			sim_vector					：modelsim的仿真目标向量
			Simt_Zplat.exe				：modelsim仿真用例的管理GUI软件
			测试用例汇总表.xlsx			：modelsim仿真用例的说明文件		
	ZU5									：存放ZU5控制板相关的FPGA工程文件，拓扑和KU060一样		
	.gitignore 							：约束哪些文件进行git版本管理
	readme.txt 							：master分支说明文件

说明：
1、公司要求FPGA代码在git管理时所有子分支都要和向master上合并，针对该要求，FPGA工程的拓扑结构做了以上的修改
2、开发者创建子分支时候如果涉及到多个文件如src和tb下的文件，要以分支名称创建对应的文件夹集中存放，便于后续的集成维护，如果是单个文件，如scripts下的文件，不再建立单独的文件夹，但单文件名称要以子分支命名
3、每个子分支内部可以生成本分支的tcl文件，存放于子分支的scripts文件夹下，用来以后在子分支的vivado目录下恢复本子分支工程，也可以在master主分支调用子分支tcl脚本恢复子分支工程
4、各个子分支由各个开发者单独维护，各位开发者不要切换到别的开发者创建的子分支上修改其创建的分支内容，以避免冲突的产生