SWE-D10-02軟件詳細(xì)設(shè)計(jì)報(bào)告(嵌入式)

1、軟件詳細(xì)設(shè)計(jì)報(bào)告（嵌入式）軟件詳細(xì)設(shè)計(jì)報(bào)告（嵌入式）V0.9項(xiàng) 目 號(hào)：項(xiàng)目名稱：編 制：日 期：審核 /會(huì)簽日期審核 /會(huì)簽日期審核 /會(huì)簽日期批準(zhǔn)日期修訂頁(yè)編號(hào)修訂內(nèi)容簡(jiǎn)述修訂日期修訂后版本號(hào)修訂人審核人批準(zhǔn)人1將前期討論的結(jié)果根據(jù)公司模板格式要求重 新整理2007-9-18V0.52統(tǒng)一升級(jí)預(yù)發(fā)布版本，修訂部分細(xì)節(jié)2007-11-7V0.95/9目錄1. 概述 41.1. 本文檔的目的 41.2. 單板軟件概述 42. 功能描述 42.1. 軟件功能說(shuō)明 42.2. 軟件功能框圖 43. 開(kāi)關(guān)、跳線、指示燈說(shuō)明 43.1. 開(kāi)關(guān)跳線 43.2. 指示燈 44. 編譯說(shuō)明 44.1. 固化

2、文件的生成 44.2. 物理軟件的燒制 55. 數(shù)據(jù)結(jié)構(gòu) 55.1. 常量定義 55.2. 全局變量定義 55.3. 全局結(jié)構(gòu)定義 56. 程序流程 56.1. 模塊1 56.2. 模塊2 77. 需求跟蹤 77.1. 系統(tǒng)功能需求實(shí)現(xiàn) 87.2. 系統(tǒng)性能需求實(shí)現(xiàn) 87.3. 系統(tǒng)其他需求實(shí)現(xiàn) 88. 源文件列表 89. 其它 8關(guān)鍵詞 ：能夠體現(xiàn)文檔描述內(nèi)容主要方面的詞匯。摘 要：縮略語(yǔ)清單：對(duì)本文所用縮略語(yǔ)進(jìn)行說(shuō)明，要求提供每個(gè)縮略語(yǔ)的英文全名和中文解釋。1. 概述1.1. 本文檔的目的說(shuō)明本文檔的編寫(xiě)的目的，包含的內(nèi)容，適合的軟件版本。如為升級(jí)文檔還要說(shuō)明升級(jí)的原因，主要增加了哪些功能

3、，解決了哪些問(wèn)題。1.2. 單板軟件概述簡(jiǎn)要說(shuō)明單板軟件所屬的產(chǎn)品名稱，承載軟件的單板在整個(gè)產(chǎn)品中的位置、作用、和其它單板的關(guān)系。說(shuō)明該單板軟件所屬的成品板及能夠兼容的所有制成板。2. 功能描述2.1. 軟件功能說(shuō)明這里是對(duì)單板軟件概要設(shè)計(jì)功能描述的細(xì)化，功能說(shuō)明應(yīng)嚴(yán)格與概要設(shè)計(jì)功能描述一致，保持需求與設(shè)計(jì)的一致性。2.2. 軟件功能框圖根據(jù)以上外部功能，采用圖形方式詳細(xì)說(shuō)明單板軟件采用何種功能結(jié)構(gòu)完成這些功能。3. 開(kāi)關(guān)、跳線、指示燈說(shuō)明3.1. 開(kāi)關(guān)跳線說(shuō)明所有可由程序讀取其狀態(tài)的撥碼開(kāi)關(guān)、跳線、 鍵盤(pán)等分別代表的功能和CPU 讀取其狀態(tài)的方式。如有可能也請(qǐng)列出不受程序控制的撥碼開(kāi)關(guān)、跳線

4、、鍵盤(pán)等分別代表的含義。3.2. 指示燈說(shuō)明所有受程序控制和不受程序控制的指示燈所代表的信息，以及指示燈與CPU 的連接方式，受控和不受控的原因。詳細(xì)描述各指示燈顯示規(guī)則。4. 編譯說(shuō)明4.1. 固化文件的生成軟件詳細(xì)設(shè)計(jì)報(bào)告（嵌入式）詳細(xì)說(shuō)明軟件的編譯連接過(guò)程，包括如何使用編譯、連接批處理文件，最后生成的固化文件的名稱。4.2. 物理軟件的燒制詳細(xì)說(shuō)明物理軟件的固化過(guò)程和方法，如果軟件可以加載，請(qǐng)?jiān)敿?xì)說(shuō)明加載過(guò)程。5. 數(shù)據(jù)結(jié)構(gòu)應(yīng)盡可能詳細(xì)列出詳細(xì)設(shè)計(jì)部分定義的常數(shù)、全局變量、全局結(jié)構(gòu)體。5.1. 常量定義說(shuō)明主要/全部常量或常數(shù)表的含義，并說(shuō)明這些常量取當(dāng)前值的原因。5.2. 全局變量定義

