VHDL代碼書寫規(guī)范

1、VHDL 代碼書寫規(guī)范代碼書寫規(guī)范 （定稿）（定稿） 文件編號 ： 編 制 ： 審 核 ： 可靠性審核： 標(biāo) 準(zhǔn) 化： 批 準(zhǔn) ： 文件會簽頁文件會簽頁 文件歷史記錄文件歷史記錄 文件編號 文件標(biāo)題VHDL 代碼書寫規(guī)范 現(xiàn)行版本V1.0 文件履歷文件履歷 版次編制日期更改內(nèi)容（條款） V1.0 V1.0 目目 錄錄 1.目的 .1 2.范圍 .1 3.術(shù)語說明 .1 4.書寫規(guī)范 .1 4.1 命名規(guī)范.1 R1.一個文件只包含一個模塊，文件命名和實體命名必須相同。文件名大寫，其后綴小寫。.1 R2.頂層文件命名方式使用工程名、器件型號與_TOP 結(jié)合。頂層文件的元件實例化，后綴使用_mod

2、ule； 第二層文件的元件實例化，后綴使用_block；第三層之后不做定義（若遇到常見的基本邏輯電路或子模塊， 如：SRAM、FIFO 等，那么優(yōu)先使用具有代表性的名稱） .1 R3.代碼編寫之前，以文檔的方式，根據(jù)功能分類，分別對 FPGA 的外部端口進行命名約定。.2 R4.命名要有實際意義。.2 R5.命名標(biāo)識符的首字符必須是字母，包含多個單詞的標(biāo)志符單詞之間使用下劃線分開。信號、變量等的 命名最后字符也一定要求是字母，中間的可以是數(shù)字或者其他合法符號。.2 R6.模塊、信號、變量等的命名不大于 64 個字符.2 R7.實體、結(jié)構(gòu)名、端口信號、常量用大寫標(biāo)識.2 R8.行為級、結(jié)構(gòu)級和數(shù)

3、據(jù)流級結(jié)構(gòu)命名分別以“BEH_實體名”、“STR_實體名”和“RTL_實體名”區(qū)分。 如果是混合使用，或者是分不清使用了那一種結(jié)構(gòu)，那么就是用“ARC_實體名”命名。.3 R9.單口 RAM 模塊命名以 SPRAM 作后綴；雙口 RAM 模塊命名以 DPRAM 作后綴；ROM 模塊命名以 ROM 作后綴； FIFO 模塊命名以 FIFO_作后綴；數(shù)字時鐘管理模塊命名以 DCM 作后綴；鎖相環(huán)模塊命名以 PLL 作后綴；乘 法模塊命名以 MULT 作后綴；除法模塊命名以 DIV 作后綴；加法模塊命名以 ADD 作后綴；減法模塊命名以 SUB 作后綴。 .3 R10.模塊實例化時，采用Un_xx_

4、元件名標(biāo)識，cell 實例化時使用Mn_xx_元件名標(biāo)識。 .3 R11.模塊內(nèi)部定義的信號、變量采用首字母大寫命名。首字母符合說明的要求。.3 R12.非頂層模塊端口信號命名方式采用 I_portname、O_portname 和 IO_portname 分別對應(yīng)輸入、輸出和 雙向端口信號。.3 R13.時鐘信號必須用后綴“_clk”進行命名。.3 R14.對于微處理器接口的寄存器，必須包含 reg 標(biāo)志。用下劃線分開該寄存器功能特征。.4 R15.對于輸入管腳時鐘采樣同步的信號命名要求后綴加“_buf”表示。多次采樣加數(shù)字區(qū)分。.4 R16.一些常用的基本信號按說明統(tǒng)一后綴命名。.4 R1

