1.寫在前面

spi（Serial Peripheral Interface）即序列外設介面。與i2c一樣，spi也常用外設裝置通訊的匯流排，從事嵌入式開發必不可少的掌握。根據本人以往的經歷，對spi進行總結（主要是MCU範疇，Linux已有成熟的驅動裝置），主要目的及實現：

a）spi匯流排與spi裝置分離；

b）快速使用新的硬體spi或者模擬spi；

c）方便移植spi匯流排裝置及spi外設程式到不同mcu平臺。

2.spi匯流排抽象

此部分實現原始碼為：spi_core.c spi_core.h

1）spi匯流排模型對外介面（API）

/*extern function*/
extern int spi_send_then_recv(struct spi_dev_device *spi_dev,const void *send_buff,
			      unsigned short send_size,void *recv_buff,unsigned short recv_size);
extern int spi_send_then_send(struct spi_dev_device *spi_dev,const void *send_buff1,
			      unsigned short send_size1,const void *send_buff2,unsigned short send_size2);
extern int spi_send_recv(struct spi_dev_device *spi_dev,const void *send_buff,void *recv_buff,unsigned short data_size);
extern int spi_send(struct spi_dev_device *spi_dev,const void *send_buff,unsigned short send_size);
 

a）spi_send_then_recv，標準spi，常規操作，傳送完一幀再接收，如讀取某晶片暫存器的值；

b）spi_send_then_send，標準spi，常規操作，傳送完一幀再發送，如向某晶片暫存器（地址）寫入資料；

c）spi_send_recv，非標spi，具體看晶片時序圖，產生時鐘訊號，傳送完成的同時，也接收完成；第二種情況是，只接收，傳送動作只是用來產生時鐘訊號，如一些AD晶片；

d）spi_send，標準或非標spi都使用，只發送無返回值或者無須理會返回值，如spi LCD屏。

2）spi匯流排抽象API實現

以“spi_send_then_recv”函式為例：

a）spi_dev：spi裝置指標，型別為“struct spi_dev_device”，驅動一個spi外設時，首先需要對此指標進行初始化；

b）send_buff：待發送資料（快取）；

c）send_size：傳送資料量大小（單位位元組）；

d）：recv_buff：存放返回值資料快取（地址）；

e）：recv_size：返回資料量大小。

另外3個函式，第一個引數都為spi裝置指標，其他引數為傳送/接收緩衝區，收發資料量等，通過變數名即可看出。

3）struct spi_dev_device

該結構體為關鍵，呼叫API驅動一個外設時，需要先初始化（類似Linux的註冊裝置驅動）。一個完整的spi外設，包括片選和匯流排量部分，一個匯流排可和多個片選組成，驅動多個外設，因此struct spi_dev_device設計原型為：

struct spi_dev_device
{	
	void 	 (*spi_cs)(unsigned char state);	
	struct spi_bus_device	*spi_bus;	
};

a）第一個引數為函式指標，主要功能的實現spi外設片選的選擇（拉低/拉高）功能；
c）第二個引數為spi匯流排相關的結構體指標，主要是底層相關收據收發的的功能，具體繼續往下看改結構體。

4）struct spi_bus_device *spi_bus

該結構體為底層硬體相關的spi匯流排實現，具體由實際需求實現，如用硬體spi還是用模擬spi。struct spi_bus_device*spi_bus原型為：

struct spi_bus_device
{	
	int 		(*spi_bus_xfer)(struct spi_dev_device *spi_bus,struct spi_dev_message *msg);
	void		*spi_phy;
	unsigned char   data_width;
};

a）第一個引數是函式指標，為spi匯流排收發函式，這部分就是我們平常寫裸機程式碼時候寫到的，只是這裡把它放在一個結構體裡面，以函式指標的方式實現；這樣的好處是，上層介面不變，更好其他MCU或者使用模擬spi時，只需修改此部分的函式實體，上層程式碼不需變動。

