硬件開(kāi)發(fā)文檔規范

1、硬件需求說(shuō)明書(shū)

硬件需求說(shuō)明書(shū)是描寫(xiě)硬件開(kāi)發(fā)目標，基本功能、基本配置，主要性能指標、 運行環(huán)境，約束條件以及成本和進(jìn)度等要求，它的要求依據是產(chǎn)品規格說(shuō)明書(shū)和系統需求說(shuō)明書(shū)。它是硬件總體設計和制訂硬件開(kāi)發(fā)計劃的依據，具體編寫(xiě)的內容有：系統工程組網(wǎng)及使用說(shuō)明、硬件整體系統的基本功能和主要性能指 標、硬件分系統的基本功能和主要性能指標以及功能模塊的劃分等。

要點(diǎn)：硬件需求，其實(shí)來(lái)自產(chǎn)品需求包。如果想做好最終的產(chǎn)品：

一、需要對整個(gè)產(chǎn)品的需求包有所了解。

二、需要做好競爭分析

三、做好需求跟蹤

案例1：

我們的iBox在產(chǎn)品定義初期，對競爭對手的產(chǎn)品特點(diǎn)，關(guān)鍵特性，銷(xiāo)量，都做了深入分析和探討。包括選型的過(guò)程。

案例2：

某個(gè)物聯(lián)網(wǎng)項目的需求跟蹤表

2、硬件總體設計報告

硬件總體設計報告是根據需求說(shuō)明書(shū)的要求進(jìn)行總體設計后出的報告，它是硬件詳細設 計的依據。編寫(xiě)硬件總體設計報告應包含以下內容： 系統總體結構及功能劃分，系統邏輯框圖、組成系統各功能模塊的邏輯框圖，電路結構 圖及單板組成，單板邏輯框圖和電路結構圖，以及可靠性、安全性、電磁兼容性討論和硬件測試方案等。

要點(diǎn)：這部分內容需要強調結構、單板功能模塊的劃分，EMC、安規、可靠性、環(huán)境、背板等維度的整機的考慮。所謂硬件架構設計，往往就是在這個(gè)環(huán)節考驗駕馭整個(gè)硬件系統的能力。例如背板的網(wǎng)絡(luò )拓撲是否合理，最終影響這個(gè)硬件產(chǎn)品的長(cháng)遠規劃、升級潛力、成本空間、兼容性等問(wèn)題。

案例：某一個(gè)硬件平臺定型之后，每個(gè)槽位的電路總功耗就已經(jīng)確定了。因為摩爾定律，芯片的規格不斷軍備競賽。隨著(zhù)芯片的不斷升級，我們就不能使用新一代的高功耗的主流器件，會(huì )導致最終影響整機規格，最終影響產(chǎn)品的綜合競爭力。同樣的、如果產(chǎn)品劃分的電路的顆粒度過(guò)于大，導致配置不靈活，也會(huì )影響整個(gè)產(chǎn)品的市場(chǎng)競爭力。

曾經(jīng)見(jiàn)過(guò)一個(gè)項目，希望扣板能夠傳輸出視頻來(lái)，但是只留了一個(gè)I2C的總線(xiàn)，這樣的項目自然會(huì )流產(chǎn)。

3、單板總體設計方案

在單板的總體設計方案定下來(lái)之后應出這份文檔，單板總體設計方案應包含單板版本 號，單板在整機中的位置、開(kāi)發(fā)目的及主要功能，單板功能描述、單板邏輯框圖及各功能模 塊說(shuō)明，單板軟件功能描述及功能模塊劃分、接口簡(jiǎn)單定義與相關(guān)板的關(guān)系，主要性能指標、 功耗和采用標準。

要點(diǎn)：

一、單板框圖應該說(shuō)明清楚連線(xiàn)的規格、器件的規格、盡量與預布局保持一致，便于發(fā)現帶寬、容量、走線(xiàn)、功耗、散熱、電源等維度的問(wèn)題。