5、7.多比特信號，應(yīng)該使用相同的比特順序，都采用 downto 描述。.5 R18.VHDL 的保留字用小寫。 .5 R19.調(diào)用 IEEE 標(biāo)準(zhǔn)庫時，“IEEE”用大寫，其它用小寫。 .5 4.2 注釋規(guī)范.5 R20.每個 VHDL 源文件應(yīng)該在文件頭注釋文件的基本信息。.5 R21.每個信號、變量、常量和端口的定義都要有注釋。.5 R22.每個進程使用“-”隔開。如果一個功能模塊由幾個進程組成，使用”-*”隔開。.5 R23.對于內(nèi)部表，注釋說明表的組成、表的內(nèi)容及作用。.6 4.3 其它書寫規(guī)范.6 R24.用縮進方式使得代碼有層次感，縮進不要使用 TAB 鍵，縮進為 4 個空格。.6

6、R25.每行字符數(shù),最大不能超過 120。 .6 R26.模塊端口每行定義一個。先根據(jù)端口功能進行區(qū)分，然后再根據(jù)輸入輸出方向進行區(qū)分，類間用空行 分開。.6 R27.調(diào)用模塊使用 “=”方式進行端口映射，總線到總線映射時（x downto y）要寫全。.6 R28.調(diào)用模塊進行端口映射時，一行代碼只映射一個信號。順序必須與原模塊保持一致.6 R29 功能集中或有很強的相關(guān)性的變量信號聲明放在一起，類間用空行或注釋分開。 .6 R30.端口、信號、變量定義需要對齊；模塊實例化時，端口映射需要對齊。.6 R31.運算符與信號之間必須有空格分開.7 1.目的目的 規(guī)范 VHDL 的書寫風(fēng)格，保證代

7、碼的可讀性、可重用性和可移植性，并且要與現(xiàn)有 的 EDA 工具保持一致，從而形成對 VHDL 代碼的標(biāo)準(zhǔn)化管理。 2.范圍范圍 本標(biāo)準(zhǔn)規(guī)定了 VHDL 代碼書寫規(guī)范。 本標(biāo)準(zhǔn)適用于 G-LINK 公司研發(fā)中心。 3.術(shù)語說明術(shù)語說明 本規(guī)范使用的術(shù)語解釋如下： 級別：級別：指該規(guī)則遵循的級別，有兩個級別，分別為推薦和規(guī)定。 推薦：推薦：表示在一般情況下必須遵循該規(guī)則。 規(guī)定：規(guī)定：表示必須嚴(yán)格遵守該規(guī)則。 說明：說明：對此規(guī)則或準(zhǔn)則的必要的解釋。 示例：示例：對此規(guī)則舉例進行說明，示例分為正例和反例。 正例：正例：對此規(guī)則或準(zhǔn)則給出的正確示例。 反例：反例：對此規(guī)則或準(zhǔn)則給出的反面示例。 4.

8、書寫規(guī)范書寫規(guī)范 4.1 命名規(guī)范 R1.一個文件只包含一個模塊，文件命名和實體命名必須相同。文件名大寫，其后綴小寫。一個文件只包含一個模塊，文件命名和實體命名必須相同。文件名大寫，其后綴小寫。 級別：規(guī)定 說明：文件類型為.vhd。如果文件名與實體名不一致，有些編譯器不能識別，而且名字 不一致，也不利于將文件與模塊對應(yīng)，不利于文件的管理。 正例：文件名是 SER_TSP.vhd，那么文件內(nèi)部實體的命名就是 entity SER_TSP is port( ); end SER_TSP; architecture ARC_SER_TSP of SER_TSP is end ARC_SER_TSP

9、; R2.頂層文件命名方式使用工程名、器件型號與頂層文件命名方式使用工程名、器件型號與_TOP 結(jié)合。頂層文件的元件實例化，后結(jié)合。頂層文件的元件實例化，后 綴使用綴使用_module；第二層文件的元件實例化，后綴使用；第二層文件的元件實例化，后綴使用_block；第三層之后不做定義（若；第三層之后不做定義（若 遇到常見的基本邏輯電路或子模塊，如：遇到常見的基本邏輯電路或子模塊，如：SRAM、FIFO 等，那么優(yōu)先使用具有代表性的等，那么優(yōu)先使用具有代表性的 名稱）名稱） 級別：規(guī)定 說明：一般頂層文件命名使用工程名加器件名再加“_TOP”，如“OTDR_ XC3S1000BGA456_TOP