b）第二個引數，一個指標，表示具體物理spi，如stm32的SPI1、SPI2，或者模擬spi；

c）第三引數，資料寬度，一般是8bit或者16bit。

其他引數，如資料速率、spi模式等，其實也可以放在此處，只是個人覺得此類引數不常變動，為了節約記憶體，故不加入此結構體配置中。下面中斷分析函式指標

“int (*spi_bus_xfer) (struct spi_dev_device *spi_bus,struct spi_dev_message *msg)”的實現。

5）spi_bus_xfer

該函式指標入口引數為spi裝置指標（struct spi_dev_device ）、spi裝置資訊幀指標（struct spi_dev_message）。struct spi_dev_device與前面提及的為同一類引數，struct spi_dev_message為收發資料資訊幀，其原型如下：

struct spi_dev_message
{
    const void  *send_buf;
    void        *recv_buf;
    int 	length;
    unsigned char cs_take    : 1;
    unsigned char cs_release : 1;
};

a）send_buf：待發送資料（快取）；

b）recv_buf：存放返回值資料快取（地址）；

c）length：傳送/接收資料長度；

d）cs_take：使能片選；

e）cs_release：釋放片選。

3.spi匯流排抽象實現

此部分實現原始碼為：spi_hw.c spi_hw.h

1）spi匯流排抽象API實現

A）“spi_send_then_recv”，實現程式碼如下：

int spi_send_then_recv(struct spi_dev_device *spi_dev,const void *send_buff,unsigned short send_size,void *recv_buff,unsigned short recv_size)
{
	struct spi_dev_message message;
	
	message.length 	= send_size;
	message.send_buf   = send_buff;
	message.recv_buf   = 0;
	message.cs_take    = 1;
        message.cs_release = 0;
	spi_dev->spi_bus->spi_bus_xfer(spi_dev,&message);
	
	message.length 	= recv_size;
	message.send_buf   = 0;
	message.recv_buf   = recv_buff;
	message.cs_take    = 0;
        message.cs_release = 1;
	spi_dev->spi_bus->spi_bus_xfer(spi_dev,&message);

	return 0;
}

實現的功能是，spi傳送完一幀後再接收一幀資料。

a）spi_dev即是傳入的裝置指標；

b）收發引數主要傳遞給“spi_dev_message”；

c）對於第一幀“spi_dev_message”，不接收返回值，所以recv_buf設定空（0）；此時片選拉低（cs_take=1），傳送完還不能拉高片選（cs_release=0），待後面接收幀接收完再拉高片選（cs_release=1），從外設時序圖也可以看出；

d）對於第二幀，此時傳送資料為空，所以send_buf設定為0，此時的傳送動作並非真的傳送，只是用來產生接收資料的時鐘訊號。

B）spi_send_then_send，與spi_send_then_recv類似，只是後面的“接收”動作變為“傳送”動作，故不作重複分析，原始碼看附件。

C）spi_send_recv，實現程式碼如下：

int spi_send_recv(struct spi_dev_device *spi_dev,const void *send_buff,void *recv_buff,unsigned short data_size)
{
	message.length 	 = data_size;
	message.send_buf = send_buff;
	message.recv_buf = recv_buff;
	message.cs_take  = 1;
        message.cs_release = 1;
	spi_dev->spi_bus->spi_bus_xfer(spi_dev,&message);
	
	return 0;
}

實現功能是傳送完同時接收完，或者只接收。

a）spi_dev即是傳入的裝置指標；

b）收發資料及長度由使用者通過形參傳入，只接收時，傳送資料快取可設定為空（0）；

c）操作前拉低片選（cs_take=1），操作完成片選拉高（cs_release=1）；

D）spi_send，實現程式碼如下：

