嵌入式軟件概要設計模板

嵌入式軟件概要設計嵌入式軟件概要設計嵌入式軟件概要設計（模板）嵌入式軟件概要設計嵌入式軟件概要設計第第6頁共15頁目錄前言 5編寫目的 5項目背景 5定義 5參考資料 5版本變更說明 5任務概述 5目標 5嵌入式軟件運行環(huán)境 5總體設計 6系統(tǒng)描述 6設計約定 6總體結構 6處理流程 9安全關鍵部件的設計 9識別安全關鍵部件 9安全關鍵部件設計 9接口設計 9接口示意圖 10用戶接口設計 12外部接口設計 12內(nèi)部接口設計 12通信接口設計 12硬件接口設計 12運行設計 13系統(tǒng)啟動設計 13異常信息記錄及處理設計 13異常情況分析 13異常處理對策 13異常信息記錄 13容錯設計 13維護設計 13調(diào)試信息的緩沖區(qū)管理 13調(diào)試策略 14調(diào)試信息級別 14調(diào)試API 14軟件可測性設計 14軟硬件版本信息在線上報在線加載 14數(shù)據(jù)設定與操作 14保密性設計 15軟件包描述 15軟件包結構 15發(fā)布介質 錯誤!未定義書簽。軟件可安裝性 15模板使用說明：1、本模板發(fā)布后，新產(chǎn)品一律使用本模板撰寫；2、本模板中的藍色字是對模板內(nèi)容的說明，用于指導作者理解并按照模板要求進行編寫，具體編寫時，可刪除；3、而不能直接將相關章節(jié)刪除；前言編寫目的本文根據(jù)XX產(chǎn)品需求規(guī)格說明，對XXWebXX產(chǎn)品軟件的非功能性需求，包括出錯處理，可維護性等加以描述；以便指導詳細設計和軟件編碼。本文檔適用于系統(tǒng)設計師、軟件設計者、軟件開發(fā)者、軟件測試工程師等相關人員閱讀和使用。項目背景軟件名稱：軟件標簽：軟件版本號：定義參考資料版本變更說明版本號/版本號/目關聯(lián)產(chǎn)品的受影響的功兼容性說明能模塊受影響的測試用例任務概述目標完成的軟件設計，確定軟件的總體結構，關鍵操作處理流程，功能模塊劃分。嵌入式軟件運行環(huán)境軟件環(huán)境硬件環(huán)境總體設計系統(tǒng)描述根據(jù)《產(chǎn)品系統(tǒng)總體方案》和《硬件概要設計》的內(nèi)容，總結出對嵌入式軟件的設計要求系統(tǒng)主要輸入系統(tǒng)主要輸出系統(tǒng)主要功能及安全關鍵功能識別設計可在詳細設計文檔中進行系統(tǒng)主要性能設計約定本嵌入式軟件設計需要遵守的總體要求編程語言約定開發(fā)本程序所使用開發(fā)語言、平臺及版本數(shù)據(jù)類型定義常用數(shù)據(jù)類型新類型名變量名稱前綴typedefunsignedcharBYTEbytypedefcharCHARctypedefunsignedshortWORDwtypedefshortSWORDssw接口函數(shù)約定供外部模塊調(diào)用的函數(shù)接口命令方式：模塊名稱+功能名稱共內(nèi)部模塊調(diào)用的函數(shù)接口命名方式：模式名稱+功能名稱代碼組織約定代碼文件的組織方式按照物理器件和邏輯功能來劃分，即每一個設備器件分配一個文件，每一邏輯單元功能分配一個文件，對于需要集中管理的信息則單獨分配文件，如寄存器定義，板卡配置信息等則單獨分配文件，便于信息的查找和修改。總體結構描述嵌入式軟件總體結構嵌入式軟件概要設計嵌入式軟件概要設計PAGE1015頁系統(tǒng)結構圖根據(jù)對本系統(tǒng)的需求分析結果，對本系統(tǒng)的組成進行設計及相關內(nèi)容的描述，以下樣例供使用者參考：樣例1、系統(tǒng)結構圖：樣例2、消息處理方式設計：樣例3、組件調(diào)用關系：模塊劃分4.3.3模塊功能描述4.3.3模塊功能描述樣例：WebUI管理、系統(tǒng)告警、系統(tǒng)升級、在線診斷、用戶幫助等組件組成，給用戶提供可視化的業(yè)務操作和圖形化的信息顯示。該模塊只和業(yè)務處理層有接口交互，主要以消息交互的方式進行信息交互。該模塊首先接收用戶發(fā)出的操作指令，然后轉換成業(yè)務請求服務消息發(fā)送給業(yè)務處理層，并接收業(yè)務處理層的響應，最后將結果以圖形化的形式反饋給用戶。4.3.4系統(tǒng)兼容性說明說明本軟件與現(xiàn)有硬件的兼容關系，以及是否向下兼容。出現(xiàn)不兼容的情況，需說明哪部分不兼容，對生產(chǎn)、服務、銷售、市場有何影響。處理流程描述主要業(yè)務的處理流程樣例：1處理流程2處理流程N處理流程安全關鍵部件的設計識別安全關鍵部件對于以下軟件部件,應作為安全關鍵部件加以識別,并在設計中進行可靠性設計:;中斷處理程序、中斷優(yōu)先級模式及允許或禁止中斷的例行程序；產(chǎn)生對硬件進行自主控制信號的軟件；產(chǎn)生直接影響硬件部件運動或啟動安全關鍵功能的信號的軟件；顯示硬件狀態(tài)的軟件安全關鍵部件設計對安全關鍵軟件，必須列出可能的不期望事件，分析導致不期望事件的可能原因，提出相應的軟件處理需求。例如中斷處理程序期望每5秒鐘收到一次中斷，那么要考慮如果5秒時沒有中斷時，應如何處理接口設計對本嵌入式軟件所有接口進行設計接口示意圖界面接口描述界面上需要體現(xiàn)的功能接口以及與下層軟件的接口關系樣例：業(yè)務類接口根據(jù)系統(tǒng)功能圖和系統(tǒng)結構圖，對所需的業(yè)務接口進行定義，不同的業(yè)務接口由各種具體的業(yè)務類來實現(xiàn)。樣例：非業(yè)務類接口系統(tǒng)中的非業(yè)務接口則由各種具體的功能類來實現(xiàn)，其中告警接口由告警類和事件類來共同實現(xiàn)。6.1.46.1.4內(nèi)部接口可以將系統(tǒng)中較復雜的操作抽象成內(nèi)部接口，使得系統(tǒng)既可以保持業(yè)務處理框架的穩(wěn)定性，又降低了業(yè)務處理模塊的復雜性。6.1.5算法接口的可擴展性。樣例：6.2用戶接口設計對于用戶交互相關的接口進行設計，主要包括界面布局、UI6.2用戶接口設計外部接口設計接口名稱事件日志查詢事件自動上報接口描述返回數(shù)據(jù)包格式：錯誤狀態(tài)碼，事件個數(shù)，發(fā)生事件槽位接口名稱事件日志查詢事件自動上報接口描述返回數(shù)據(jù)包格式：錯誤狀態(tài)碼，事件個數(shù)，發(fā)生事件槽位自動上報的數(shù)據(jù)為錯誤狀態(tài)碼，發(fā)生事件槽位號，事件編碼，事件ID，事件描述，發(fā)生時間，事件參數(shù)信息。內(nèi)部接口設計接口名稱窗口查詢獲取開窗信號通道接口描述根據(jù)窗口句柄遍歷窗口聯(lián)表，查詢是否存在指定窗口根據(jù)窗口跨屏的數(shù)量以及處理單元信息計算通道參數(shù)根據(jù)接口名稱窗口查詢獲取開窗信號通道接口描述根據(jù)窗口句柄遍歷窗口聯(lián)表，查詢是否存在指定窗口根據(jù)窗口跨屏的數(shù)量以及處理單元信息計算通道參數(shù)通信接口設計6.6硬件接口設計6.6硬件接口設計樣例：嵌入式軟件概要設計嵌入式軟件概要設計第第13頁共15頁接口名稱接口名稱I2C通信協(xié)議串行總線協(xié)議Data總線寬度8bit備注運行設計系統(tǒng)啟動設計描述嵌入式軟件啟動過程異常信息記錄及處理設計異常情況分析對嵌入式系統(tǒng)可能出現(xiàn)的故障進行分析并定義類別，通常分提示性錯誤、一般錯誤、嚴重錯誤、致命錯誤異常處理對策系統(tǒng)對異常情況必須做出處理，包括返回、告警提示等，系統(tǒng)作出處理應考慮實時性和有效性異常信息記錄件系統(tǒng)的，可以提供網(wǎng)絡遠程記錄容錯設計對可靠性要求很高的系統(tǒng)應同時考慮硬件和軟件的容錯設計，而不能只考慮硬件容錯設計維護設計為了便于跟蹤錯誤和調(diào)試代碼，以便軟件出現(xiàn)故障時提供有價值的參考信息，提高分析問題和解決問題的效率，對調(diào)試信息的管理做出的設計。調(diào)試信息的緩沖區(qū)管理128*16*1024bytes，每條信息的長度固定為128個字節(jié)，總共16K條的輸出信息。當調(diào)試信息的長度超過127128個字節(jié)到打印信息。調(diào)試策略1、直接丟棄：該策略適用于對大量調(diào)試信息的過濾和篩選2、直接輸出到控制臺：該策略適用于實時觀察調(diào)試信息3、輸出到日志緩沖區(qū)：該策略適用于對錯誤的回溯跟蹤調(diào)試4、輸出到控制臺和日志緩沖區(qū)：該策略適用于有前后時間關聯(lián)的錯誤調(diào)試調(diào)試信息級別linux內(nèi)核對調(diào)試信息所定的級別進行定義：#define #define KERN_ALERT

"<0>""<1>"

/*systemisunusable *//*actionmustbetakenimmediately */#define KERN_CRIT#define KERN_ERR

/*criticalconditions *//*errorconditions */#define #define KERN_NOTICE

/*warningconditions *//*normalbutsignificantcondition*/#define KERN_INFO"<6>" /*informational */#define KERN_DEBUG "<7>" /*debug-levelmessages */開發(fā)人員可根據(jù)調(diào)試信息的重要程度對不同級別的調(diào)試信息采用不同的處理策略，以平衡調(diào)試信息和程序執(zhí)行之間的矛盾API軟件可測性設計針對系統(tǒng)的主要性能指標，依據(jù)已定義的整體系統(tǒng)方案，分析這些性能指標是否能夠驗證，并在相關模塊中預留接口軟硬件版本信息在線上報/在線加載硬件 版本在線上報或查詢（硬件PCB；單板軟件；可編程邏輯；制成板版本、在線加載接口；單板軟件在線擦除/在線加載。軟件 版本在線上報或查詢；在線加載；在線補??；數(shù)據(jù)設定與操作數(shù)據(jù)校驗、數(shù)據(jù)一致性檢查、重要數(shù)據(jù)修改警示性提示、數(shù)據(jù)格式轉換