小梅哥和你一起深入學習FPGA之規范約定

　　本規范主要是對設計流程、端口名稱、組織結構、文檔編排進行約定。本約定作用僅僅是為了使后期代碼設計和文檔編寫更加規范有序，方便自己和讀者閱讀，與公司的設計規范還差著十萬八千里，因此，望大家萬不可以小梅哥的規范作為標準。當然，小梅哥在規范約定時，也會盡量參考華為verilog規范和至芯科技的文檔編寫規范力爭做到簡潔通俗。

　　規范約定之設計文檔基本結構

　　為了將設計能夠清晰明了的介紹給大家，讓大家一看就懂，文檔編寫時會詳細包含以下內容：

　　一、 實驗目的

　　二、 實驗原理

　　三、 硬件設計

　　四、 架構設計

　　五、 代碼組織方式

　　六、 關鍵代碼解讀

　　七、 測試平臺設計

　　八、 仿真分析

　　九、 下板驗證

　　現分別對以上標題的內容進行介紹

　　實驗目的：主要提出實驗的要求以及需要達到的目的

　　實驗原理：主要對該實驗涉及到的軟硬件電路、協議、基本思路進行分析和介紹

　　硬件設計：主要分析實現該實驗的硬件電路設計，因為目前小梅哥暫時沒錢做開發板，因此只能是在其他廠家的開發板硬件平臺上進行分析講解

　　架構組織：主要進行實驗的模塊構建和架構解讀，包括端口意義，內部信號意義等。

　　代碼組織方式：主要進行代碼設計方案的介紹，常用的有狀態機、線性序列機，不同的實驗根據具體情況適合采用不同的方案。如果采用狀態機進行設計，則會進行狀態轉移圖的設計，如果采用線性序列機的方式，也會設計相應的線性序列表。

　　關鍵代碼解讀：主要針對設計中關鍵的代碼進行分析解讀

　　測試平臺設計：系統的testbench編寫，如果是多模塊結構，則會對所有模塊分別編寫testbench

　　仿真分析：對仿真結果進行分析，功能仿真必做，時序仿真選做，具體按照實驗內容而定

　　下板驗證：目前小梅哥沒有自己的開發板，沒辦法進行統一的下板驗證，但我會就著手邊的各式各類的開發板上有的硬件資源，自行下板驗證，以保證代碼的正確性。

　　規范約定之代碼端口命名

　　設計中會設計到很多端口，不同的端口含義各不一樣，有內部信號，輸入輸出端口，標志信號，測試信號。

　　現分別對端口名做如下約定：

　　1、 端口信號首字母大寫;

　　2、 全局時鐘信號名為Clk;

　　3、 全局復位信號名為Global_Rst;

　　4、 其它的暫時沒有考慮的太多，具體會在每個實驗對應的文檔中給出。

　　規范約定之狀態機風格設計

　　在學習Verilog的時候，經常有人問是三段式狀態機好還是一段式狀態機好，個人覺得，實際使用哪種方式并沒有一個嚴格的限定，有的設計，采用一段式狀態機設計簡潔，閱讀方便，而三段式狀態機則會較為繁瑣;另外又有一些設計，需要用三段式狀態機才能很好的組織結構。甚至有的設計，需要狀態機和線性序列機聯合使用，方能達到好的效果，因此，小梅哥不想給機子帶上一個標準的框子，對應不同的設計，我會根據實際情況選擇不同的編碼方式。

　　可能考慮的不是很細致，本文檔會在實際代碼和文檔的設計中不斷的豐富和完善。