int spi_send(struct spi_dev_device *spi_dev,const void *send_buff,unsigned short send_size)
{
	struct spi_dev_message message;
	
	message.length 	  = send_size;
	message.send_buf  = send_buff;
	message.recv_buf  = 0;
	message.cs_take   = 1;
        message.cs_release = 1;
	spi_dev->spi_bus->spi_bus_xfer(spi_dev,&message);
	
	return 0;
}

該函式與spi_send_recv非常類似，但只有“傳送”動作，無“接收”動作，故recv_buf設定為空（0）。
2）spi匯流排抽象底層實現（以stm32為例）

主要實現“struct spi_bus_device”中的“spi_bus_xfer”函式，此部分相當於平常裸機程式碼。以8bit模式為例，程式碼如下，詳細程式碼看附件“spi_hw.c”。

static int stm32_spi_bus_xfer(struct spi_dev_device *spi_dev,struct spi_dev_message *msg)
{
	int size;
	SPI_TypeDef	*SPI_NO;
	
	SPI_NO = (SPI_TypeDef	*)spi_dev->spi_bus->spi_phy;
	 size = msg->length;
	if(msg->cs_take)
	{// take CS 
		spi_dev->spi_cs(0);
	}
        if(spi_dev->spi_bus->data_width <=8)
	{
                const unsigned short * send_ptr = msg->send_buf;
		unsigned short *recv_ptr = msg->recv_buf;
			
		while(size--)
		{
			unsigned short data = 0xFF;

			if(send_ptr != 0)
			{
				data = *send_ptr++;
			}
			while (SPI_I2S_GetFlagStatus(SPI_NO, SPI_I2S_FLAG_TXE) == RESET); 
			SPI_I2S_SendData(SPI_NO, data);
			while (SPI_I2S_GetFlagStatus(SPI_NO, SPI_I2S_FLAG_RXNE) == RESET); 
			data = SPI_I2S_ReceiveData(SPI_NO); 

			if(recv_ptr != 0)
			{
				*recv_ptr++ = data;
			}
		}
	}
	if(msg->cs_release)
	{// release CS 
		spi_dev->spi_cs(1);
	}
	return msg->length;
}	

主要功能：
a）資料收發，片選選擇/釋放；
b）分為8bit模擬和16bit模式收/發。
3）最後一步，相關初始化，如IO口、時鐘、spi相關配置。

void stm32f1xx_spi_init(struct spi_bus_device *spi0,unsigned char byte_size0,struct spi_bus_device *spi1,unsigned char byte_size1)
{
	SPI_InitTypeDef  SPI_InitStructure;
	GPIO_InitTypeDef GPIO_InitStructure;	
	
	if(spi0)
	{//SPI1
		RCC_APB2PeriphClockCmd(RCC_APB2Periph_SPI1, ENABLE);
		SPI_InitStructure.SPI_Direction = SPI_Direction_2Lines_FullDuplex;
		SPI_InitStructure.SPI_Mode = SPI_Mode_Master;
		if(byte_size0 <= 8)
			SPI_InitStructure.SPI_DataSize = SPI_DataSize_8b;		
		else
			SPI_InitStructure.SPI_DataSize = SPI_DataSize_16b;						
		SPI_InitStructure.SPI_CPOL = SPI_CPOL_Low;
		SPI_InitStructure.SPI_CPHA = SPI_CPHA_1Edge;
		SPI_InitStructure.SPI_NSS = SPI_NSS_Soft;										
		SPI_InitStructure.SPI_BaudRatePrescaler = SPI_BaudRatePrescaler_64;
		SPI_InitStructure.SPI_FirstBit = SPI_FirstBit_MSB;					
		SPI_InitStructure.SPI_CRCPolynomial = 7;
		SPI_Init(SPI1, &SPI_InitStructure);
		SPI_Cmd(SPI1, ENABLE);	
		//spi io
		RCC_APB2PeriphClockCmd(RCC_APB2Periph_GPIOA | RCC_APB2Periph_GPIOC | RCC_APB2Periph_AFIO,ENABLE);
		GPIO_InitStructure.GPIO_Pin = GPIO_Pin_5 | GPIO_Pin_6 | GPIO_Pin_7;
		GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;
		GPIO_InitStructure.GPIO_Mode = GPIO_Mode_AF_PP;
		GPIO_Init(GPIOA, &GPIO_InitStructure);
		spi0->data_width = byte_size0;
		spi0->spi_bus_xfer = stm32_spi_bus_xfer;
		spi0->spi_phy	= SPI1;
	}
}