二、不要教條地認為，寫(xiě)總體設計方案就是套模板。而是針對關(guān)鍵風(fēng)險和關(guān)鍵技術(shù)需要有針對性地深入研究和撰寫(xiě)。

案例：iBox單板框圖

iBox主芯片MCU的IO管腳定義和接口分配

4、單板硬件詳細設計

在單板硬件進(jìn)入到詳細設計階段，應提交單板硬件詳細設計報告。在單板硬件詳細設計 中應著(zhù)重體現：?jiǎn)伟暹壿嬁驁D及各功能模塊詳細說(shuō)明，各功能模塊實(shí)現方式、地址分配、控 制方式、接口方式、存貯器空間、中斷方式、接口管腳信號詳細定義、時(shí)序說(shuō)明、性能指標、 指示燈說(shuō)明、外接線(xiàn)定義、可編程器件圖、功能模塊說(shuō)明、原理圖、詳細物料清單以及單板 測試、調試計劃。有時(shí)候一塊單板的硬件和軟件分別由兩個(gè)開(kāi)發(fā)人員開(kāi)發(fā)，因此這時(shí)候單板 硬件詳細設計便為軟件設計者提供了一個(gè)詳細的指導，因此單板硬件詳細設計報告至關(guān)重 要。尤其是地址分配、控制方式、接口方式、中斷方式是編制單板軟件的基礎，一定要詳細 寫(xiě)出。

案例：iBox的詳細設計：

電源樹(shù)設計

5、單板硬件過(guò)程調試文檔

開(kāi)發(fā)過(guò)程中，每次所投 PCB 板，工程師應提交一份過(guò)程文檔，以便管理階層了解進(jìn)度， 進(jìn)行考評，另外也給其他相關(guān)工程師留下一份有參考價(jià)值的技術(shù)文檔。每次所投 PCB 板時(shí) 應制作此文檔。這份文檔應包括以下內容：?jiǎn)伟逵布δ苣K劃分，單板硬件各模塊調試進(jìn)度，調試中出現的問(wèn)題及解決方法，原始數據記錄、系統方案修改說(shuō)明、單板方案修改說(shuō)明、 器件改換說(shuō)明、原理圖

要點(diǎn)：發(fā)現的問(wèn)題及時(shí)記錄，特別是改版需求記錄

下圖為早期某個(gè)物聯(lián)網(wǎng)項目的改版記錄跟蹤表：

6、單板系統聯(lián)調報告

該項目進(jìn)入單板系統聯(lián)調階段，應出單板系統聯(lián)調報告。單板系統聯(lián)調報告包括這些內 容：系統功能模塊劃分、系統功能模塊調試進(jìn)展、系統接口信號的測試原始記錄及分析、系 統聯(lián)調中出現問(wèn)題及解決、調試技巧集錦、整機性能評估等。

7、單板硬件測試文檔

在單板調試完之后，申請內部驗收之前，應先進(jìn)行自測以確保每個(gè)功能都能實(shí)現，每項 指標都能滿(mǎn)足。自測完畢應出單板硬件測試文檔，單板硬件測試文檔包括以下內容：?jiǎn)伟骞?能模塊劃分、各功能模塊設計輸入輸出信號及性能參數、各功能模塊測試點(diǎn)確定、各測試參 考點(diǎn)實(shí)測原始記錄及分析、板內高速信號線(xiàn)測試原始記錄及分析、系統 I/O 口信號線(xiàn)測試原 始記錄及分析，整板性能測試結果分析。

8、硬件信息庫

為了共享技術(shù)資料，我們希望建立一個(gè)共享資料庫，每一塊單板都希望將的有價(jià)值 有特色的資料歸入此庫。硬件信息庫包括以下內容：典型應用電路、特色電路、特色芯片技 術(shù)介紹、特色芯片的使用說(shuō)明、驅動(dòng)程序的流程圖、源程序、相關(guān)硬件電路說(shuō)明、PCB 布板注意事項、單板調試中出現的典型及解決、軟硬件設計及調試技巧。