10、”, 頂層文件的元件實例化，后綴使用_module，第二層文件的元 件實例化，后綴使用_block，第三層之后不做定義（若遇到常見的基本邏輯電路，如： SRAM、FIFO 等，那么按照 SRAM、FIFO 命名規(guī)則為優(yōu)先）。 正例：文件名是 OTDR_XC3S1000BGA456_TOP.vhd，那么設(shè)計實體內(nèi)部的結(jié)構(gòu)如圖 1 所示： OTDR_XC3S1000BGA456_TOP. vhd AD9051_module Sync_module Sync_corr_block Sync_corr_sram Sync_corr_fifo 圖 1 設(shè)計實體內(nèi)部的結(jié)構(gòu) R3.代碼編寫之前，以文檔的方式

11、，根據(jù)功能分類，分別對代碼編寫之前，以文檔的方式，根據(jù)功能分類，分別對 FPGA 的外部端口進行命名的外部端口進行命名 約定。約定。 級別：規(guī)定 說明：命名約定包括模塊命名、端口信號命名（確保工程的頂層文件的端口與原理圖設(shè)計保持一致）、 端口信號引腳分配說明（是否是特殊引腳或是普通 I/O 腳）等。在整個系統(tǒng)的研發(fā)過程中，F(xiàn)PGA 與 其它電路模塊（CPU/模擬電路/通信接口等）之間的關(guān)系是非常密切的，為了處理好 FPGA 與其它電 路模塊之間的相互聯(lián)系，我們必須以文檔的形式，清晰地說明輸入輸出端口的特性以及 FPGA 內(nèi)部所 完成的功能，才能使整個研發(fā)團隊之間的合作更加順暢。 正例： FPG

12、A 與 ARM 微處理器之間采用 SPI 通信協(xié)議； SPI 通信接口分別是：SPI_CLK、SPI_MISO、SP_MOSI、SPI_CS； SPI 通信接口的引腳分配均為普通 I/O 引腳。 R4.命名要有實際意義。命名要有實際意義。 級別：規(guī)定 說明：具有一定意義的命名比寫上好幾行的注釋要好得多。 正例：如全加器模塊（FULL_ADDER）、半加器子模塊（HALF_ADDER）和時鐘信號鎖相環(huán)模塊 （CLK_SHIFT_PHASE_PLL）等 R5.命名標(biāo)識符的首字符必須是字母，包含多個單詞的標(biāo)志符單詞之間使用下劃線分開。命名標(biāo)識符的首字符必須是字母，包含多個單詞的標(biāo)志符單詞之間使用下劃

13、線分開。 信號、變量等的命名最后字符也一定要求是字母，中間的可以是數(shù)字或者其他合法符號。信號、變量等的命名最后字符也一定要求是字母，中間的可以是數(shù)字或者其他合法符號。 級別：規(guī)定 說明：由于某些綜合工具對于總線類型的信號，綜合的結(jié)果為總線名加上數(shù)字編號。如果信號、變量 名最后一個字母也使用數(shù)字的話，容易混擾。 正例：Pulse_FFT、AD_State、Address 反例：PulseFFT、ADState、Address8 R6.模塊、信號、變量等的命名不大于模塊、信號、變量等的命名不大于 64 個字符個字符 級別：規(guī)定 說明：太長的命名不方便閱讀。 R7.實體、結(jié)構(gòu)名、端口信號、常量用大寫

