SPI总线和设备驱动

软件架构

在内核的SPI驱动的软件架构中，进行了合理的分层和抽象，如下图所示：

SPI控制器驱动程序

SPI控制器不用关心设备的具体功能，它只负责把上层协议驱动准备好的数据按SPI总线的时序要求发送给SPI设备，同时把从设备收到的数据返回给上层的协议驱动，因此，内核把SPI控制器的驱动程序独立出来。SPI控制器驱动负责控制具体的控制器硬件，诸如DMA和中断操作等等，因为多个上层的协议驱动可能会通过控制器请求数据传输操作，所以，SPI控制器驱动同时也要负责对这些请求进行队列管理，保证先进先出的原则。

SPI通用接口封装层

为了简化SPI驱动程序的编程工作，同时也为了降低协议驱动程序和控制器驱动程序的耦合程度，内核把控制器驱动和协议驱动的一些通用操作封装成标准的接口，加上一些通用的逻辑处理操作，组成了SPI通用接口封装层。这样的好处是，对于控制器驱动程序，只要实现标准的接口回调API，并把它注册到通用接口层即可，无需直接和协议层驱动程序进行交互。而对于协议层驱动来说，只需通过通用接口层提供的API即可完成设备和驱动的注册，并通过通用接口层的API完成数据的传输，无需关注SPI控制器驱动的实现细节。

SPI协议驱动程序

上面我们提到，控制器驱动程序并不清楚和关注设备的具体功能，SPI设备的具体功能是由SPI协议驱动程序完成的，SPI协议驱动程序了解设备的功能和通信数据的协议格式。向下，协议驱动通过通用接口层和控制器交换数据，向上，协议驱动通常会根据设备具体的功能和内核的其它子系统进行交互，例如，和MTD层交互以便把SPI接口的存储设备实现为某个文件系统，和TTY子系统交互把SPI设备实现为一个TTY设备，和网络子系统交互以便把一个SPI设备实现为一个网络设备，等等。当然，如果是一个专有的SPI设备，我们也可以按设备的协议要求，实现自己的专有协议驱动。

SPI通用设备驱动程序

有时候，考虑到连接在SPI控制器上的设备的可变性，在内核没有配备相应的协议驱动程序，对于这种情况，内核为我们准备了通用的SPI设备驱动程序，该通用设备驱动程序向用户空间提供了控制SPI控制的控制接口，具体的协议控制和数据传输工作交由用户空间根据具体的设备来完成，在这种方式中，只能采用同步的方式和SPI设备进行通信，所以通常用于一些数据量较少的简单SPI设备。

确定驱动文件