注意問題點：

a）spi 4種模式根據器件時序圖選擇，一般選擇第一種（L，1）或者第三種（H，2）；

b）片選控制模式（SPI_NSS）必須選擇軟體控制模式；

c）設定為“全雙工模式”，此模式下能夠適應各類標準、非標準spi；

d）spi0指標初始化，即是隻需上一步我們實現的函式實體，及相關spi引數。

4）小結

至此，一個stm32硬體spi匯流排實現完畢，剩下的就是利用這個匯流排驅動一個spi外設。也可以通過io口模擬spi，後面再寫一篇使用模擬spi的文章，主要改動也在此處，匯流排程式或者下面的外設程式都無需修改。

4.使用spi抽象（以25aa256 EEPROM為例）

此部分實現原始碼為：25xx.c 25xx.h

1）初始化（註冊裝置）

採用stm32 SPI2驅動25aa256，步驟如下：

a）定義spi匯流排裝置及EEPROM裝置

struct 	spi_dev_device	ee_25xx_spi_dev;
struct 	spi_bus_device 	spi_bus1;

b）初始化IO及2個裝置指標

首先實現片選函式實體，片選（CS）IO為PB12。

static void spi1_cs(unsigned char state)
{
	if (state)
		GPIO_SetBits(GPIOB, GPIO_Pin_12);
	else
		GPIO_ResetBits(GPIOB, GPIO_Pin_12);
}

初始化25aa256.

void ee_25xx_init(void)
{
	GPIO_InitTypeDef GPIO_InitStructure;
		
	//SPI2 cs
	RCC_APB2PeriphClockCmd(RCC_APB2Periph_GPIOB,ENABLE);
	GPIO_InitStructure.GPIO_Pin = GPIO_Pin_12;
	GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;
	GPIO_InitStructure.GPIO_Mode = GPIO_Mode_Out_PP;										
	GPIO_Init(GPIOB, &GPIO_InitStructure); 
	GPIO_SetBits(GPIOB, GPIO_Pin_12);
			
	//device init
	st32f1xx_spi_init(0,&spi_bus1);
	ee_25xx_spi_dev.spi_cs 	= spi1_cs;
	ee_25xx_spi_dev.spi_bus = &spi_bus1;			
}

“ee_25xx_spi_dev”即是我們“註冊”的裝置，下面可通過上面描述API操作25aa256，傳入引數為“ee_25xx_spi_dev”地址（指標）。

2）操作（讀寫）25aa256

a）25aa256使能暫存器操作

void ee_25xx_write_enable(uint8_t select)
{
        spi_send(&ee_25xx_spi_dev,&select,1);
}

該操作用到“spi_send”介面，無返回值，簡單明瞭！

b）向25aa256寫入1位元組資料

void ee_25xx_write_byte(uint16_t write_addr,uint8_t write_data)
{
	uint8_t send_buff[3];
	
	ee_25xx_write_enable(REG_WRITE_ENABLE);
	send_buff[0] = REG_WRITE_COMMAND;
	send_buff[1] = (write_addr>>8)&0xff;
	send_buff[2] = write_addr&0xff;
	spi_send_then_send(&ee_25xx_spi_dev,send_buff,3,&write_data,1);
	ee_25xx_write_enable(REG_WRITE_DISABLE);
}