14、標(biāo)識實體、結(jié)構(gòu)名、端口信號、常量用大寫標(biāo)識 級別：規(guī)定 說明：使用大寫容易與一般的信號、變量區(qū)分。 R8.行為級、結(jié)構(gòu)級和數(shù)據(jù)流級結(jié)構(gòu)命名分別以行為級、結(jié)構(gòu)級和數(shù)據(jù)流級結(jié)構(gòu)命名分別以“BEH_實體名實體名”、“STR_實體名實體名”和和“RTL_ 實體名實體名”區(qū)分。如果是混合使用，或者是分不清使用了那一種結(jié)構(gòu)，那么就是用區(qū)分。如果是混合使用，或者是分不清使用了那一種結(jié)構(gòu)，那么就是用“ARC_ 實體名實體名”命名。命名。 級別：規(guī)定 表 1 實體命名方式 描述方式命名方式 行為級描述BEH_實體名 結(jié)構(gòu)級描述STR_實體名 數(shù)據(jù)流級描述RTL_實體名 混合級描述ARC_實體名 R9.單口單口

15、RAM 模塊命名以模塊命名以 SPRAM 作后綴；雙口作后綴；雙口 RAM 模塊命名以模塊命名以 DPRAM 作后綴；作后綴； ROM 模塊命名以模塊命名以 ROM 作后綴；作后綴；FIFO 模塊命名以模塊命名以 FIFO_作后綴；數(shù)字時鐘管理模塊命作后綴；數(shù)字時鐘管理模塊命 名以名以 DCM 作后綴；鎖相環(huán)模塊命名以作后綴；鎖相環(huán)模塊命名以 PLL 作后綴；乘法模塊命名以作后綴；乘法模塊命名以 MULT 作后綴；作后綴； 除法模塊命名以除法模塊命名以 DIV 作后綴；加法模塊命名以作后綴；加法模塊命名以 ADD 作后綴；減法模塊命名以作后綴；減法模塊命名以 SUB 作后作后 綴。綴。 級別：

16、規(guī)定 示例：如大小為 512X8 的雙口 RAM（其中 512 為數(shù)據(jù)深度，8 為數(shù)據(jù)寬度），命名順序為功能、存 儲容量和器件類型：Function_512x8_dpram，調(diào)用時，例化名可以為 U_Function_512x8_dpram，其中 Function 說明雙口 RAM 的作用。 R10.模塊實例化時，采用模塊實例化時，采用Un_xx_元件名元件名標(biāo)識，標(biāo)識，cell 實例化時使用實例化時使用Mn_xx_元件名元件名標(biāo)識。標(biāo)識。 級別：推薦 說明：因為綜合、布線工具的工具，一般都將使用實例標(biāo)志輸出報告，如果沒有表示模塊的名字，不 利于閱讀報告。其中 n 表示多次實例化的編號，xx

17、表示模塊調(diào)用的特性（如用途等）。如果只調(diào)用 一次，那么就不必使用數(shù)字，直接就是U_xx_元件名 示例：如 HDLC 發(fā)送模塊 hdlc_trans，調(diào)用時例化名可以為：U0_hirs_hdlc_trans，U1_e1_hdlc_trans； 對于三態(tài)輸出單元 tri，調(diào)用時例化名可以為 M_cpuio_tri。 R11.模塊內(nèi)部定義的信號、變量采用首字母大寫命名。首字母符合說明的要求。模塊內(nèi)部定義的信號、變量采用首字母大寫命名。首字母符合說明的要求。 級別：規(guī)定 說明：首字符要求如表 1 所示： 表 1 模塊內(nèi)部定義數(shù)據(jù)對象的首字符要求 例子說 明 信號S_cpu_addr信號使用“S_”開頭

