注：因为之前没接触过spi驱动开发，该系列文章是我参照博主formycuteboy的文章并结合自己的平台添加了自己的见解，本系列文章对于每个结构体变量以及函数都会有详细的解释该在此非常感谢formycuteboy！（formycuteboy是基于S3C2440,本文是基于itop4412)，在此表示感谢的同时还想激励自己可以做出更多原创作品。
0.引言
第一部分，将对SPI子系统整体进行描述，同时给出SPI的相关数据结构，最后描述SPI总线的注册。
第二部分，将对SPI的主控制器(master)驱动进行描述。 嵌入式Linux驱动——SPI子系统解读（二）第三部分，将对SPI设备驱动，也称协议(protocol) 驱动进行描述。 嵌入式Linux驱动——SPI子系统解读（三）
第四部分，通过SPI设备驱动留给用户层的API，我们将从上到下描述数据是如何通过SPI的protocol 驱动，由bitbang中转，最后由master驱动将数据传输出去。 嵌入式Linux驱动——SPI子系统解读（四）
1.SPI子系统综述
SPI子系统从上到下分为： spi设备驱动层， 核心层和 master驱动层。其中master驱动抽象出spi控制器的相关操作，而spi设备驱动层抽象出了用户空间API。platform_device结构中描述了SPI控制器的相关资源，同时在板级信息中将会添加spi设备的相关信息。master驱动将以platform_driver形式体现出来，也就是说在主控制器(master)和主控制器驱动将挂载到platform总线上。platform_driver的probe函数中将注册spi_master，同时将会获取在板级信息中添加的spi设备，将该信息转换成spi_device，然后注册spi_device到spi总线上。spi_driver结构用于描述spi设备驱动，也将挂载到spi总线上。连同spi_driver一起注册的是字符设备，该字符设备将提供5个API给用户空间。通过API，用户空间可以执行半双工读、半双工写和全双工读写。
2. SPI的相关数据结构
这里将介绍内核所用到的关键数据结构，还有些结构将在用到时加以说明。2.1 spi_master
该结构体主要用于描述spi主控器的信息。
struct spi_master {
struct device dev; //驱动的设备接口
s16 bus_num; //总线号（每个控制器的特定标识符）
u16 num_chipselect; //片选的设备数（可以挂载在该控制器上的从设备个数）
u16 dma_alignment; //dma模式
int (*setup)(struct spi_device *spi); //更新SPI设备的模式和SPI设备的采样时钟
int (*transfer)(struct spi_device *spi,struct spi_message *mesg);//添加一个消息到控制器的传输队列
void (*cleanup)(struct spi_device *spi);
};
2.2 spi_device
该结构用于描述SPI设备，也就是从设备的相关信息。（注：SPI子系统只支持主模式，也就是说S3C2440的SPI只能工作在master模式，外围设备只能为slave模式。）
struct spi_device {
struct device dev; //spi设备
struct spi_master *master; //spi控制器master
u32 max_speed_hz; //最大允许的频率
u8 chip_select; //片选号
u8 mode; //spi从设备的模式
#define SPI_CPHA 0x01 /* clock phase */
#define SPI_CPOL 0x02 /* clock polarity */
#define SPI_MODE_0 (0|0) /* (original MicroWire) */
#define SPI_MODE_1 (0|SPI_CPHA)
#define SPI_MODE_2 (SPI_CPOL|0)
#define SPI_MODE_3 (SPI_CPOL|SPI_CPHA)
#define SPI_CS_HIGH 0x04 /* chipselect active high? */
#define SPI_LSB_FIRST 0x08 /* per-word bits-on-wire */
#define SPI_3WIRE 0x10 /* SI/SO signals shared */
#define SPI_LOOP 0x20 /* loopback mode */
u8 bits_per_word; //每次穿的位数
int irq; //用到的中断号
void *controller_state;
void *controller_data;
char modalias[32];
};
2.3 spi_board_info
该结构也是对从设备的描述，只不过它是板级信息，最终该结构的所有信息将复制给spi_device。struct spi_board_info {
char modalias[32];
const void *platform_data;
void *controller_data;
int irq;
u32 max_speed_hz;
u16 bus_num;
u16 chip_select;
u8 mode;
};
2.4 spi_driver
该结构用于描述SPI设备驱动。（驱动核心将根据driver.name和spi_board_info 的modalias进行匹配，如过modalia和name相等，则绑定驱动程序和SPI设备）struct spi_driver{
int (*probe)(struct spi_device *spi);
int (*remove)(struct spi_device *spi);
void (*shutdown)(struct spi_device *spi);
int (*suspend)(struct spi_device *spi,pm_message_t mesg);
int (*resume)(stuct spi_device *spi);
struct device_driver driver;
};
2.5 spi_transfer
该数据结构是对一次完整的数据传输的描述。struct spi_transfer {
const void *tx_buf;
void *rx_buf;
unsigned len;
dma_addr_t tx_dma;
dma_addr_t rx_dma;
unsigned cs_change:1;
u8 bits_per_word;
u16 delay_usecs;
u32 speed_hz;
struct list_head transfer_list;
};
2.6 spi_message
该结构就是对多个spi_transfer的封装。
struct spi_message {
struct list_head transfers;
struct spi_device *spi;
unsigned is_dma_mapped:1;
void (*complete)(void *context);
void *context;
unsigned actual_length;
int status;
struct list_head queue;
void *state;
};
2.7 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;
struct spi_master *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_INACTIVE0
int (*txrx_bufs)(struct spi_device *spi, struct spi_transfer *t);
u32(*txrx_word[4])(struct spi_device *spi, unsigned nsecs, u32 word, u8 bits);
};
3. 注册SPI总线
下列函数位于drivers/spi/spi.c中。
struct bus_type spi_bus_type = {
.name = "spi",
.dev_attrs = spi_dev_attrs,
.match = spi_match_device,
.uevent = spi_uevent,
.suspend = spi_suspend,
.resume = spi_resume,
};
EXPORT_SYMBOL_GPL(spi_bus_type);
static struct class spi_master_class = {
.name = "spi_master",
.owner = THIS_MODULE,
.dev_release = spi_master_release,
};
/* portable code must never pass more than 32 bytes */
#define SPI_BUFSIZ max(32,SMP_CACHE_BYTES)
static u8 *buf;
static int __init spi_init(void)
{
int status;
buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
if (!buf) {
status = -ENOMEM;
goto err0;
}
status = bus_register(&spi_bus_type); /*注册SPI总线*/
if (status < 0)
goto err1;
status = class_register(&spi_master_class);/*注册SPI类*/
if (status < 0)
goto err2;
return 0;
err2:
bus_unregister(&spi_bus_type);
err1:
kfree(buf);
buf = NULL;
err0:
return status;
}
postcore_initcall(spi_init);
spi_init函数注册SPI总线以及SPI类到内核中。该函数在内核初始化的postcore_initcall阶段被调用。
下面是总线的匹配函数。（drivers/spi/spi.c）
static int spi_match_device(struct device *dev,struct device_driver *drv)
{
const struct spi_device *spi = to_spi_device(dev);
return strcmp(spi->modalias, drv->name) == 0;
}
从这里我们可以看出，SPI设备和驱动的匹配是通过device的modalias字段和driver的name字段，这两个字段相等则绑定设备和驱动。