SPI作为linux里面比较小的一个子系统，其驱动程序位于/drivers/spi/*目录，首先，我们可以通过Makefile及Kconfig来确定我们需要看的源文件：

Makefile：

\#
\# Makefile for kernel SPI drivers.
\#
……………………………………………….
\# small core, mostly translating board-specific
\# config declarations into driver model code
obj-$(CONFIG_SPI_MASTER)		+= spi.o			

\# SPI master controller drivers (bus)
…………………………………………………
obj-$(CONFIG_SPI_BITBANG)		+= spi_bitbang.o
…………………………………………………
obj-$(CONFIG_SPI_S3C24XX_GPIO)		+= spi_s3c24xx_gpio.o
obj-$(CONFIG_SPI_S3C24XX)		+= spi_s3c24xx.o
…………………………………………………
\# 	... add above this line ...

\# SPI protocol drivers (device/link on bus)
obj-$(CONFIG_SPI_SPIDEV)	+= spidev.o
…………………………………………………
\# 	... add above this line ...

通过以上分析我们知道，spi驱动由三部分组成，分别是core(spi.c)，master controller driver (spi_s3c24xx.c or spi_s3c24xx_gpio.)以及SPIprotocol drivers (spidev.c)，这里spi_s3c24xx_gpio.c文件是用普通的io口来模拟spi时序，具体见Kconfig描述：

config SPI_S3C24XX_GPIO
​	tristate "Samsung S3C24XX series SPI by GPIO"
​	depends on ARCH_S3C2410 && EXPERIMENTAL
​	select SPI_BITBANG
​	help
​	 SPI driver for Samsung S3C24XX series ARM SoCs using
​	 GPIO lines to provide the SPI bus. This can be used where
​	 the inbuilt hardware cannot provide the transfer mode, or
​	 where the board is using non hardware connected pins.

SPI子系统初始化

SPI子系统初始化的第一步，也就是注册SPI总线。这节介绍针对于s3c24xx平台的SPI子系统初始化，在看具体的代码之前，先上一张自己画的图，帮助理清初始化的主要步骤

显然，SPI是一种平台特定的资源，所以它是以platform平台设备的方式注册进内核的，因此它的struct platform_device结构是已经静态定义好了的，现在只待它的struct platform_driver注册，然后和platform_device匹配。

初始化的入口：

static int __init s3c24xx_spi_init(void)
{
​    return platform_driver_probe(&s3c24xx_spi_driver, s3c24xx_spi_probe);
}

platform_driver_probe()会调用platform_driver_register()来注册驱动，然后在注册的过程中寻求匹配的platform_device,一旦匹配成功，便会调用probe函数，也就是s3c24xx_spi_probe()，在看这个函数之前，还得介绍几个相关的数据结构。

struct s3c2410_spi_info是一个板级结构，也是在移植时就定义好的，在初始化spi_master时用到，platform_device–>dev–>platform_data会指向这个结构。

struct s3c2410_spi_info {
​	int			 pin_cs;	/* simple gpio cs */
​	unsigned int		 num_cs;	/* total chipselects */
​	int			 bus_num;/* bus number to use. */

​	void (*gpio_setup)(struct s3c2410_spi_info *spi, int enable);
​	void (*set_cs)(struct s3c2410_spi_info *spi, int cs, int pol);
};

struct s3c24xx_spi用来具体描述s3c24xx平台上一个SPI控制器

struct s3c24xx_spi {
​	/* bitbang has to be first */
​	struct spi_bitbang	 bitbang;
​	struct completion	 done;

​	void __iomem		*regs;
​	int			 irq;
​	int			 len;
​	int			 count;

​	void			(*set_cs)(struct s3c2410_spi_info *spi,
​					 int cs, int pol);

​	/* data buffers */
​	const unsigned char	*tx;
​	unsigned char		*rx;

​	struct clk		*clk;
​	struct resource		*ioarea;
​	struct spi_master	*master;
​	struct spi_device	*curdev;
​	struct device		*dev;
​	struct s3c2410_spi_info *pdata;
};

struct spi_bitbang用于控制实际的数据传输

struct spi_bitbang {
​	struct workqueue_struct	*workqueue;  /*工作队列*/
​	struct work_struct	work;

​	spinlock_t		lock;
​	struct list_head	queue;
​	u8			busy;
​	u8			use_dma;
​	u8			flags;		/* extra spi->mode support */

​	struct spi_master	*master;     /*bitbang所属的master*/

​	 /*用于设置设备传输时的时钟，字长等*/
​	int	(*setup_transfer)(struct spi_device *spi,
​			struct spi_transfer *t);

​	void	(*chipselect)(struct spi_device *spi, int is_on);
#define	BITBANG_CS_ACTIVE	1	/* normally nCS, active low */
#define	BITBANG_CS_INACTIVE	0

​	/*针对于平台的传输控制函数*/
​	int	(*txrx_bufs)(struct spi_device *spi, struct spi_transfer *t);

​	/* txrx_word[SPI_MODE_*]() just looks like a shift register */
​	u32	(*txrx_word[4])(struct spi_device *spi,
​			unsigned nsecs,
​			u32 word, u8 bits);
};

下面来看s3c24xx_spi_probe()函数的实现