18、 變量V_data_buf變量使用“V_”開頭 常量C_RSSI_ADDR常量使用“C_”開頭 數(shù)組A_rssi數(shù)組使用“A_”開頭 R12.非頂層模塊端口信號命名方式采用非頂層模塊端口信號命名方式采用 I_portname、O_portname 和和 IO_portname 分別分別 對應(yīng)輸入、輸出和雙向端口信號。對應(yīng)輸入、輸出和雙向端口信號。 級別：規(guī)定 說明：“I_”表示輸入；“O_”表示輸出；“IO_”表示雙向。 R13.時鐘信號必須用后綴時鐘信號必須用后綴“_clk”進行命名。進行命名。 級別：規(guī)定 說明：如果設(shè)計當(dāng)中包括多個時鐘，可以加上根據(jù)時鐘的頻率等特性說明，之間以下劃線分開，

19、如模 塊端口時鐘信號采用 I_xx_clk（其中 xx 代表時鐘的特性），模塊內(nèi)部時鐘信號采用 S_xx_clk（其中 xx 代表時鐘的特性），如 I_15_36M_clk 表示 15.36MHz 的時鐘信號。關(guān)于時鐘信號的表示方法如表 2 所示： 表 2 時鐘信號的表示方法 解釋 I_16chip_clk16chip 時鐘信號； S_16chip_clk16chip 時鐘信號； I_sys_clk系統(tǒng)時鐘 I_66_7M_clk如果時鐘信號是 66.7MHz，那么就使用 66_7M 表示，小數(shù)點 后最多保留 3 位。使用頻率標(biāo)記與 chip 時鐘進行區(qū)分： G表示 GHz； M表示 MHz；

20、 K表示 KHz； Hz表示 Hz； I_pp2sPP2s 必須使用pp2s作為結(jié)尾，最好是完全使用。 S_66_7M_clk如果時鐘信號是 66.7MHz，那么就使用 66_7M 表示，小數(shù)點 后最多保留 3 位。使用頻率標(biāo)記與 chip 時鐘進行區(qū)分： G表示 GHz； M表示 MHz； K表示 KHz； Hz表示 Hz； I_16chip_ph90_clk16chip，相位 90 度， 90 度是：ph90； 180 度是：ph180； 270 度是：ph270； R14.對于微處理器接口的寄存器，必須包含對于微處理器接口的寄存器，必須包含 reg 標(biāo)志。用下劃線分開該寄存器功能特征。標(biāo)

21、志。用下劃線分開該寄存器功能特征。 級別：規(guī)定 說明：這類是用于存儲信息的信號，類似于單片機中的寄存器。 示例：如一個版本的寄存器命名為：S_version_reg。 R15.對于輸入管腳時鐘采樣同步的信號命名要求后綴加對于輸入管腳時鐘采樣同步的信號命名要求后綴加“_buf”表示。多次采樣加數(shù)字區(qū)表示。多次采樣加數(shù)字區(qū) 分。分。 級別：規(guī)定 示例：多次采樣，如：第 1 次采樣命名為 S_portname_1buf；第 2 次采樣命名為：S_portname_2buf； 依次類推。 R16.一些常用的基本信號按說明統(tǒng)一后綴命名。一些常用的基本信號按說明統(tǒng)一后綴命名。 級別：規(guī)定 說明：表 3 列

22、出了常用的信號縮寫后綴，作為同類信號的后綴，如果是低有效則再加后綴_n。 表 3 常用信號的縮寫 信號類型信號類型后綴后綴 時鐘信號clk 系統(tǒng)復(fù)位信號rst 數(shù)據(jù)總線data 地址總線addr 讀使能rd 寫使能wr 中斷信號int 寫指針wp 讀指針rp 計數(shù)器cnt 寄存器reg 請求信號req 應(yīng)答信號ack 使能信號en 清零信號clr R17.多比特信號，應(yīng)該使用相同的比特順序，都采用多比特信號，應(yīng)該使用相同的比特順序，都采用 downto 描述。描述。 級別：規(guī)定 說明：有利于代碼的閱讀 R18.VHDL 的保留字用小寫。的保留字用小寫。 級別：規(guī)定 說明：有利于代碼的閱讀 R1