5、定義主要/全部全局變量的含義。建議按照模塊劃分，更能明確的說(shuō)明常量的意義。對(duì)于所有模塊都使用的變量會(huì)增加整個(gè)系統(tǒng)模塊間的關(guān)聯(lián)行，應(yīng)說(shuō)明其存在的理由。5.3. 全局結(jié)構(gòu)定義定義主要/全部全局結(jié)構(gòu)體的含義，建議按照模塊劃分，每個(gè)模塊必須要包括它的核心數(shù)據(jù)結(jié)構(gòu)。多個(gè)模塊使用的數(shù)據(jù)結(jié)構(gòu)會(huì)導(dǎo)致模塊間的關(guān)聯(lián)性，應(yīng)說(shuō)明其存在的理由。6. 程序流程本部分介紹了單板軟件的程序設(shè)計(jì)，應(yīng)盡量按照模塊劃分，便于進(jìn)行需求跟蹤。對(duì)于單任務(wù)的單板軟件系統(tǒng)，可以按照（主程序或主函數(shù)、子程序或子函數(shù)、中斷服務(wù)程序）的說(shuō)明要點(diǎn)。對(duì)于多任務(wù)可以按照任務(wù)劃分來(lái)說(shuō)明函數(shù)的實(shí)現(xiàn)方法。要求函數(shù)必須有流程圖或偽代碼描述說(shuō)明，函數(shù)設(shè)計(jì)要明確，

6、可以達(dá)到根據(jù)設(shè)計(jì)實(shí)現(xiàn)編程的目的。6.1. 模塊 1 此處說(shuō)明模塊功能，在軟件系統(tǒng)中位置，與其他模塊關(guān)系和接口。6.1.1. 函數(shù) 16/9軟件詳細(xì)設(shè)計(jì)報(bào)告(嵌入式)6.1.3.函數(shù)3 中斷服務(wù)程序1) 函數(shù)原型8/91) 函數(shù)原型 給出被說(shuō)明函數(shù)的原型。2) 功能 說(shuō)明函數(shù)的功能。3) 入口參數(shù) 請(qǐng)對(duì)程序所有的入口參數(shù)進(jìn)行說(shuō)明。4) 出口參數(shù) 請(qǐng)對(duì)程序的所有出口參數(shù)進(jìn)行說(shuō)明。5) 局部變量 說(shuō)明在程序范圍所有的局部變量和功能。6) 函數(shù)調(diào)用 說(shuō)明程序?yàn)榱送瓿善涔δ鼙仨氄{(diào)用哪些函數(shù)。7) 全局變量使用 說(shuō)明程序中使用了那些全局變量，對(duì)可能引起的中斷重入/任務(wù)搶占采用了那些措施。8) 流程圖 畫(huà)出

7、主程序的流程圖或用偽代碼說(shuō)明。6.1.2.函數(shù)2軟件詳細(xì)設(shè)計(jì)報(bào)告（嵌入式）給出被說(shuō)明函數(shù)的原型。2) 功能說(shuō)明函數(shù)的功能。模塊內(nèi)部如果涉及底層驅(qū)動(dòng)的中斷服務(wù)程序，應(yīng)明確標(biāo)明中斷類型(外部中斷、內(nèi)部中斷)、中斷優(yōu)先級(jí)等信息。3) 入口參數(shù) 請(qǐng)對(duì)程序所有的入口參數(shù)進(jìn)行說(shuō)明。4) 出口參數(shù) 請(qǐng)對(duì)程序的所有出口參數(shù)進(jìn)行說(shuō)明。5) 局部變量 說(shuō)明在程序范圍所有的局部變量和功能。6) 函數(shù)調(diào)用 說(shuō)明程序?yàn)榱送瓿善涔δ鼙仨氄{(diào)用哪些函數(shù)。7) 全局變量使用說(shuō)明程序中使用了那些全局變量，對(duì)可能引起的中斷重入/任務(wù)搶占采用了那些措施。8) 流程圖 畫(huà)出主程序的流程圖或用偽代碼說(shuō)明。6.2. 模塊 2。7. 需求跟蹤為保證所有單板軟件概要設(shè)計(jì)中的需求描述在詳細(xì)設(shè)計(jì)中都得到體現(xiàn)，這里需要對(duì)所有的需求實(shí)現(xiàn)進(jìn)行描述。7.1. 系統(tǒng)功能需求實(shí)現(xiàn) 列出各項(xiàng)系統(tǒng)功能需求在詳細(xì)設(shè)計(jì)中的實(shí)現(xiàn)函數(shù)；7.2. 系統(tǒng)性能需求實(shí)現(xiàn) 列出各項(xiàng)系統(tǒng)性能需求在詳細(xì)設(shè)計(jì)中的實(shí)現(xiàn)函數(shù)；7.3. 系統(tǒng)其他需求實(shí)現(xiàn) 列出各項(xiàng)系統(tǒng)其他需求在詳細(xì)設(shè)計(jì)中的實(shí)現(xiàn)函數(shù)；8. 源文件列表羅列所有的源程序文件名并分別說(shuō)明用途，要求在提交本文檔同時(shí)提交