該操作用到“spi_send_then_send”介面，從函式名稱也可以很好地理解。基本步驟為：

——使能25aa256；

——傳送快取填充，此部分包括寫命令、寫地址；
——寫資料填充，單個位元組直接呼叫形參，無額外申請記憶體；

——呼叫“spi_send_then_send”，完成寫操作。

c）從25aa256讀取資料

void ee_25xx_read_bytes(uint16_t read_addr,uint8_t *read_buff,uint16_t read_bytes)
{
	uint8_t send_buff[3];
	
	send_buff[0] = REG_READ_COMMAND;
	send_buff[1] = (read_addr>>8)&0xff;
	send_buff[2] = read_addr&0xff;
	spi_send_then_recv(&ee_25xx_spi_dev,send_buff,3,read_buff,read_bytes);
}

該操作用到“spi_send_then_recv”介面。基本步驟為：

——傳送快取填充，此部分包括寫命令、寫地址；
——形參地址傳遞作為接收地址；

——呼叫“spi_send_then_send”，完成讀操作。

d）25aa256寫狀態暫存器、讀狀態暫存器，同理，詳細看原始碼。

c) 25aa256頁寫演算法與i2c介面的EEPROM（AT24c16）原理相同，可以檢視另一篇文章：http://blog.csdn.net/qq_20553613/article/details/78550427

3）25aa256驅動小結

至此，完成25aa256的驅動程式，所有操作通過上述4個API介面，移植到新的mcu平臺時，該器件驅動程式幾乎無須修改，只需修改spi底層相關的函式。驅動其他spi外設，與25aa256的流程步驟一致。其實，通過此問題也可發現，驅動一個裝置是相對簡單，更多的難點是在應用，比如25aa256的頁寫演算法。因此，把底層“輪子”造好後，不需再重複造輪子，把更多的時間花在研究應用上面。

5.總結

本文主要描述mcu下spi匯流排的抽象分層，主要實現手段是充分利用結構體和函式指標。

1）使用spi匯流排、增加新匯流排、移植到新平臺等，只需將“struct   spi_bus_device”中函式指標例項化，spi相關引數初始化即可；

2）驅動一個外設時，首先加入片選例項化函式，初始化“struct  spi_dev_device”，然後呼叫4個API函式操作外設；

3）同一個匯流排可以掛多個外設，即是定義多個“struct spi_dev_device”指標，此時片選函式需額外定義，匯流排指標初始化為已初始的匯流排例項；假設再增加一個adc外設：

struct 	spi_dev_device	adc_spi_dev;
static void spi1_cs1(unsigned char state)
{
	if (state)
		GPIO_SetBits(GPIOB, GPIO_Pin_11);
    	else
		GPIO_ResetBits(GPIOB, GPIO_Pin_11);
}

void adc_init(void)
{
	GPIO_InitTypeDef GPIO_InitStructure;
		
	//SPI cs
	RCC_APB2PeriphClockCmd(RCC_APB2Periph_GPIOB,ENABLE);
	GPIO_InitStructure.GPIO_Pin = GPIO_Pin_11;
	GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;
	GPIO_InitStructure.GPIO_Mode = GPIO_Mode_Out_PP;										
	GPIO_Init(GPIOB, &GPIO_InitStructure); 
	GPIO_SetBits(GPIOB, GPIO_Pin_11);
			
	//device init
	//st32f1xx_spi_init(0,&spi_bus1); //共用spi1，已經初始化過，無需重複初始化
	adc_spi_dev.spi_cs = spi1_cs1;    //片選函式必須獨立
	adc_spi_dev.spi_bus = &spi_bus1;  //指向spi1			
}

4）至於非標準spi，大部分情況都可以用此4個API實現，目前為止，鄙人所用過的spi器件都可以實現。

6.原始碼

[1]  https://github.com/Prry/drivers-for-mcu

7.參考

[1]  https://github.com/RT-Thread/rt-thread