23、9.調(diào)用調(diào)用 IEEE 標(biāo)準(zhǔn)庫時，標(biāo)準(zhǔn)庫時，“IEEE”用大寫，其它用小寫。用大寫，其它用小寫。 級別：規(guī)定級別：規(guī)定 示例：如：library IEEE; use IEEE.std_logic_1164.all; 4.2 注釋規(guī)范 R20.每個每個 VHDL 源文件應(yīng)該在源文件應(yīng)該在文件頭注釋文件的基本信息。文件頭注釋文件的基本信息。 級別：規(guī)定 說明：每個 VHDL 源文件應(yīng)在開始處注明模塊名稱、引用模塊（頂層模塊中不需要說明引用模塊）、 功能描述、設(shè)計時間及版權(quán)信息，設(shè)計人、修改記錄等。頂層模塊需指出使用的邏輯器件,內(nèi)容包括： 文件名稱、功能描述、單位作者、創(chuàng)建日期、應(yīng)用說明、更新說明、

24、器件型號、更新作者和更新日期。 正例： -* -文件名稱:ARM_INTERFACE_MODULE.vhd -功能描述: -器件型號: -單位作者: -創(chuàng)建日期： -應(yīng)用說明：（應(yīng)用特性和應(yīng)用場合） -更新說明：（更新內(nèi)容和優(yōu)化說明） -更新作者： -更新日期： -* R21.每個信號、變量、常量和端口的定義都要有注釋。每個信號、變量、常量和端口的定義都要有注釋。 級別：推薦 說明：對每個信號，變量、常量和端口的作用作個簡單說明。 R22.每個進程使用每個進程使用“-”隔開。如果一個功能模塊由幾個進程組成，使用隔開。如果一個功能模塊由幾個進程組成，使用”-*”隔隔 開。開。 級別：規(guī)定 說明：

25、增加代碼的可讀性 正例： - - 進程注釋 - process end process ; -* - -進程注釋 - process end process ; - END OF FILE * R23.對于內(nèi)部表，注釋說明表的組成、表的內(nèi)容及作用。對于內(nèi)部表，注釋說明表的組成、表的內(nèi)容及作用。 級別：推薦 說明：加上注釋可以增加對表的理解。 4.3 其它書寫規(guī)范 R24.用縮進方式使得代碼有層次感，縮進不要使用用縮進方式使得代碼有層次感，縮進不要使用 TAB 鍵，縮進為鍵，縮進為 4 個空格。個空格。 級別：規(guī)定 說明：用縮進方式使得代碼有層次感，使代碼的整潔、美觀，便于閱讀。由于 TAB 鍵

26、在不同編輯器 中解釋不一定相同，為了避免不同編輯器下縮進混亂，不能使用 TAB 鍵 建議：為了編寫程序的方便，可以使用 Utral_edit、USE 等編輯工具，使用 TAB 鍵進行編寫程序，然 后將 TAB 鍵轉(zhuǎn)化為空格鍵，這樣，就可以有 TAB 鍵的方便，也避免了縮進的問題； R25.每行字符數(shù)每行字符數(shù),最大不能超過最大不能超過 120。 級別：推薦 說明：以便于在不同的計算機上閱讀代碼，不需要進行橫向移屏才能夠閱讀。 R26.模塊端口每行定義一個。先根據(jù)端口功能進行區(qū)分，然后再根據(jù)輸入輸出方向進行模塊端口每行定義一個。先根據(jù)端口功能進行區(qū)分，然后再根據(jù)輸入輸出方向進行 區(qū)分，類間用空行分開。區(qū)分，類間用空行分開。 級別：規(guī)定 說明：端口分類方式根據(jù)實際情況決定，只要利于進行端口的理解就可以。 R27.調(diào)用模塊使用調(diào)用模塊使用 “=”方式進行端口映射，總線到總線映射時（方式進行端口映射，總線到總線映射時（x downto y）要寫全。）要寫全。 級別：規(guī)定 說明：有利于代碼的閱讀