軟件編程規(guī)范
為了提高源程序的質(zhì)量和可維護(hù)性,從而最終提高軟件產(chǎn)品生產(chǎn)力,特編寫此規(guī)范。
本標(biāo)準(zhǔn)規(guī)定了程序設(shè)計(jì)人員進(jìn)行程序設(shè)計(jì)時(shí)必須遵循的規(guī)范。本規(guī)范主要針對(duì)單片機(jī)編程語言和08編譯器而言,包括排版、注釋、命名、變量使用、代碼可測(cè)性、程序效率、質(zhì)量保證等內(nèi)容。
1.基本規(guī)則
格式清晰
注釋簡(jiǎn)明扼要
命名規(guī)范易懂
函數(shù)模塊化
程序易讀易維護(hù)
功能準(zhǔn)確實(shí)現(xiàn)
代碼空間效率和時(shí)間效率高
適度的可擴(kuò)展性
2.單片機(jī)編程規(guī)范-標(biāo)識(shí)符命名
2.1 命名基本原則
命名要清晰明了,有明確含義,使用完整單詞或約定俗成的縮寫。通常,較短的單詞可通過去掉元音字母形成縮寫;較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫。即"見名知意"。
命名風(fēng)格要自始至終保持一致。
命名中若使用特殊約定或縮寫,要有注釋說明。
同一軟件產(chǎn)品內(nèi)模塊之間接口部分的標(biāo)識(shí)符名稱之前加上模塊標(biāo)識(shí)。
2.2 宏和常量命名
宏和常量用全部大寫字母來命名,詞與詞之間用下劃線分隔。對(duì)程序中用到的數(shù)字均應(yīng)用有意義的枚舉或宏來代替。
2.3 變量命名
變量名用小寫字母命名,每個(gè)詞的第一個(gè)字母大寫。類型前綴(u8\s8 etc.)全局變量另加前綴g_。
局部變量應(yīng)簡(jiǎn)明扼要。局部循環(huán)體控制變量?jī)?yōu)先使用i、j、k等;局部長(zhǎng)度變量?jī)?yōu)先使用len、num等;臨時(shí)中間變量?jī)?yōu)先使用temp、tmp等。
2.4 函數(shù)命名
函數(shù)名用小寫字母命名,每個(gè)詞的第一個(gè)字母大寫,并將模塊標(biāo)識(shí)加在最前面。
2.5 文件命名
一個(gè)文件包含一類功能或一個(gè)模塊的所有函數(shù),文件名稱應(yīng)清楚表明其功能或性質(zhì)。
每個(gè).c文件應(yīng)該有一個(gè)同名的.h文件作為頭文件。
3.單片機(jī)編程規(guī)范-注釋
3.1 注釋基本原則
有助于對(duì)程序的閱讀理解,說明程序在"做什么",解釋代碼的目的、功能和采用的方法。
一般情況源程序有效注釋量在30%左右。
注釋語言必須準(zhǔn)確、易懂、簡(jiǎn)潔。
邊寫代碼邊注釋,修改代碼同時(shí)修改相應(yīng)的注釋,不再有用的注釋要?jiǎng)h除。
匯編和C中都用"http://",取消";" 不使用段注釋" /* */ "(調(diào)試時(shí)可用)
3.2 文件注釋
文件注釋必須說明文件名、函數(shù)功能、創(chuàng)建人、創(chuàng)建日期、版本信息等相關(guān)信息。
修改文件代碼時(shí),應(yīng)在文件注釋中記錄修改日期、修改人員,并簡(jiǎn)要說明此次修改的目的。所有修改記錄必須保持完整。
文件注釋放在文件頂端,用"/*……*/"格式包含。
注釋文本每行縮進(jìn)4個(gè)空格;每個(gè)注釋文本分項(xiàng)名稱應(yīng)對(duì)齊。
/***********************************************************
文件名稱:
作 者:
版 本:
說 明:
修改記錄:
***********************************************************/
3.3 函數(shù)注釋
3.3.1 函數(shù)頭部注釋
函數(shù)頭部注釋應(yīng)包括函數(shù)名稱、函數(shù)功能、入口參數(shù)、出口參數(shù)等內(nèi)容。如有必要還可增加作者、創(chuàng)建日期、修改記錄(備注)等相關(guān)項(xiàng)目。
函數(shù)頭部注釋放在每個(gè)函數(shù)的頂端,用"/*……*/"的格式包含。其中函數(shù)名稱應(yīng)簡(jiǎn)寫為FunctionName(),不加入、出口參數(shù)等信息。
/***********************************************************
函數(shù)名稱:
函數(shù)功能:
入口參數(shù):
出口參數(shù):
備 注:
***********************************************************/
3.3.2 代碼注釋
代碼注釋應(yīng)與被注釋的代碼緊鄰,放在其上方或右方,不可放在下面。如放于上方則需與其上面的代碼用空行隔開。一般少量注釋應(yīng)該添加在被注釋語句的行尾,一個(gè)函數(shù)內(nèi)的多個(gè)注釋左對(duì)齊;較多注釋則應(yīng)加在上方且注釋行與被注釋的語句左對(duì)齊。
函數(shù)代碼注釋用"http://…//"的格式。
通常,分支語句(條件分支、循環(huán)語句等)必須編寫注釋。其程序塊結(jié)束行"}"的右方應(yīng)加表明該程序塊結(jié)束的標(biāo)記"end of ……", 尤其在多重嵌套時(shí)。
3.4 變量、常量、宏的注釋
同一類型的標(biāo)識(shí)符應(yīng)集中定義,并在定義之前一行對(duì)其共性加以統(tǒng)一注釋。對(duì)單個(gè)標(biāo)識(shí)符的注釋加在定義語句的行尾。
全局變量一定要有詳細(xì)的注釋,包括其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時(shí)的注意事項(xiàng)等。
注釋用"http://…//"的格式。
4.單片機(jī)編程規(guī)范-函數(shù)
4.1 設(shè)計(jì)原則
函數(shù)的基本要求:
1)封裝性
正確性:程序要實(shí)現(xiàn)設(shè)計(jì)要求的功能。
穩(wěn)定性和安全性:程序運(yùn)行穩(wěn)定、可靠、安全。
可測(cè)試性:程序便于測(cè)試和評(píng)價(jià)。
規(guī)范/可讀性:程序書寫風(fēng)格、命名規(guī)則等符合規(guī)范。
擴(kuò)展性:代碼為下一次升級(jí)擴(kuò)展留有空間和接口。
全局效率:軟件系統(tǒng)的整體效率高。
局部效率:某個(gè)模塊/子模塊/函數(shù)的本身效率高。
編制函數(shù)的基本原則:
單個(gè)函數(shù)的規(guī)模盡量限制在200行以內(nèi)(不包括注釋和空行)。一個(gè)函數(shù)只完成一個(gè)功能。
函數(shù)局部變量的數(shù)目一般不超過5~10個(gè)。
函數(shù)內(nèi)部局部變量定義區(qū)和功能實(shí)現(xiàn)區(qū)(包含變量初始化)之間空一行。
函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能。通常使用動(dòng)賓詞組為執(zhí)行某操作的函數(shù)命名。
函數(shù)的返回值要清楚明了,尤其是出錯(cuò)返回值的意義要準(zhǔn)確無誤。
不要把與函數(shù)返回值類型不同的變量,以編譯系統(tǒng)默認(rèn)的轉(zhuǎn)換方式或強(qiáng)制的轉(zhuǎn)換方式作為返回值返回。
減少函數(shù)本身或函數(shù)間的遞歸調(diào)用。
盡量不要將函數(shù)的參數(shù)作為工作變量。
4.2 函數(shù)定義
函數(shù)若沒有入口參數(shù)或者出口參數(shù),應(yīng)用void明確申明。
函數(shù)名稱與出口參數(shù)類型定義間應(yīng)該空一格且只空一格。
函數(shù)名稱與括號(hào)()之間無空格。
函數(shù)形參必須給出明確的類型定義。
多個(gè)形參的函數(shù),后一個(gè)形參與前一個(gè)形參的逗號(hào)分割符之間添加一個(gè)空格。
函數(shù)體的前后花括號(hào)"{}" 各獨(dú)占一行。
4.3 局部變量定義
同一行內(nèi)不要定義過多變量。
同一類的變量在同一行內(nèi)定義,或者在相鄰行定義。
先定義data型變量,再定義idtata型變量,再定義xdata型變量.(?)
數(shù)組、指針等復(fù)雜類型的定義放在定義區(qū)的最后。
變量定義區(qū)不做較復(fù)雜的變量賦值。
4.4 功能實(shí)現(xiàn)區(qū)規(guī)范
一行只寫一條語句。
注意運(yùn)算符的優(yōu)先級(jí),并用括號(hào)明確表達(dá)式的操作順序,避免使用默認(rèn)優(yōu)先級(jí)。
各程序段之間使用一個(gè)空行分隔,加以必要的注釋。程序段指能完一個(gè)較具體的功能的一行或多行代碼。程序段內(nèi)的各行代碼之間相互依賴性較強(qiáng)。(1、2、3方式)
不要使用難懂的技巧性很高的語句。
源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。
完成簡(jiǎn)單功能、關(guān)系非常密切的一條或幾條語句可編寫為函數(shù)或定義為宏。
5.單片機(jī)編程規(guī)范-排版
5.1 縮進(jìn)
代碼的每一級(jí)均往右縮進(jìn)4個(gè)空格的位置。
不使用Tab鍵
5.2 分行
每行語句(?????超過80個(gè)字符)要分成多行書寫;長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行,操作符放在新行之首,劃分出的新行要進(jìn)適當(dāng)?shù)目s進(jìn),使排版整齊,語句可讀。避免把注釋插入分行中。
5.3 空行
文件注釋區(qū)、頭文件引用區(qū)、函數(shù)間應(yīng)該有且只有一行空行。
相鄰函數(shù)之間應(yīng)該有且只有一行空行。
函數(shù)體內(nèi)相對(duì)獨(dú)立的程序塊之間可以用一行空行或注釋來分隔。
函數(shù)注釋和對(duì)應(yīng)的函數(shù)體之間不應(yīng)該有空行。
文件末尾有且只有一行空行。
5.4 空格
函數(shù)語句尾部或者注釋之后不能有空格。
括號(hào)內(nèi)側(cè)(即左括號(hào)后面和右括號(hào)前面)不加空格,多重括號(hào)間不加空格。
函數(shù)形參之間應(yīng)該有且只有一個(gè)空格(形參逗號(hào)后面加空格)。
同一行中定義的多個(gè)變量間應(yīng)該有且只有一個(gè)空格(變量逗號(hào)后面加空格)。
表達(dá)式中,若有多個(gè)操作符連寫的情況,應(yīng)使用空格對(duì)它們分隔:
在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí),它們之間的操作符前后均加一個(gè)空格;在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行非對(duì)等操作時(shí),其前后均不應(yīng)加空格;
逗號(hào)只在后面加空格;
雙目操作符,如比較操作符, 賦值操作符"="、"+=",算術(shù)操作符"+"、"%",邏輯操作符"&&"、"&",位操作符"<<"、"^"等,前后均加一個(gè)空格;
單目操作符,如"!"、"~"、"++"、"-"、"&"(地址運(yùn)算符)等,前后不加空格;
"->"、"."前后不加空格;
if、for、while、switch等關(guān)鍵字與后面的括號(hào)間加一個(gè)空格;
5.5 花括號(hào)
if、else if、else、for、while語句無論其執(zhí)行體是一條語句還是多條語句都必須加花括號(hào),且左右花括號(hào)各獨(dú)占一行。
do{}while()結(jié)構(gòu)中,"do"和"{"均各占一行,"}"和"while();"共同占用一行。
if ( ) do
{ {
} }while( );
else
{
}
嵌套越少越好,{}不準(zhǔn)超過3層
5.6 switch語句
每個(gè)case和其判據(jù)條件獨(dú)占一行。
每個(gè)case程序塊需用break結(jié)束。特殊情況下需要從一個(gè)case塊順序執(zhí)行到下一個(gè)case塊的時(shí)候除外,但需要花括號(hào)在交界處明確注釋如此操作的原因,以防止出錯(cuò)。
case程序塊之間空一行,且只空一行。
每個(gè)case程序塊的執(zhí)行語句保持4個(gè)空格的縮進(jìn)。
一般情況下都應(yīng)該包含default分支。
Switch ( )
{
case x:
break;
case x:
break;
default:
break;
}
6.單片機(jī)編程規(guī)范-程序結(jié)構(gòu)
6.1 基本要求
有main()函數(shù)的.c文件應(yīng)將main()放在最前面,并明確用void聲明參數(shù)和返回值。
對(duì)由多個(gè).c文件組成的模塊程序或完整監(jiān)控程序,建立公共引用頭文件,將需要引用的庫頭文件、標(biāo)準(zhǔn)寄存器定義頭文件、自定義的頭文件、全局變量等均包含在內(nèi),供每個(gè)文件引用。通常,標(biāo)準(zhǔn)函數(shù)庫頭文件采用尖角號(hào)< >標(biāo)志文件名,自定義頭文件采用雙撇號(hào)″″標(biāo)志文件名。
每個(gè).c文件有一個(gè)對(duì)應(yīng)的.h文件,.c文件的注釋之后首先定義一個(gè)唯一的文件標(biāo)志宏,并在對(duì)應(yīng)的.h文件中解析該標(biāo)志。
在.c文件中:
#define FILE_FLAG
在.h文件中:
#ifdef FILE_FLAG
#define XXX
#else
#define XXX extern
#endif
對(duì)于確定只被某個(gè).c文件調(diào)用的定義可以單獨(dú)列在一個(gè)頭文件中、單獨(dú)調(diào)用。
6.2 可重入函數(shù)
可重入函數(shù)中若使用了全局變量,應(yīng)通過關(guān)中斷、信號(hào)量等操作手段對(duì)其加以保護(hù)。
6.3 函數(shù)的形參
由函數(shù)調(diào)用者負(fù)責(zé)檢查形參的合法性。
盡量避免將形參作為工作變量使用。
6.4 循環(huán)
盡量減少循環(huán)嵌套層數(shù)
在多重循環(huán)中,應(yīng)將最忙的循環(huán)放在最內(nèi)層
循環(huán)體內(nèi)工作量最小
盡量避免循環(huán)體內(nèi)含有判斷語句
7.工程中所包含的文件
7.1 頭文件
7.1.1 頭文件的形式
MCU程序中的頭文件包括面向硬件對(duì)象頭文件、公共頭文件和總頭文件。
MCU C工程編程是面向硬件對(duì)象的。例如,要用MCU控制電機(jī)(Motor),在這樣一個(gè)系統(tǒng)中,“面向硬件對(duì)象”概念體現(xiàn)在,工程中會(huì)創(chuàng)建“Motor.c”的源程序文件專門用于電機(jī)控制。相應(yīng)的,也要?jiǎng)?chuàng)建一個(gè)同名頭文件“Motor.h”,用于控制電機(jī)的MCU引腳定義、相關(guān)宏定義和電機(jī)控制函數(shù)聲明等。像這樣的頭文件,就是面向硬件對(duì)象頭文件。與之同名的“*.c”文件可以包含它,來完成控制此硬件對(duì)象的MCU引腳定義和相關(guān)宏定義;調(diào)用該硬件對(duì)象控制函數(shù)的文件也可以通過調(diào)用它來進(jìn)行函數(shù)聲明。
還有一類頭文件不是專門針對(duì)于特定的硬件對(duì)象的,而是有一定的通用性。這類頭文件被稱為公共頭文件。如工程中包含的“Type.h”文件,該文件用于C語言中類型的別名定義,用戶還可以根據(jù)自己的需要,隨時(shí)在該文件中添加條目。在工程的任一文件中,需要用到這些別名時(shí),都要包含“Type.h”。可見公共頭文件并不拘泥于具體的硬件對(duì)象,它是為整個(gè)工程的和諧運(yùn)作而建立的。
總頭文件(includes.h)是一個(gè)較特殊的頭文件。它只被主函數(shù)文件包含,用于包含主函數(shù)文件中需要的頭文件,宏定義,函數(shù)聲明等。它使得主函數(shù)文件能夠盡量避免改動(dòng),結(jié)構(gòu)更加清晰。
7.1.2 頭文件的命名
總的來說頭文件的命名應(yīng)盡量做到簡(jiǎn)短易懂,見名知意。
面向硬件對(duì)象頭文件的名稱一定要與相應(yīng)的硬件對(duì)象驅(qū)動(dòng)文件同名。例???
公共頭文件,如果對(duì)應(yīng)于相應(yīng)的源程序文件而建立,必須與之同名。如,“GeneralFun.c”
是工程中的通用函數(shù)定義文件,(像內(nèi)存數(shù)據(jù)移動(dòng)函數(shù),延時(shí)函數(shù)都屬于通用函數(shù)),其他文件在用到這些函數(shù)之前,必須進(jìn)行函數(shù)原型聲明,從而建立與之同名的“GeneralFun.h”文件,專門用于相應(yīng)的函數(shù)聲明。其它的公共頭文件沒有同名要求,只要表清文件含義即可,如“Type.h”,“GP32C.h”等。
總頭文件在一個(gè)工程中只有一個(gè),它的名稱較為固定,一般取為“Includes.h”
7.1.3 頭文件注意事項(xiàng)
為了防止重復(fù)定義需要使用偽指令 #ifndef VarType ……
例:
#ifndef VarType
#define VarType
typedef unsigned char INT8U; //無符號(hào)8位數(shù)
typedef signed char INT8S; //有符號(hào)8位數(shù)
typedef unsigned int INT16U; //無符號(hào)16位數(shù)
typedef signed int INT16S; //有符號(hào)16位數(shù)
typedef unsigned long INT32U; //無符號(hào)32位數(shù)
typedef signed long INT32S; //有符號(hào)32位數(shù)
typedef float FP32; //單精度浮點(diǎn)數(shù)
typedef double FP64; //雙精度浮點(diǎn)數(shù)
#endif
對(duì)于一個(gè)項(xiàng)目中的頭文件與芯片相關(guān)的寄存器映像文件不可擅自改動(dòng),如果的確存在需要改動(dòng)的地方另外開辟頭文件。
typedef和#define的用法
① typedef的用法
在C/C++語言中,typedef常用來定義一個(gè)標(biāo)識(shí)符及關(guān)鍵字的別名,它是語言編譯過程的一部分,但它并不實(shí)際分配內(nèi)存空間,實(shí)例像:
typedef int INT;
typedef int ARRAY[10];
typedef (int*) pINT;
typedef可以增強(qiáng)程序的可讀性,以及標(biāo)識(shí)符的靈活性,但它也有“非直觀性”等缺點(diǎn)。
② #define的用法
#define為一宏定義語句,通常用它來定義常量(包括無參量與帶參量),以及用來實(shí)現(xiàn)那些“表面似和善、背后一長(zhǎng)串”的宏,它本身并不在編譯過程中進(jìn)行,而是在這之前(預(yù)處理過程)就已經(jīng)完成了,但也因此難以發(fā)現(xiàn)潛在的錯(cuò)誤及其它代碼維護(hù)問題,它的實(shí)例像:
#define INT int
#define TRUE 1
#define Add(a,b) ((a)+(b));
#define Loop_10 for (int i=0; i<10; i++)
③ typedef與#define的區(qū)別
從以上的概念便也能基本清楚,typedef只是為了增加可讀性而為標(biāo)識(shí)符另起的新名稱(僅僅只是個(gè)別名),而#define原本在C中是為了定義常量,到了C++,const、enum、inline的出現(xiàn)使它也漸漸成為了起別名的工具。為了盡可能地兼容,一般都遵循#define定義“可讀”的常量以及一些宏語句的任務(wù),而typedef則常用來定義關(guān)鍵字、冗長(zhǎng)的類型的別名。
宏定義只是簡(jiǎn)單的字符串代換(原地?cái)U(kuò)展),而typedef則不是原地?cái)U(kuò)展,它的新名字具有一定的封裝性,以致于新命名的標(biāo)識(shí)符具有更易定義變量的功能。請(qǐng)看上面第一大點(diǎn)代碼的第三行:
typedef (int*) pINT;
以及下面這行:
#define pINT2 int*
效果相同?實(shí)則不同!實(shí)踐中見差別:
pINT a,b;的效果同int *a; int *b;
表示定義了兩個(gè)整型指針變量。
而pINT2 a,b;的效果同int *a, b;表示定義了一個(gè)整型指針變量a和整型變量b。
注意:兩者還有一個(gè)行尾;號(hào)的區(qū)別哦!(???)
7.2 源程序文件
源程序文件包括主函數(shù)文件、通用函數(shù)文件、硬件對(duì)象控制文件、芯片初始化文件、中斷向量定義文件和中斷使能文件。
源程序文件的分類和命名類同于頭文件,但也有它自己的特點(diǎn)。
7.2.1 主程序文件
(Main.s 或 Main.c)(?????)
工程中有且僅有一個(gè)主程序文件,它包含了工程的主處理流程。
主函數(shù)文件中包含:
(1)工程描述
①工程名
工程名中每個(gè)意義單詞(或單詞縮寫)的首字母大寫,后綴為.prj。
②硬件連接索引
工程所要控制的硬件對(duì)象索引,詳細(xì)描述在相應(yīng)的硬件對(duì)象控制文件中給出。
③工程的功能、目的和說明
④注意要點(diǎn)
可以注明編程要點(diǎn)和心得
⑤日期
注明工程完成日期
(2)總頭文件
(3)主函數(shù)
如:
//-------------------------------------------------------------------------* //工程文件名:PrgFrame.prj * //硬件連接: * // (1)MCU的I/O口引腳接小燈(見"LED.c"文件說明) * //程序描述:用I/O口控制小燈閃爍 * //目 的:第1個(gè)freescale HC08系列MCU C語言程序框架 * //說 明:提供Motorola MCU的編程框架,供教學(xué)入門使用 * //注 意:如果延時(shí)不夠長(zhǎng)的話,會(huì)發(fā)覺燈不會(huì)閃爍,而是一直亮,這是由于人的 * // 視覺的引起的. * //日 期:2006.12.29 * //-------------------《嵌入式技術(shù)基礎(chǔ)與實(shí)踐》實(shí)例--------------------------*
#include "Includes.h" //總頭文件 //主函數(shù) void main() {
MCUInit(); LEDInit(); //小燈控制引腳初始化 //程序總循環(huán)入口 while(1) {
LED_L_A('L'); //小燈亮 Delay(10000); //延時(shí)
LED_L_A('A'); //小燈暗 Delay(10000); //延時(shí) } } |
7.2.2 芯片初始化文件(“SetUp.c”或 “SetUp.s”)
該文件與具體的芯片型號(hào)有關(guān),并且只包含一個(gè)芯片初始化函數(shù),若想由編譯器自動(dòng)調(diào)用芯片初始化函數(shù),其函數(shù)名必須為"_HC08Setup",否則編譯器會(huì)自動(dòng)建立并調(diào)用一個(gè)空的"__HC08Setup"匯編子程序,而不理會(huì)用戶創(chuàng)建的芯片初始化函數(shù)。為了統(tǒng)一,將該函數(shù)起名為"MCUInit",并在主函數(shù)中調(diào)用該函數(shù)。
7.2.3 通用函數(shù)頭文件和通用函數(shù)文件
通用函數(shù)頭文件和通用函數(shù)文件,“GenneralFun.h”和“GeneralFun.c”。
//[GenneralFun.h]通用函數(shù)頭文件---------------------------------------------
#include"Type.h" //類型別名定義
void Delay(INT16U); //延時(shí)函數(shù)聲明
|
“GenneralFun.h”中包含:
(1)文件名
(2)通用函數(shù)所需用到的頭文件
(3)通用函數(shù)用到的宏定義
(4)通用函數(shù)聲明
外部函數(shù)要用到通用函數(shù)時(shí),可包含這個(gè)頭文件進(jìn)行函數(shù)聲明。
//[GenneralFun.c]通用函數(shù)--------------------------------------------------* //本文件包含: * //(1)Delay:延時(shí)函數(shù) * //-------------------------------------------------------------------------*
#include "GeneralFun.h" //該頭文件中包含了類型別名定義
//Delay:延時(shí)函數(shù)-----------------------------------------------------------* //功 能:用程序的方法延時(shí)一段時(shí)間 * //參 數(shù):k=延時(shí)長(zhǎng)度(0-65535) * //返 回:無 * //-------------------------------------------------------------------------* void Delay(INT16U k) { INT16U u; for(u=0;u<=k;u++); }
|
“GeneralFun.c”中包含:
(1)文件描述:
①文件中的函數(shù)的索引
(2)頭文件
通用函數(shù)所需頭文件和宏定義可都放在“GeneralFun.h”中,“GeneralFun.c”中只要包含該頭文件即可。
(3)通用函數(shù)定義
每個(gè)函數(shù)前要有相應(yīng)的函數(shù)描述,包括函數(shù)名,函數(shù)的功能、參數(shù)和返回,必要時(shí)還可加上函數(shù)說明。工程可以根據(jù)需要向“GeneralFun.c”文件中添加通用函數(shù),如內(nèi)存數(shù)據(jù)移動(dòng)函數(shù)、延時(shí)函數(shù)這樣的通用函數(shù)都可以放入其中。
7.2.4 對(duì)象控制文件
對(duì)象控制文件以小燈驅(qū)動(dòng)頭文件和小燈驅(qū)動(dòng)文件為例說明。
//[LED.h]小燈驅(qū)動(dòng)頭文件-----------------------------------------------------
//小燈控制需要用到的頭文件 #include "GP32C.h" //映像寄存器名定義 #include "Type.h" //類型別名定義
//小燈控制引腳定義 #define Light_P PTA //燈(Light)接在PTA口 #define Light_D DDRA //相應(yīng)的方向寄存器 #define Light_Pin 1 //燈所在的引腳
//小燈控制相關(guān)函數(shù)聲明 void LEDInit(void); //定義控制小燈的MCU引腳為輸出 void LED_L_A(INT8U flag); //驅(qū)動(dòng)小燈"亮"、"暗"
|
“LED.h”中包含:
(1)文件名
(2)小燈控制所需用到的頭文件
(3)小燈控制引腳定義
(4)小燈控制函數(shù)聲明
外部函數(shù)要用到小燈控制函數(shù)時(shí),可包含這個(gè)頭文件進(jìn)行函數(shù)聲明。
//[LED.c]小燈驅(qū)動(dòng)----------------------------------------------------------* //本文件包含: * // (1) LEDInit:定義控制小燈的MCU的I/O引腳為輸出 * // (2) LED_L_A:驅(qū)動(dòng)小燈"亮"、"暗" * //硬件連接: * // (1)本處的小燈是一個(gè)發(fā)光二極管,由MCU的I/O引腳控制 * // (2)控制引腳=高電平時(shí),小燈"暗";反之,小燈"亮" * //-------------------------------------------------------------------------*
#include"LED.h" //該頭文件中包含了小燈控制引腳定義和相關(guān)函數(shù)聲明
//LEDInit:定義控制小燈的MCU引腳為輸出-------------------------------------* //功能:定義控制小燈的MCU引腳為輸出,并使小燈初始為暗 * //參數(shù):無 * //返回:無 * //-------------------------------------------------------------------------* void LEDInit(void) { Light_D|=1< Light_P|=1< }
//LED_L_A:驅(qū)動(dòng)小燈"亮"、"暗"-----------------------------------------------* //功能:根據(jù)flag的值控制小燈的亮和暗 * //參數(shù):flag(flag='A',小燈暗;flag='L',小燈亮) * //返回:無 * //-------------------------------------------------------------------------* void LED_L_A(INT8U flag) { if(flag=='A') Light_P|=1< else if(flag=='L') Light_P&=~(1< }
|
“LED.c”中包含:
(1)文件描述:
①文件中的函數(shù)的索引
②硬件對(duì)象及其與MCU的連接描述
(2)頭文件
小燈控制所需用到的頭文件和小燈控制引腳定義及小燈控制函數(shù)中用到的其他常量聲明可全部已放在“LED.h”中,“LED.c”只要包含該頭文件即可。
(3)小燈驅(qū)動(dòng)函數(shù)定義
每個(gè)函數(shù)前要有相應(yīng)的函數(shù)描述,包括函數(shù)名,函數(shù)的功能、參數(shù)和返回,必要時(shí)還可加上函數(shù)說明。
7.2.5 中斷處理函數(shù)和中斷向量表文件
//[Vectors08.c]中斷處理函數(shù)與中斷向量表------------------------------------* //功能: * // (1)定義中斷處理子程序 * // (2)放置中斷向量表 * //說明:該文件與芯片具體型號(hào)有關(guān). * // (1)芯片型號(hào)MC68HC908GP32 * //-------------------------------------------------------------------------*
//此處為用戶中斷處理函數(shù)的存放處
//未定義的中斷處理函數(shù),本函數(shù)不能刪除 #pragma interrupt_handler isrDummy void isrDummy(void) { }
//中斷矢量表,需定義中斷函數(shù),可修改下表中的相應(yīng)項(xiàng)目 //(interrupt service routine,isr 中斷處理程序) #pragma abs_address:0xffdc //中斷向量表起始地址 void (* const _vectab[])(void) = { isrDummy, //時(shí)基中斷 isrDummy, //AD轉(zhuǎn)換中斷 isrDummy, //鍵盤中斷 isrDummy, //SCI發(fā)送中斷 isrDummy, //SCI接收中斷 isrDummy, //SCI錯(cuò)誤中斷 isrDummy, //SPI發(fā)送中斷 isrDummy, //SPI錯(cuò)誤中斷 isrDummy, //TIM2溢出中斷 isrDummy, //TIM2通道1輸入捕捉/輸出比較中斷 isrDummy, //TIM2通道0輸入捕捉/輸出比較中斷 isrDummy, //TIM1溢出中斷 isrDummy, //TIM1通道1輸入捕捉/輸出比較中斷 isrDummy, //TIM1通道0輸入捕捉/輸出比較中斷 isrDummy, //CGM的PLL鎖相狀態(tài)變化中斷 isrDummy, //IRQ引腳中斷 isrDummy //SWI指令中斷 //RESET是特殊中斷,其向量由開發(fā)環(huán)境直接設(shè)置(在本軟件系統(tǒng)的crt08.o文件中) }; #pragma end_abs_address
|
該文件與具體的芯片型號(hào)有關(guān),可以根據(jù)需要向,文件中添加相應(yīng)的中斷向量和中斷處理函數(shù)。
7.3 最小工程文件集
第一個(gè)C工程”PrgFrame.prj”給出了Motorola MCU編程框架,同時(shí)它也是一個(gè)很好的編程規(guī)范示例。下面講解C工程編程規(guī)范,就以該工程為例。
圖1給出了PrgFrame.prj的最小文件集,由于該工程中只用到復(fù)位中斷,且其中斷向量由開發(fā)環(huán)境直接設(shè)置,所以工程中可以不包含中斷向量定義文件“vectors08.c”(實(shí)際工程中包含這個(gè)文件,是為了確立一個(gè)標(biāo)準(zhǔn)的工程框架)。
小燈驅(qū)動(dòng)頭文件(LED.h) 頭文件 總頭文件(Includes.h) 面向硬件對(duì)象頭文件 公共頭文件 類型別名定義頭文件(Type.h) 通用函數(shù)頭文件(GeneralFun.h) GP32映像寄存器名定義頭文件(GP32C.h) 注意圖(1)中的源程序文件和頭文件的對(duì)應(yīng)關(guān)系: ① GenneralFun.c ßà GenneralFun.h ② LED.c ßà LED.h |
| 歡迎光臨 (http://m.raoushi.com/bbs/) | Powered by Discuz! X3.1 |