static int __init s3c24xx_spi_probe(struct platform_device *pdev)
{
​	struct s3c2410_spi_info *pdata;
​	struct s3c24xx_spi *hw;
​	struct spi_master *master;
​	struct resource *res;
​	int err = 0;

​	/*创建spi_master，并将spi_master->private_data指向s3c24xx_spi*/
​	master = spi_alloc_master(&pdev->dev, sizeof(struct s3c24xx_spi));
​	if (master == NULL) {
​		dev_err(&pdev->dev, "No memory for spi_master\n");
​		err = -ENOMEM;
​		goto err_nomem;
​	}

​	hw = spi_master_get_devdata(master);//获取s3c24xx_spi
​	memset(hw, 0, sizeof(struct s3c24xx_spi));

​	hw->master = spi_master_get(master);
​	hw->pdata = pdata = pdev->dev.platform_data;
​	hw->dev = &pdev->dev;

​	if (pdata == NULL) {
​		dev_err(&pdev->dev, "No platform data supplied\n");
​		err = -ENOENT;
​		goto err_no_pdata;
​	}

​	platform_set_drvdata(pdev, hw);
​	init_completion(&hw->done);

​	/* setup the master state. */
​     /*片选数和SPI主控制器编号是在platform_data中已经定义好了的*/
​	master->num_chipselect = hw->pdata->num_cs;
​	master->bus_num = pdata->bus_num;

​	/* setup the state for the bitbang driver */

​	/*设置bitbang的所属master和控制传输的相关函数*/
​	hw->bitbang.master     = hw->master;
​	hw->bitbang.setup_transfer = s3c24xx_spi_setupxfer;
​	hw->bitbang.chipselect   = s3c24xx_spi_chipsel;
​	hw->bitbang.txrx_bufs    = s3c24xx_spi_txrx;
​	hw->bitbang.master->setup  = s3c24xx_spi_setup;

​	dev_dbg(hw->dev, "bitbang at %p\n", &hw->bitbang);

​	/* find and map our resources */
​	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
​	if (res == NULL) {
​		dev_err(&pdev->dev, "Cannot get IORESOURCE_MEM\n");
​		err = -ENOENT;
​		goto err_no_iores;
​	}

​	hw->ioarea = request_mem_region(res->start, (res->end - res->start)+1,
​					pdev->name);

​	if (hw->ioarea == NULL) {
​		dev_err(&pdev->dev, "Cannot reserve region\n");
​		err = -ENXIO;
​		goto err_no_iores;
​	}

​	/*映射SPI控制寄存器*/
​	hw->regs = ioremap(res->start, (res->end - res->start)+1);
​	if (hw->regs == NULL) {
​		dev_err(&pdev->dev, "Cannot map IO\n");
​		err = -ENXIO;
​		goto err_no_iomap;
​	}

​	/*获取中断号*/
​	hw->irq = platform_get_irq(pdev, 0);
​	if (hw->irq < 0) {
​		dev_err(&pdev->dev, "No IRQ specified\n");
​		err = -ENOENT;
​		goto err_no_irq;
​	}

​	/*注册中断*/
​	err = request_irq(hw->irq, s3c24xx_spi_irq, 0, pdev->name, hw);
​	if (err) {
​		dev_err(&pdev->dev, "Cannot claim IRQ\n");
​		goto err_no_irq;
​	}

​	hw->clk = clk_get(&pdev->dev, "spi");
​	if (IS_ERR(hw->clk)) {
​		dev_err(&pdev->dev, "No clock for device\n");
​		err = PTR_ERR(hw->clk);
​		goto err_no_clk;
​	}

​	/* setup any gpio we can */
​	if (!pdata->set_cs) {
​		if (pdata->pin_cs < 0) {
​			dev_err(&pdev->dev, "No chipselect pin\n");
​			goto err_register;
​		}

​		err = gpio_request(pdata->pin_cs, dev_name(&pdev->dev));
​		if (err) {
​			dev_err(&pdev->dev, "Failed to get gpio for cs\n");
​			goto err_regist