spi驱动框架源码分析

下面来看一下Linux中的SPI驱动。在Linux设备驱动框架的设计中,有一个重要的主机外设驱动框架分离的思想,如下图。

spi驱动框架源码分析_第1张图片 

外设a,b,c的驱动与主机控制器A,B,C的驱动不相关,主机控制器驱动不关心外设,而外设驱动也不关心主机,外设只是访问核心层的通用的API进行数据的传输,主机和外设之间可以进行任意的组合。如果我们不进行如图的主机和外设分离,外设a,b,c和主机A,B,C进行组合的时候,需要9种不同的驱动。设想一共有m个主机控制器,n个外设,分离的结构是需要m+n个驱动,不分离则需要m*n个驱动。

下面介绍spi子系统的数据结构:
在Linux中,使用spi_master结构来描述一个SPI主机控制器的驱动。

[html] view plain copy
  1. struct spi_master { 
  2. struct device    dev
  3. s16  bus_num;/*总线编号,从0开始*/
  4. u16  num_chipselect; //*支持的片选的数量,从设备的片选号不能大于这个数量*/
  5. u16  dma_alignment
  6. int  (*setup)(struct spi_device *spi);/*改变spi_device的特性如:传输模式,字长,时钟频率*/
  7. int  (*transfer)(struct spi_device *spi,struct spi_message *mesg); );/*添加消息到队列的方法,这个函数不可睡眠,他的任务是安排发生的传送并且调用注册的回调函数complete()*/
  8. void (*cleanup)(struct spi_device *spi); 
  9. }; 

分配,注册和注销的SPI主机的API由SPI核心提供:

[cpp] view plain copy
  1. struct spi_master *spi_alloc_master(struct device *host, unsigned size); 
  2. int spi_register_master(struct spi_master *master); 
  3. void spi_unregister_master(struct spi_master *master);   
在Linux中用spi_driver来描述一个SPI外设驱动
[cpp] view plain copy
  1. struct spi_driver { 
  2. int   (*probe)(struct spi_device *spi); 
  3. int   (*remove)(struct spi_device *spi); 
  4. void  (*shutdown)(struct spi_device *spi); 
  5. int   (*suspend)(struct spi_device *spi, pm_message_t mesg); 
  6. int   (*resume)(struct spi_device *spi); 
  7. struct device_driver  driver; 
  8. };  

可以看出,spi_driver结构体和platform_driver结构体有极大的相似性,都有probe(),remove(),suspend(),resume()这样的接口。

Linux用spi_device来描述一个SPI外设设备。

[cpp] view plain copy
  1. struct spi_device { 
  2. struct device        dev; 
  3. struct spi_master   *master;      //对应的控制器指针u32    
  4. max_speed_hz; //spi通信的时钟u8       
  5. chip_select;  //片选,用于区分同一总线上的不同设备 
  6. u8  mode; 
  7. #define    SPI_CPHA    0x01            /* clock phase */ 
  8. #define    SPI_CPOL    0x02            /* clock polarity */ 
  9. #define SPI_MODE_0  (0|0)           /* (original MicroWire) */#define   SPI_MODE_1  (0|SPI_CPHA) 
  10. #define SPI_MODE_2  (SPI_CPOL|0) 
  11. #define SPI_MODE_3  (SPI_CPOL|SPI_CPHA)#define  SPI_CS_HIGH 0x04            /* chipselect active high? */ 
  12. #define    SPI_LSB_FIRST   0x08            /* per-word bits-on-wire */ 
  13. #define  SPI_3WIRE   0x10            /* SI/SO signals shared */ 
  14. #define   SPI_LOOP    0x20            /* loopback mode */ 
  15. u8      bits_per_word;   //每个字长的比特数 
  16. int      irq;             //使用的中断 
  17. void     *controller_state; 
  18. void     *controller_data; 
  19. char     modalias[32];   //名字 
  20. };   
如下图,看这三个结构的关系,这里spi_device与spi_master是同一个父设备(挂接在同一口上),这是在spi_new_device函数中设定的,一般这个设备是一个物理设备。

spi驱动框架源码分析_第2张图片

这里的spi_master_class,spi_bus_type又是什么呢,看下边两个结构体:

[cpp] view plain copy
  1. struct bus_type spi_bus_type = {    
  2.    .name       ="spi"
  3.    .dev_attrs  = spi_dev_attrs, 
  4.    .match    = spi_match_device, 
  5.    .uevent   = spi_uevent,  
  6.    .suspend  = spi_suspend, 
  7.    .resume   = spi_resume, 
  8. };  
  9. static struct class spi_master_class = {    
  10.     .name             ="spi_master",  
  11.     .owner           = THIS_MODULE, 
  12.     .dev_release    = spi_master_release, 
  13. };   
spi_bus_type对应spi中的spi bus总线,spidev的类定义如下:

[cpp] view plain copy
  1. static struct class *spidev_class;  
创建这个类的主要目的是使mdev/udev能在/dev下创建设备节点/dev/spiB.C。B代表总线,C代表片外设备的片选号。

下边来看两个板级的结构,其中spi_board_info用来初始化spi_device,s3c2410_spi_info用来初始化spi_master。这两个板级的结构需要在移植的时候在arch/arm/mach-s3c2440/mach-smdk2440.c中初始化。

[cpp] view plain copy
  1. struct spi_board_info { 
  2. char     modalias[32];  //设备与驱动匹配的唯一标识 
  3. constvoid    *platform_data; 
  4. void     *controller_data; 
  5. int        irq; 
  6. u32     max_speed_hz; 
  7. u16        bus_num;      //设备所归属的总线编号 
  8. u16      chip_select; 
  9. u8      mode; 
  10. };

  11. struct s3c2410_spi_info {       
  12. int     pin_cs;        //芯片选择管脚 
  13. unsignedint    num_cs;        //总线上的设备数 
  14. int        bus_num;       //总线号 
  15. void (*gpio_setup)(struct s3c2410_spi_info *spi, int enable);    //spi管脚配置函数 
  16. void (*set_cs)(struct s3c2410_spi_info *spi, int cs,int pol); 
  17. };   
boardinfo是用来管理spi_board_info的结构,spi_board_info通过spi_register_board_info(struct spi_board_info const *info, unsigned n)交由boardinfo来管理,并挂到board_list链表上,list_add_tail(&bi->list,&board_list);

[cpp] view plain copy
  1. struct boardinfo {  
  2. /*用于挂到链表头board_list上*/ 
  3. struct list_head  list; 
  4. /*管理的spi_board_info的数量*/ 
  5. unsigned  n_board_info; 
  6. /*存放结构体spi_board_info*/ 
  7. struct spi_board_info    board_info[0]; 
  8. };  
s3c24xx_spi是S3C2440的SPI控制器在Linux内核中的具体描述,该结构包含spi_bitbang内嵌结构,控制器时钟频率和占用的中断资源等重要成员,其中spi_bitbang具体负责SPI数据的传输。

[cpp] view plain copy
  1. struct s3c24xx_spi { 
  2. /* bitbang has to be first */ 
  3. struct spi_bitbang  bitbang; 
  4. struct completion   done; 
  5. void __iomem      *regs; 
  6. int            irq; 
  7. int             len; 
  8. int             count; 
  9. void         (*set_cs)(struct s3c2410_spi_info *spi,  int cs,int pol); 
  10. /* data buffers */const unsignedchar *tx; 
  11. unsignedchar       *rx; 
  12. struct clk      *clk; 
  13. struct resource        *ioarea; 
  14. struct spi_master   *master; 
  15. struct spi_device   *curdev; 
  16. struct device       *dev; 
  17. struct s3c2410_spi_info *pdata; 
  18. }; 
为了解决多个不同的SPI设备共享SPI控制器而带来的访问冲突,spi_bitbang使用内核提供的工作队列(workqueue)。workqueue是Linux内核中定义的一种回调处理方式。采用这种方式需要传输数据时,不直接完成数据的传输,而是将要传输的工作分装成相应的消息(spi_message)发送给对应的workqueue,由与workqueue关联的内核守护线程(daemon)负责具体的执行。由于workqueue会将收到的消息按时间先后顺序排列,这样就是对设备的访问严格串行化,解决了冲突。
[html] view plain copy
  1. struct spi_bitbang { 
  2. struct workqueue_struct *workqueue;      //工作队列 
  3. struct work_struct  work;            //每一次传输都传递下来一个spi_message,都向工作队列头添加一个 
  4. workspinlock_t     lock; 
  5. struct list_head   queue;           //挂接spi_message,如果上一次的spi_message还没有处理完,接下来的spi_message就挂接在queue上等待处理 
  6. u8     busy;            //忙碌标志 
  7. u8     use_dma; 
  8. u8     flags; 
  9. struct spi_master *master;/*一下3个函数都是在函数s3c24xx_spi_probe()中被初始化*/ 
  10. int     (*setup_transfer)(struct spi_device *spi,struct spi_transfer *t);   //设置传输模式 
  11. void    (*chipselect)(struct spi_device *spi, int is_on);                    //片选 
  12. #define   BITBANG_CS_ACTIVE   1   /* normally nCS, active low */ 
  13. #define   BITBANG_CS_INACTIVE 0/*传输函数,由s3c24xx_spi_txrx来实现*/ 
  14. int    (*txrx_bufs)(struct spi_device *spi, struct spi_transfer *t); 
  15. u32    (*txrx_word[4])(struct spi_device *spi,unsigned nsecs,u32 word, u8 bits); 
  16. }; 

下面来看看spi_message:

[cpp] view plain copy
  1. struct spi_message { 
  2. struct list_head    transfers;  //此次消息的传输队列,一个消息可以包含多个传输段 
  3. struct spi_device *spi;       //传输的目的设备 
  4. unsigned      is_dma_mapped:1; //如果为真,此次调用提供dma和cpu虚拟地址 
  5. void          (*complete)(void *context);  //异步调用完成后的回调函数 
  6. void         *context;                   //回调函数的参数 
  7. unsigned      actual_length;              //此次传输的实际长度 
  8. int         status;                     //执行的结果,成功被置0,否则是一个负的错误码 
  9. struct list_head   queue; 
  10. void          *state; 
  11. };   
在有消息需要传递的时候,会将spi_transfer通过自己的transfer_list字段挂到spi_message的transfers链表头上。spi_message用来原子的执行spi_transfer表示的一串数组传输请求。这个传输队列是原子的,这意味着在这个消息完成之前不会有其他消息占用总线。消息的执行总是按照FIFO的顺序。

下面看一看spi_transfer:

  1. struct spi_transfer { 
  2. constvoid *tx_buf; //要写入设备的数据(必须是dma_safe),或者为NULL 
  3. void       *rx_buf; //要读取的数据缓冲(必须是dma_safe),或者为NULL 
  4. unsigned   len;     //tx和rx的大小(字节数),这里不是指它的和,而是各自的长度,他们总是相等的 
  5. dma_addr_t    tx_dma;  //如果spi_message.is_dma_mapped是真,这个是tx的dma地址 
  6. dma_addr_t rx_dma;  //如果spi_message.is_dma_mapped是真,这个是rx的dma地址 
  7. unsigned   cs_change:1;   //影响此次传输之后的片选,指示本次tranfer结束之后是否要重新片选并调用setup改变设置,这个标志可以较少系统开销u8    
  8. bits_per_word; //每个字长的比特数,如果是0,使用默认值 
  9. u16        delay_usecs;   //此次传输结束和片选改变之间的延时,之后就会启动另一个传输或者结束整个消息 
  10. u32       speed_hz;      //通信时钟。如果是0,使用默认值 
  11. struct list_head transfer_list;//用来连接的双向链表节点
    }

 

这篇来分析spi子系统的建立过程。
嵌入式微处理器访问SPI设备有两种方式:使用GPIO模拟SPI接口的工作时序或者使用SPI控制器。使用GPIO模拟SPI接口的工作时序是非常容易实现的,但是会导致大量的时间耗费在模拟SPI接口的时序上,访问效率比较低。
 spi驱动框架源码分析_第3张图片
这个是由sys文件系统导出的spi子系统在内核中的视图了。
首先了解一下Linux内核中的几个文件:spi.c也就是spi子系统的核心了spi_s3c24xx.c是s3c24xx系列芯片的SPI controller驱动,它向更上层的SPI核心层(spi.c)提供接口用来控制外设,是一个被其他驱动使用的驱动。而spidev.c是在核心层基础之上将SPI controller模拟成一个字符型的驱动,向文件系统提供标准的文件系统接口,用来操作对应的SPI controller。
下面我们来看看spi子系统是怎么注册进内核的:

[cpp] view plain copy
  1. staticint __init spi_init(void) //spi.c
  2.    int status; 
  3.     buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL); 
  4.    if (!buf) { 
  5.         status = -ENOMEM; 
  6.        goto err0; 
  7.     } 
  8.     status = bus_register(&spi_bus_type); 
  9.    if (status < 0) 
  10.        goto err1; 
  11.     status = class_register(&spi_master_class); 
  12.    if (status < 0) 
  13.        goto err2; 
  14.    return 0; 
  15. err2: 
  16.     bus_unregister(&spi_bus_type); 
  17. err1: 
  18.     kfree(buf); 
  19.     buf = NULL; 
  20. err0: 
  21.    return status; 
  22. postcore_initcall(spi_init); 
这里注册了一个spi_bus_type,也就是一个spi总线,和一个spi_master的class。分别对应上图中sys/bus/下的spi目录和sys/class/下的spi_master目录。

下面来分析SPI controller驱动的注册与初始化过程,首先执行的是s3c24xx_spi_init。

[cpp] view plain copy
  1. staticint __init s3c24xx_spi_init(void) //spi_s3c24xx.c
  2.        return platform_driver_probe(&s3c24xx_spi_driver, s3c24xx_spi_probe); 
platform_driver_probe中完成了s3c24xx_spi_driver这个平台驱动的注册,相应的平台设备在devs.c中定义,在smdk2440_devices中添加&s3c_device_spi0,&s3c_device_spi1,这就生成了图中所示的s3c24xx-spi.0与s3c24xx-spi.1,当然了这图是在网上找的,不是我画的,所以是6410的。这里s3c24xx-spi.0表示s3c2440的spi controller的0号接口,s3c24xx-spi.1表示s3c2440的spi controller的1号接口。注册了s3c24xx_spi_driver后,赋值了平台驱动的probe函数为s3c24xx_spi_probe。添加了platform_driver后会match成功后,调用s3c24xx_spi_probe,这里看其实现:
[html] view plain copy
  1. static int __init s3c24xx_spi_probe(struct platform_device *pdev) 
  2.     struct s3c2410_spi_info *pdata; 
  3.     struct s3c24xx_spi *hw; 
  4.     struct spi_master *master; 
  5.     struct resource *res; 
  6.     interr =0
  7.     /*分配struct spi_master+struct s3c24xx_spi大小的数据,把s3c24xx_spi设为spi_master的私有数据*/ 
  8.    master =spi_alloc_master(&pdev->dev, sizeof(struct s3c24xx_spi)); 
  9.     if (master == NULL) { 
  10.         dev_err(&pdev->dev, "No memory for spi_master\n"); 
  11.        err = -ENOMEM; 
  12.         goto err_nomem; 
  13.     } 
  14.     /*从master中获得s3c24xx_spi*/ 
  15.    hw =spi_master_get_devdata(master); 
  16.     memset(hw, 0, sizeof(struct s3c24xx_spi)); 
  17.  
  18.  
  19.     hw->master =spi_master_get(master); 
  20.     /*驱动移植的时候需要实现的重要结构,初始化为&s3c2410_spi0_platdata*/ 
  21.     hw->pdatapdata = pdata = pdev->dev.platform_data; 
  22.     hw->dev = &pdev->dev; 
  23.  
  24.  
  25.     if (pdata == NULL) { 
  26.         dev_err(&pdev->dev, "No platform data supplied\n"); 
  27.        err = -ENOENT; 
  28.         goto err_no_pdata; 
  29.     } 
  30.     /*设置平台的私有数据为s3c24xx_spi*/ 
  31.     platform_set_drvdata(pdev, hw); 
  32.     init_completion(&hw->done); 
  33.  
  34.  
  35.     /* setup the master state. */ 
  36.     /*该总线上的设备数*/ 
  37.     master->num_chipselect = hw->pdata->num_cs; 
  38.     /*总线号*/   
  39.     master->bus_num =pdata->bus_num; 
  40.  
  41.  
  42.     /* setup the state for the bitbang driver */ 
  43.     /*spi_bitbang专门负责数据的传输*/ 
  44.     hw->bitbang.master         =hw->master; 
  45.     hw->bitbang.setup_transfer =s3c24xx_spi_setupxfer;//transfer里的参数设置speed和bits_per_word要调用这个setup_transfer,重新设置传输参数
  46.     hw->bitbang.chipselect     =s3c24xx_spi_chipsel
  47.     hw->bitbang.txrx_bufs      =s3c24xx_spi_txrx
  48.     hw->bitbang.master->setup  = s3c24xx_spi_setup
  49.  
  50.  
  51.     dev_dbg(hw->dev, "bitbang at %p\n", &hw->bitbang); 
  52.       
  53.     。。。。。。。。。。。。。。。。。。。。。。。。 
  54.      
  55.     /*初始化设置寄存器,包括对SPIMOSI,SPIMISO,SPICLK引脚的设置*/ 
  56.     s3c24xx_spi_initialsetup(hw); 
  57.  
  58.  
  59.     /* register our spi controller */ 
  60.  
  61.  
  62.    err =spi_bitbang_start(&hw->bitbang); 
  63.         。。。。。。。。。。。。。。。。。。。。。 
spi controller的register在spi_bitbang_start函数中实现:
[html] view plain copy
  1. int spi_bitbang_start(struct spi_bitbang *bitbang) 
  2.     int status; 
  3.  
  4.  
  5.     if (!bitbang->master || !bitbang->chipselect) 
  6.         return -EINVAL; 
  7.     /*动态创建一个work_struct结构,它的处理函数是bitbang_work*/ 
  8.     INIT_WORK(&bitbang->work, bitbang_work); 
  9.     spin_lock_init(&bitbang->lock); 
  10.     INIT_LIST_HEAD(&bitbang->queue); //链表头
  11.     /*spi的数据传输就是用这个方法*/ 
  12.     if (!bitbang->master->transfer) 
  13.         bitbang->master->transfer = spi_bitbang_transfer;
  14.     if (!bitbang->txrx_bufs) { //在s3c24xx_spi_probe里定义了txrx_bufs
  15.         bitbang->use_dma =0
  16.         /*spi_s3c24xx.c中有spi_bitbang_bufs方法,在bitbang_work中被调用*/ 
  17.         bitbang->txrx_bufs =spi_bitbang_bufs
  18.         if (!bitbang->master->setup) {  //在s3c24xx_spi_probe里定义了master->setup
  19.             if (!bitbang->setup_transfer) //在s3c24xx_spi_probe里定义了            setup_transfer=s3c24xx_spi_setupxfer
  20.                 bitbang->setup_transfer
  21.                     spi_bitbang_setup_transfer
  22.             /*在spi_s3c24xx.c中有setup的处理方法,在spi_new_device中被调用*/ 
  23.             bitbang->master->setup = spi_bitbang_setup
  24.             bitbang->master->cleanup = spi_bitbang_cleanup
  25.         } 
  26.     } else if (!bitbang->master->setup) 
  27.         return -EINVAL; 
  28.  
  29.  
  30.     /* this task is the only thing to touch the SPI bits */ 
  31.     bitbang->busy =0
  32.     /调用create_singlethread_workqueue创建单个工作线程/ 
  33.     bitbang->workqueue =create_singlethread_workqueue
  34.             dev_name(bitbang->master->dev.parent)); 
  35.     if (bitbang->workqueue == NULL) { 
  36.        status = -EBUSY; 
  37.         goto err1; 
  38.     } 
  39.    status =spi_register_master(bitbang->master); 
  40.     if (status<0
  41.         goto err2; 
  42.     return status; 
  43. err2: 
  44.     destroy_workqueue(bitbang->workqueue); 
  45. err1: 
  46.     return status; 

然后看这里是怎样注册spi主机控制器驱动的:

[cpp] view plain copy
  1. int spi_register_master(struct spi_master *master) 
  2.     。。。。。。。。。。。。。。。。 
  3.    /*将spi添加到内核,这也是sys/class/Spi_master下产生Spi0,Spi1的原因*/ 
  4.     dev_set_name(&master->dev,"spi%u", master->bus_num); 
  5.     status = device_add(&master->dev); 
  6.     scan_boardinfo(master); 

这里跟踪scan_boardinfo函数:

[cpp] view plain copy
  1. staticvoid scan_boardinfo(struct spi_master *master) 
  2.    struct boardinfo    *bi; 
  3. mutex_lock(&board_lock); 
  4.    /*遍历所有挂在board_list上的struct boardinfo*/ 
  5.     list_for_each_entry(bi, &board_list, list) { 
  6.        struct spi_board_info   *chip = bi->board_info; 
  7.         unsigned    n; 
  8.        /*遍历每个boardinfo管理的spi_board_info,如果设备的总线号与控制器的总线好相等,则创建新设备*/ 
  9.        for (n = bi->n_board_info; n > 0; n--, chip++) { 
  10.            if (chip->bus_num != master->bus_num) 
  11.                continue
  12.             (void) spi_new_device(master, chip); 
  13.         } 
  14.     } 
  15.     mutex_unlock(&board_lock); 
在移植的时候我们会在mach-smdk2440.c中的smdk2440_machine_init中添加spi_register_board_info

这个函数完成了将spi_board_info交由boardinfo管理,并把boardinfo挂载到board_list链表上。也就是说在系统初始化的时候将spi_device交由到挂在board_list上的boardinfo管理,在spi controller的driver注册的时候不但注册这个主机控制器的驱动,还要遍历这个主机控制器的总线上的spi_device,将总线上的spi_device全部注册进内核。当注册进内核并且spi_driver已经注册的时候,如果总线match成功,则会调用spi_driver的probe函数,这个将在后边进行分析。

[html] view plain copy
  1. int __init 
  2. spi_register_board_info(struct spi_board_info const *info, unsigned n) //n=1
  3.     struct boardinfo    *bi; 
  4.    
  5.    bi =kmalloc(sizeof(*bi) + n * sizeof *info, GFP_KERNEL); 
  6.     if (!bi) 
  7.         return -ENOMEM; 
  8.     bi->nn_board_info = n; 
  9.     memcpy(bi->board_info, info, n * sizeof *info); 
  10.  
  11.  
  12.     mutex_lock(&board_lock); 
  13.     list_add_tail(&bi->list, &board_list); 
  14.     mutex_unlock(&board_lock); 
  15.     return 0; 

看一下创建新设备的函数:

[html] view plain copy
  1. struct spi_device *spi_new_device(struct spi_master *master, 
  2.                   struct spi_board_info *chip) 
  3.     struct spi_device   *proxy; 
  4.     int         status; 
  5.    proxy =spi_alloc_device(master); 
  6.     if (!proxy) 
  7.         return NULL; 
  8.  
  9.  
  10.     WARN_ON(strlen(chip->modalias)>= sizeof(proxy->modalias)); 
  11.     /*初始化spi_device的各个字段*/ 
  12.     proxy->chipchip_select = chip->chip_select; 
  13.     proxy->max_speed_hz =chip->max_speed_hz; 
  14.     proxy->mode =chip->mode;//设置mode
  15.     proxy->irq =chip->irq; 
  16.     /*这里获得了spi_device的名字,这个modalias也是在我们移植时在mach-smdk2440.c中的s3c2410_spi0_board中设定的*/ 
  17.     strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias)); //spi_bus_type match的时候用到
  18.     proxy->dev.platform_data = (void *) chip->platform_data; 
  19.     proxy->controller_data =chip->controller_data; 
  20.     proxy->controller_state =NULL
  21.     /*主要完成将spi_device添加到内核*/ 
  22.    status =spi_add_device(proxy); 
  23.     if (status<0) { 
  24.         spi_dev_put(proxy); 
  25.         return NULL; 
  26.     } 
  27.  
  28.  
  29.     return proxy; 
下面来看分配spi_alloc_device的函数,主要完成了分配spi_device,并初始化spi->dev的一些字段。
[cpp] view plain copy
  1. struct spi_device *spi_alloc_device(struct spi_master *master) 
  2.    struct spi_device   *spi; 
  3.    struct device       *dev = master->dev.parent; 
  4.    if (!spi_master_get(master)) 
  5.        return NULL; 
  6.     spi = kzalloc(sizeof *spi, GFP_KERNEL); 
  7.    if (!spi) { 
  8.         dev_err(dev,"cannot alloc spi_device\n"); 
  9.         spi_master_put(master); 
  10.        return NULL; 
  11.     } 
  12.     spi->master = master; 
  13.     spi->dev.parent = dev; 
  14.    /*设置总线是spi_bus_type,下面会讲到spi_device与spi_driver是怎样match上的*/ 
  15.     spi->dev.bus = &spi_bus_type; 
  16.     spi->dev.release = spidev_release; 
  17.     device_initialize(&spi->dev); 
  18.    return spi; 
下面来看分配的这个spi_device是怎样注册进内核的:
[cpp] view plain copy
  1. int spi_add_device(struct spi_device *spi) 
  2.    static DEFINE_MUTEX(spi_add_lock); 
  3.    struct device *dev = spi->master->dev.parent; 
  4.    int status; 
  5.    /*spi_device的片选号不能大于spi控制器的片选数*/ 
  6.    if (spi->chip_select >= spi->master->num_chipselect) {//num_chipselect=挂载的总设备数
  7.         dev_err(dev,"cs%d >= max %d\n"
  8.             spi->chip_select, 
  9.             spi->master->num_chipselect); 
  10.        return -EINVAL; 
  11.     } 
  12.    /*这里设置是spi_device在Linux设备驱动模型中的name,也就是图中的spi0.0,而在/dev/下设备节点的名字是proxy->modalias中的名字*/ 
  13.     dev_set_name(&spi->dev,"%s.%u", dev_name(&spi->master->dev), //见spi_register_master
  14.             spi->chip_select); 
  15.     mutex_lock(&spi_add_lock); 
  16.    /*如果总线上挂的设备已经有这个名字,则设置状态忙碌,并退出*/ 
  17.    if (bus_find_device_by_name(&spi_bus_type, NULL, dev_name(&spi->dev)) 
  18.             != NULL) { 
  19.         dev_err(dev,"chipselect %d already in use\n"
  20.                 spi->chip_select); 
  21.         status = -EBUSY; 
  22.        goto done; 
  23.     } 
  24.     /对spi_device的时钟等进行设置/ 
  25.     status = spi->master->setup(spi); //不同的设备的频率和分频数不同,结果写在spi的成员变量
  26.    if (status < 0) { 
  27.         dev_err(dev,"can't %s %s, status %d\n"
  28.                "setup", dev_name(&spi->dev), status); 
  29.        goto done; 
  30.     } 
  31.    /*添加到内核*/ 
  32.     status = device_add(&spi->dev); 
  33.    if (status < 0) 
  34.         dev_err(dev,"can't %s %s, status %d\n"
  35.                "add", dev_name(&spi->dev), status); 
  36.    else 
  37.         dev_dbg(dev,"registered child %s\n", dev_name(&spi->dev)); 
  38.  
  39.  
  40. done: 
  41.     mutex_unlock(&spi_add_lock); 
  42.    return status; 
  43.  
  44. static int s3c24xx_spi_setup(struct spi_device *spi)
    {
    	struct s3c24xx_spi_devstate *cs = spi->controller_state;//<span style="color:#009900;">cs是spi_device的成员,保存成员设备信息</span>
    	struct s3c24xx_spi *hw = to_hw(spi);
    	int ret;
    
    	/* allocate settings on the first call */
    	if (!cs) {// NULL first 
    		cs = kzalloc(sizeof(struct s3c24xx_spi_devstate), GFP_KERNEL);
    		if (!cs) {
    			dev_err(&spi->dev, "no memory for controller state\n");
    			return -ENOMEM;
    		}
    
    		cs->spcon = SPCON_DEFAULT;
    		cs->hz = -1;
    		spi->controller_state = cs;//only set spcon,hz
    	}
    
    	/* initialise the state from the device */
    	ret = s3c24xx_spi_update_state(spi, NULL);
    	if (ret)
    		return ret;
    
    	spin_lock(&hw->bitbang.lock);
    	if (!hw->bitbang.busy) {
    		hw->bitbang.chipselect(spi, BITBANG_CS_INACTIVE);//cs invalid
    		/* need to ndelay for 0.5 clocktick ? */
    	}
    	spin_unlock(&hw->bitbang.lock);
    
    	return 0;
    }
    

  45. static int s3c24xx_spi_update_state(struct spi_device *spi,
    				    struct spi_transfer *t) // 第一次t = NULL,以后每来一个transfer都不为空
    {	
    	struct s3c24xx_spi *hw = to_hw(spi);
    	struct s3c24xx_spi_devstate *cs = spi->controller_state;
    	unsigned int bpw;
    	unsigned int hz;
    	unsigned int div;
    	unsigned long clk;
    	bpw = t ? t->bits_per_word : spi->bits_per_word;
    	hz  = t ? t->speed_hz : spi->max_speed_hz;
    	if (!bpw)
    		bpw = 8;
    	if (!hz)
    		hz = spi->max_speed_hz;
    	if (bpw != 8) {
    		dev_err(&spi->dev, "invalid bits-per-word (%d)\n", bpw);
    		return -EINVAL;
    	}
    	if (spi->mode != cs->mode) {
    		u8 spcon = SPCON_DEFAULT | S3C2410_SPCON_ENSCK;
    		if (spi->mode & SPI_CPHA)
    			spcon |= S3C2410_SPCON_CPHA_FMTB;
    		if (spi->mode & SPI_CPOL)
    			spcon |= S3C2410_SPCON_CPOL_HIGH;
    		cs->mode = spi->mode;
    		cs->spcon = spcon;
    	}
    	if (cs->hz != hz) {//hz=spi->max_speed_hz
    		clk = clk_get_rate(hw->clk);//already get hw->clk
    		div = DIV_ROUND_UP(clk, hz * 2) - 1;//hz=what we want
    		if (div > 255)
    			div = 255;
    		dev_dbg(&spi->dev, "pre-scaler=%d (wanted %d, got %ld)\n",
    			div, hz, clk / (2 * (div + 1)));
    		cs->hz = hz;//记录该设备的时钟频率
    		cs->sppre = div;//记录该设备的分频
    	}
    	return 0;
    }

下面来看这个spi_driver是怎样注册的,又是与spi_device怎样match上的。
在spidev.c中:

[cpp] view plain copy
  1. staticint __init spidev_init(void
  2.    int status; 
  3.     BUILD_BUG_ON(N_SPI_MINORS > 256); 
  4.     status = register_chrdev(SPIDEV_MAJOR,"spi", &spidev_fops); 
  5.    if (status < 0) 
  6.        return status; 
  7.     spidev_class = class_create(THIS_MODULE,"spidev"); 
  8.    if (IS_ERR(spidev_class)) { 
  9.         unregister_chrdev(SPIDEV_MAJOR, spidev_spi.driver.name); 
  10.        return PTR_ERR(spidev_class); 
  11.     } 
  12.     status = spi_register_driver(&spidev_spi); 
  13.    if (status < 0) { 
  14.         class_destroy(spidev_class); 
  15.         unregister_chrdev(SPIDEV_MAJOR, spidev_spi.driver.name); 
  16.     } 
  17.    return status; 
注册了名为”spi”的字符驱动,然后注册了spidev_spi驱动,这个就是图中sys/Bus/Spi/Drivers/下的spidev。
[cpp] view plain copy
  1. staticstruct spi_driver spidev_spi = { 
  2.     .driver = { 
  3.         .name =    "spidev"
  4.         .owner =    THIS_MODULE, 
  5.     }, 
  6.     .probe =    spidev_probe, 
  7.     .remove =   __devexit_p(spidev_remove), 
  8. }; 
这里来看__driver_attach(设备和驱动匹配的时候会调用此函数)这个函数,其中分别调用了driver_match_device,driver_probe_device函数。如果匹配成果调用probe函数,否则返回。
copy
  1. staticint __driver_attach(struct device *dev,void *data)   
  2. {   
  3.    struct device_driver *drv = data;   
  4.    if (!driver_match_device(drv, dev))   
  5.        return 0;   
  6.    
  7.    if (dev->parent)/* Needed for USB */    
  8.     down(&dev->parent->sem);   
  9.     down(&dev->sem);   
  10.    if (!dev->driver)   
  11.         driver_probe_device(drv, dev);   
  12.     up(&dev->sem);   
  13.    if (dev->parent)   
  14.         up(&dev->parent->sem);   
  15.    
  16.    return 0;   
  17. }   
static inline int driver_match_device(struct device_driver *drv,
				      struct device *dev)
{
	return drv->bus->match ? drv->bus->match(dev, drv) : 1;
}<span style="font-family:verdana,sans-serif;font-size:14px;color:#333333;margin: 0px; padding: 0px; line-height: 26px; white-space: normal; background-color: rgb(255, 255, 255);"><span style="font-size:18px;margin: 0px; padding: 0px;">匹配的时候调用的bus的match函数。</span></span><br style="margin: 0px; padding: 0px; color: rgb(51, 51, 51); line-height: 26px; font-family: Arial; font-size: 14px; white-space: normal; background-color: rgb(255, 255, 255);" />
[cpp] view plain copy
  1. struct bus_type spi_bus_type = { 
  2.        .name             ="spi"
  3.        .dev_attrs       = spi_dev_attrs, 
  4.        .match           = spi_match_device, 
  5.        .uevent           = spi_uevent, 
  6.        .suspend  = spi_suspend, 
  7.        .resume          = spi_resume, 
  8. }; 
  9. staticint spi_match_device(struct device *dev,struct device_driver *drv) 
  10.    conststruct spi_device *spi = to_spi_device(dev); 
  11.  
  12.  
  13.    return strcmp(spi->modalias, drv->name) == 0; 

可以看到这里根据驱动和设备的名字进行匹配,匹配成功后最终会调用驱动的probe函数,如下。

先调用spi_drv_probe后在调用设备probe

[cpp] view plain copy
  1. staticint spi_drv_probe(struct device *dev) 
  2.    conststruct spi_driver     *sdrv = to_spi_driver(dev->driver); 
  3.  
  4.  
  5.    return sdrv->probe(to_spi_device(dev)); 
static int spidev_probe(struct spi_device *spi)
{
	struct spidev_data	*spidev;
	int			status;
	unsigned long		minor;
。。。。
	if (status == 0) {
		set_bit(minor, minors);
		list_add(&spidev->device_entry, &device_list);<span style="color:#009900;">//添加到device_list</span>
	}
。。。。
	return status;
}

可以看到调用了具体的probe函数,这里实现了把spidev添加到device_list,这样这个虚拟的字符驱动就注册并初始化完毕。

[cpp] view plain copy
  1. staticint spidev_remove(struct spi_device *spi) 
  2.    struct spidev_data  *spidev = spi_get_drvdata(spi); 
  3.  
  4.  
  5.    /* make sure ops on existing fds can abort cleanly */ 
  6.     spin_lock_irq(&spidev->spi_lock); 
  7.     spidev->spi = NULL; 
  8.     spi_set_drvdata(spi, NULL); 
  9.     spin_unlock_irq(&spidev->spi_lock); 
  10.  
  11.  
  12.    /* prevent new opens */ 
  13.     mutex_lock(&device_list_lock); 
  14.     list_del(&spidev->device_entry); //从链表上删除该结点
  15.     device_destroy(spidev_class, spidev->devt); 
  16.     clear_bit(MINOR(spidev->devt), minors); 
  17.    if (spidev->users == 0) 
  18.         kfree(spidev); 
  19.     mutex_unlock(&device_list_lock); 
  20.  
  21.  
  22.    return 0; 
在spidev的注册函数中注册了文件操作集合file_operations,为用户空间提供了操作SPI controller的接口。
[cpp] view plain copy
  1. staticstruct file_operations spidev_fops = { 
  2.     .owner =    THIS_MODULE, 
  3.    /* REVISIT switch to aio primitives, so that userspace
  4.      * gets more complete API coverage.  It'll simplify things
  5.      * too, except for the locking.
  6.      */ 
  7.     .write =    spidev_write, 
  8.     .read =     spidev_read, 
  9.     .unlocked_ioctl = spidev_ioctl, 
  10.     .open =     spidev_open, 
  11.     .release =  spidev_release, 
  12. }; 

到此为止spi子系统与spi_master,spi_device,spi_driver这个Linux设备驱动模型已经建立完了。


这篇文档主要介绍spi数据传输过程。

当应用层要向设备传输数据的时候,会通过ioctl向设备驱动发送传输数据的命令。如图,向SPI从设备发送读写命令,实际的读写操作还是调用了主机控制器驱动的数据传输函数。transfer函数用于spi的IO传输。但是,transfer函数一般不会执行真正的传输操作,而是把要传输的内容放到一个队列里,然后调用一种类似底半部的机制进行真正的传输这是因为,spi总线一般会连多个spi设备,而spi设备间的访问可能会并发。如果直接在transfer函数中实现传输,那么会产生竞态,spi设备互相间会干扰。所以,真正的spi传输与具体的spi控制器的实现有关,spi的框架代码中没有涉及。像spi设备的片选,根据具体设备进行时钟调整等等都在实现传输的代码中被调用。spi的传输命令都是通过结构spi_message定义,设备程序调用transfer函数将spi_message交给spi总线驱动,总线驱动再将message传到底半部排队,实现串行化传输。


spi_transfer->spi_message->queue_work传输


spi驱动框架源码分析_第4张图片


 

在spidev.c中实现了file_operations:

[cpp] view plain copy
  1. staticstruct file_operations spidev_fops = { 
  2.     .owner =    THIS_MODULE, 
  3.     .write =    spidev_write, 
  4.     .read =     spidev_read, 
  5.     .unlocked_ioctl = spidev_ioctl, 
  6.     .open =     spidev_open, 
  7.     .release =  spidev_release, 
  8. }; 
这里看spidev_ioctl的实现:

[cpp] view plain copy
  1. staticlong 
  2. spidev_ioctl(struct file *filp, unsignedint cmd, unsignedlong arg) 
  3.    int         err = 0; 
  4.    int         retval = 0; 
  5.    struct spidev_data  *spidev; 
  6.    struct spi_device   *spi; 
  7.     u32         tmp; 
  8.     unsigned        n_ioc; 
  9.    struct spi_ioc_transfer *ioc; 
  10.  
  11.    /*查看这个命令的幻数字段是否为'k'*/ 
  12.    if (_IOC_TYPE(cmd) != SPI_IOC_MAGIC) 
  13.        return -ENOTTY; 
  14.  
  15.    /*如果方向是用户空间从内核读,即内核向用户空间写,则检查用户空间的地址是否有效*/ 
  16.    if (_IOC_DIR(cmd) & _IOC_READ) 
  17.         err = !access_ok(VERIFY_WRITE, 
  18.                 (void __user *)arg, _IOC_SIZE(cmd)); 
  19.    /*如果方向是用户空间向内核写,即内核读用户空间,则检查用户空间的地址是否有效*/ 
  20.    if (err == 0 && _IOC_DIR(cmd) & _IOC_WRITE) 
  21.         err = !access_ok(VERIFY_READ, 
  22.                 (void __user *)arg, _IOC_SIZE(cmd)); 
  23.    if (err) 
  24.        return -EFAULT; 
  25.  
  26.    /* guard against device removal before, or while,
  27.      * we issue this ioctl.
  28.      */ 
  29.     spidev = filp->private_data; 
  30.     spin_lock_irq(&spidev->spi_lock); 
  31.     spi = spi_dev_get(spidev->spi); 
  32.     spin_unlock_irq(&spidev->spi_lock); 
  33.  
  34.    if (spi == NULL) 
  35.        return -ESHUTDOWN; 
  36.  
  37.     mutex_lock(&spidev->buf_lock); 
  38.  
  39.    switch (cmd) { 
  40.    /* read requests */ 
  41.    case SPI_IOC_RD_MODE: 
  42.        /*因为已经进行了地址是否有效的检查,所以这里使用__put_user,__get_user,__copy_from_user可以节省几个时钟周期呢*/ 
  43.         retval = __put_user(spi->mode & SPI_MODE_MASK, 
  44.                     (__u8 __user *)arg); 
  45.        break
  46.    case SPI_IOC_RD_LSB_FIRST: 
  47.         retval = __put_user((spi->mode & SPI_LSB_FIRST) ?  1 : 0, 
  48.                     (__u8 __user *)arg); 
  49.        break
  50.    case SPI_IOC_RD_BITS_PER_WORD: 
  51.         retval = __put_user(spi->bits_per_word, (__u8 __user *)arg); 
  52.        break
  53.    case SPI_IOC_RD_MAX_SPEED_HZ: 
  54.         retval = __put_user(spi->max_speed_hz, (__u32 __user *)arg); 
  55.        break
  56.  
  57.    /*设置SPI模式*/ 
  58.    case SPI_IOC_WR_MODE: 
  59.         retval = __get_user(tmp, (u8 __user *)arg); 
  60.        if (retval == 0) { 
  61.            /*先将之前的模式保存起来,一旦设置失败进行回复*/ 
  62.             u8  save = spi->mode; 
  63.  
  64.            if (tmp & ~SPI_MODE_MASK) { 
  65.                 retval = -EINVAL; 
  66.                break
  67.             } 
  68.  
  69.             tmp |= spi->mode & ~SPI_MODE_MASK; 
  70.             spi->mode = (u8)tmp; 
  71.             retval = spi_setup(spi); 
  72.            if (retval < 0) 
  73.                 spi->mode = save; 
  74.            else 
  75.                 dev_dbg(&spi->dev,"spi mode %02x\n", tmp); 
  76.         } 
  77.        break
  78.    case SPI_IOC_WR_LSB_FIRST: 
  79.         retval = __get_user(tmp, (__u8 __user *)arg); 
  80.        if (retval == 0) { 
  81.             u8  save = spi->mode; 
  82.  
  83.            if (tmp) 
  84.                 spi->mode |= SPI_LSB_FIRST; 
  85.            else 
  86.                 spi->mode &= ~SPI_LSB_FIRST; 
  87.             retval = spi_setup(spi); 
  88.            if (retval < 0) 
  89.                 spi->mode = save; 
  90.            else 
  91.                 dev_dbg(&spi->dev,"%csb first\n"
  92.                         tmp ?'l' :'m'); 
  93.         } 
  94.        break
  95.    case SPI_IOC_WR_BITS_PER_WORD: 
  96.         retval = __get_user(tmp, (__u8 __user *)arg); 
  97.        if (retval == 0) { 
  98.             u8  save = spi->bits_per_word; 
  99.  
  100.             spi->bits_per_word = tmp; 
  101.             retval = spi_setup(spi); 
  102.            if (retval < 0) 
  103.                 spi->bits_per_word = save; 
  104.            else 
  105.                 dev_dbg(&spi->dev,"%d bits per word\n", tmp); 
  106.         } 
  107.        break
  108.    case SPI_IOC_WR_MAX_SPEED_HZ: 
  109.         retval = __get_user(tmp, (__u32 __user *)arg); 
  110.        if (retval == 0) { 
  111.             u32 save = spi->max_speed_hz; 
  112.  
  113.             spi->max_speed_hz = tmp; 
  114.             retval = spi_setup(spi); 
  115.            if (retval < 0) 
  116.                 spi->max_speed_hz = save; 
  117.            else 
  118.                 dev_dbg(&spi->dev,"%d Hz (max)\n", tmp); 
  119.         } 
  120.        break
  121.  
  122.    default
  123.        /* segmented and/or full-duplex I/O request */ 
  124.        if (_IOC_NR(cmd) != _IOC_NR(SPI_IOC_MESSAGE(0)) 
  125.                 || _IOC_DIR(cmd) != _IOC_WRITE) { 
  126.             retval = -ENOTTY; 
  127.            break
  128.         } 
  129.        /*得到用户空间数据的大小*/ 
  130.         tmp = _IOC_SIZE(cmd); 
  131.        /*如果这些数据不能分成spi_ioc_transfer的整数倍,则不能进行传输,spi_io_transfer是对spi_transfer的映射*/ 
  132.        if ((tmp %sizeof(struct spi_ioc_transfer)) != 0) { 
  133.             retval = -EINVAL; 
  134.            break
  135.         } 
  136.        /*计算出能分多少个spi_ioc_transfer*/ 
  137.         n_ioc = tmp /sizeof(struct spi_ioc_transfer); 
  138.        if (n_ioc == 0) 
  139.            break
  140.  
  141.        /*在内核中分配装载这些数据的内存空间*/ 
  142.         ioc = kmalloc(tmp, GFP_KERNEL); 
  143.        if (!ioc) { 
  144.             retval = -ENOMEM; 
  145.            break
  146.         } 
  147.        /*把用户空间的数据拷贝过来*/ 
  148.        if (__copy_from_user(ioc, (void __user *)arg, tmp)) { 
  149.             kfree(ioc); 
  150.             retval = -EFAULT; 
  151.            break
  152.         } 
  153.  
  154.        /*进行数据传输*/ 
  155.        retval = spidev_message(spidev, ioc, n_ioc); //spidev_message(spidev,struct spi_io_transfer ioc,int no);
  156.         kfree(ioc); 
  157.        break
  158.     } 
  159.  
  160.     mutex_unlock(&spidev->buf_lock); 
  161.     spi_dev_put(spi); 
  162.    return retval; 
  163.  

下面跟踪spidev_message看看:

[cpp] view plain copy
  1. staticint spidev_message(struct spidev_data *spidev, 
  2.        struct spi_ioc_transfer *u_xfers, unsigned n_xfers) 
  3.    struct spi_message  msg; 
  4.    struct spi_transfer *k_xfers; 
  5.    struct spi_transfer *k_tmp; 
  6.    struct spi_ioc_transfer *u_tmp; 
  7.     unsigned        n, total; 
  8.     u8          *buf; 
  9.    int         status = -EFAULT; 
  10.    /*初始化spi_message的tranfers链表头*/ 
  11.     spi_message_init(&msg); 
  12.    /*分配n个spi_transfer的内存空间,一个spi_message由多个数据段spi_message组成*/ 
  13.     k_xfers = kcalloc(n_xfers,sizeof(*k_tmp), GFP_KERNEL); 
  14.    if (k_xfers == NULL) 
  15.        return -ENOMEM; 
  16.  
  17.     buf = spidev->buffer; 
  18.     total = 0; 
  19.    /*这个for循环的主要任务是将所有的spi_transfer组装成一个spi_message*/ 
  20.    for (n = n_xfers, k_tmp = k_xfers, u_tmp = u_xfers; 
  21.             n; 
  22.             n--, k_tmp++, u_tmp++) { 
  23.        /*u_tmp是从用户空间传下来的spi_ioc_message的大小,spi_ioc_message是对spi_message的映射*/ 
  24.         k_tmp->len = u_tmp->len; 
  25.        /*统计要传输数据的总量*/ 
  26.         total += k_tmp->len; 
  27.        if (total > bufsiz) { 
  28.             status = -EMSGSIZE; 
  29.            goto done; 
  30.         } 
  31.        /*spi_transfer是一个读写的buffer对,如果是要接收则把buffer给接收的rx_buf*/ 
  32.        if (u_tmp->rx_buf) { 
  33.             k_tmp->rx_buf = buf; 
  34.            if (!access_ok(VERIFY_WRITE, (u8 __user *) 
  35.                         (uintptr_t) u_tmp->rx_buf, 
  36.                         u_tmp->len)) 
  37.                goto done; 
  38.         } 
  39.        /*如果要传输,这个buffer给tx_buf使用,从用户空间拷过来要传输的数据*/ 
  40.        if (u_tmp->tx_buf) { 
  41.             k_tmp->tx_buf = buf; 
  42.            if (copy_from_user(buf, (const u8 __user *) 
  43.                         (uintptr_t) u_tmp->tx_buf, 
  44.                     u_tmp->len)) 
  45.                goto done; 
  46.         } 
  47.        /*指向下一段内存*/ 
  48.         buf += k_tmp->len; 
  49.        /*最后一个transfer传输完毕是否会影响片选*/ 
  50.         k_tmp->cs_change = !!u_tmp->cs_change; 
  51.        /*每字长的字节数*/ 
  52.         k_tmp->bits_per_word = u_tmp->bits_per_word; 
  53.        /*一段数据传输完需要一定的时间等待*/ 
  54.         k_tmp->delay_usecs = u_tmp->delay_usecs; 
  55.        /*初始化传输速度*/ 
  56.         k_tmp->speed_hz = u_tmp->speed_hz; 
  57.        /*将spi_transfer通过它的transfer_list字段挂到spi_message的transfer队列上*/ 
  58.         spi_message_add_tail(k_tmp, &msg); //将一个spi_transfer 添加到msg链表上,将所有任务添加到msg
  59.     } 
  60.    /*调用底层的传输函数*/ 
  61.    status = spidev_sync(spidev, &msg); 
  62.    if (status < 0) 
  63.        goto done; 
  64.  
  65.    /* copy any rx data out of bounce buffer */ 
  66.     buf = spidev->buffer; 
  67.    /*把传输数据拷贝到用户空间打印出来,可以查看是否传输成功*/ 
  68.    for (n = n_xfers, u_tmp = u_xfers; n; n--, u_tmp++) { 
  69.        if (u_tmp->rx_buf) { //上层有数据要接受
  70.            if (__copy_to_user((u8 __user *) 
  71.                     (uintptr_t) u_tmp->rx_buf, buf, 
  72.                     u_tmp->len)) { 
  73.                 status = -EFAULT; 
  74.                goto done; 
  75.             } 
  76.         } 
  77.         buf += u_tmp->len; 
  78.     } 
  79.     status = total; 
  80.  
  81. done: 
  82.     kfree(k_xfers); 
  83.    return status; 
  84.  

看spidev_sync的实现:

[cpp] view plain copy
  1. static ssize_t 
  2. spidev_sync(struct spidev_data *spidev,struct spi_message *message) 
  3.    /*声明并初始化一个完成量*/ 
  4.     DECLARE_COMPLETION_ONSTACK(done); 
  5.    int status; 
  6.    /*指定spi_message使用的唤醒完成量函数*/ 
  7.     message->complete = spidev_complete; 
  8.     message->context = &done; 
  9.  
  10.     spin_lock_irq(&spidev->spi_lock); 
  11.    if (spidev->spi == NULL) 
  12.         status = -ESHUTDOWN; 
  13.    else 
  14.        /*调用spi核心中的函数进行数据传输*/ 
  15.    status = spi_async(spidev->spi, message); //开始真正的传输
  16.     spin_unlock_irq(&spidev->spi_lock); 
  17.  
  18.    if (status == 0) { 
  19.        /*等待完成量被唤醒*/ 
  20.         wait_for_completion(&done); //同步机制,见下面--由于传输和本线程是两个不同的线程,所以要同步
  21.         status = message->status; 
  22.        if (status == 0) 
  23.             status = message->actual_length; 
  24.     } 
  25.    return status; 
  26.  
spi_async在spi.h中定义的:
[cpp] view plain copy
  1. staticinlineint 
  2. spi_async(struct spi_device *spi,struct spi_message *message) 
  3.     message->spi = spi; 
  4.    return spi->master->transfer(spi, message); 
  5.  
这里的master->transfer是在spi_bitbang_start中进行赋值的:

bitbang->master->transfer= spi_bitbang_transfer;

看spi_bitbang_transfer的实现:

[cpp] view plain copy
  1. int spi_bitbang_transfer(struct spi_device *spi, struct spi_message *m) 
  2.    struct spi_bitbang  *bitbang; 
  3.     unsignedlong       flags; 
  4.    int         status = 0; 
  5.  
  6.     m->actual_length = 0; 
  7.     m->status = -EINPROGRESS; 
  8.    /*在spi_alloc_master函数中调用spi_master_set_devdata把struct s3c24xx_spi结构存放起来,而struct spi_bitbang正是struct s3c24xx_spi结构所包含的第一个结构*/ 
  9.     bitbang = spi_master_get_devdata(spi->master); 
  10.  
  11.     spin_lock_irqsave(&bitbang->lock, flags); 
  12.    if (!spi->max_speed_hz) 
  13.         status = -ENETDOWN; 
  14.    else
  15.        /*把message加入到bitbang的等待队列中*/ 
  16.         list_add_tail(&m->queue, &bitbang->queue); 
  17.        /*把bitbang-work加入bitbang->workqueue中,调度运行*/ 
  18.         queue_work(bitbang->workqueue, &bitbang->work); 
  19.     } 
  20.     spin_unlock_irqrestore(&bitbang->lock, flags); 
  21.  
  22.    return status; 
  23. EXPORT_SYMBOL_GPL(spi_bitbang_transfer); 
  24.  

分析工作队列的处理函数:

spi驱动框架源码分析_第5张图片
 
[cpp] view plain copy
  1. staticvoid bitbang_work(struct work_struct *work) 
  2.    struct spi_bitbang  *bitbang = 
  3.         container_of(work,struct spi_bitbang, work); 
  4.     unsignedlong       flags; 
  5.  
  6.     spin_lock_irqsave(&bitbang->lock, flags); 
  7.    /*设置成忙状态*/ 
  8.     bitbang->busy = 1; 
  9.    /*对bitqueue中的每一个spi_message进行处理*/ 
  10.    while (!list_empty(&bitbang->queue)) { 
  11.        struct spi_message  *m; 
  12.        struct spi_device   *spi; 
  13.         unsigned        nsecs; 
  14.        struct spi_transfer *t = NULL; 
  15.         unsigned        tmp; 
  16.         unsigned        cs_change; 
  17.        int         status; 
  18.        int         (*setup_transfer)(struct spi_device *, 
  19.                        struct spi_transfer *); 
  20.  
  21.         m = container_of(bitbang->queue.next,struct spi_message, 
  22.                 queue); 
  23.        /*从队列中驱动这个spi_message*/ 
  24.         list_del_init(&m->queue); 
  25.         spin_unlock_irqrestore(&bitbang->lock, flags); 
  26.  
  27.         nsecs = 100; 
  28.  
  29.         spi = m->spi; 
  30.         tmp = 0; 
  31.         cs_change = 1; 
  32.         status = 0; 
  33.         setup_transfer = NULL; 
  34.        /*对spi_message的transfers上的每个spi_transfer进行处理*/ 
  35.         list_for_each_entry (t, &m->transfers, transfer_list) { 
  36.         

               /* override speed or wordsize? */
               if (t->speed_hz || t->bits_per_word)
                  do_setup = 1;//重新设置

              /* init (-1) or override (1) transfer params */
                  if (do_setup != 0) {
                      status = bitbang->setup_transfer(spi, t);//如果transfer里设置了speed_hz或者bits_per_word要重新设置传输参数=s3c24xx_spi_setupxfer
                  if (status < 0)
                         break;
                   if (do_setup == -1)
                       do_setup = 0;
                  }

       /* set up default clock polarity, and activate chip;
        * this implicitly updates clock and spi modes as
        * previously recorded for this device via setup().
        * (and also deselects any other chip that might be
        * selected ...)
        */
       if (cs_change) {//最初本代码里cs_change=1,
        bitbang->chipselect(spi, BITBANG_CS_ACTIVE);
        ndelay(nsecs);
       }
       cs_change = t->cs_change;//cs_change=本次处理cs的设定值。通常1至n-1的cs=0,n的cs=1,即执行最后一个transfer后要取消片选

     
  37.            if (t->len) {  //说明有数据要处理               
  38.                if (!m->is_dma_mapped) 
  39.                     t->rx_dma = t->tx_dma = 0; 
  40.                /*调用bitbang->txrx_bufs进行数据的传输,bitbang->txrx_bufs = s3c24xx_spi_txrx;这个在s3c24xx_spi_probe中进行赋值的*/ 
  41.                status = bitbang->txrx_bufs(spi, t); //一次所有传输完毕,才会结束
  42.           }
  43.        。。。。。。。。
  44.     /* protocol tweaks before next transfer */
        if (t->delay_usecs)
         udelay(t->delay_usecs);

        if (cs_change && !list_is_last(&t->transfer_list, &m->transfers)) {
        /* sometimes a short mid-message deselect of the chip
         * may be needed to terminate a mode or command
         */
         ndelay(nsecs);
         bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
         ndelay(nsecs);
         }

  45.    } //一个transfer执行完毕,循环下一个
  46.         。。。。。。。。。。。。。。。。 
  47.  
  48.         m->status = status; 
  49.        /*传输完成,唤醒刚才的那个完成变量*/ 
  50.         m->complete(m->context); //同步机制,唤醒对象见上面
  51.  
  52.        /* restore speed and wordsize */ 
  53.        if (setup_transfer) 
  54.             setup_transfer(spi, NULL); 
  55.        //假设transfer[0].cs_chagen=0,[1]..[n-1]=0,[n]=1,这里判断的cs_transfer是最后一个transfer
  56.        if (!(status == 0 && cs_change)) { 
  57.             ndelay(nsecs); 
  58.             bitbang->chipselect(spi, BITBANG_CS_INACTIVE); 
  59.             ndelay(nsecs); 
  60.         } 
  61.  
  62.         spin_lock_irqsave(&bitbang->lock, flags); 
  63.     } 
  64.     bitbang->busy = 0; 
  65.     spin_unlock_irqrestore(&bitbang->lock, flags); 
  66.  
这个工作队列的处理函数中调用了spi controller driver中的传输函数:
[cpp] view plain copy
  1. static int s3c24xx_spi_txrx(struct spi_device *spi,struct spi_transfer *t) 
  2.    struct s3c24xx_spi *hw = to_hw(spi); 
  3.  
  4.     dev_dbg(&spi->dev,"txrx: tx %p, rx %p, len %d\n"
  5.         t->tx_buf, t->rx_buf, t->len); 
  6.  
  7.     hw->tx = t->tx_buf; //发送指针 
  8.     hw->rx = t->rx_buf; //接收指针 
  9.     hw->len = t->len;   //需要发送/接收的数目 
  10.     hw->count = 0;      //存放实际spi传输的数据数目 
  11.    /*初始化了完成量*/ 
  12.     init_completion(&hw->done); 
  13.      
  14.    /*
  15.      *只需发送第一个字节(如果发送为空,则发送0xff),每发送完一字节就会进一次中断。判断是否发送完毕,否则继续发送。(并不是在中断中发送,而是在中断中判断是否所有数据执行完毕)
  16.      */ 
  17.     writeb(hw_txbyte(hw, 0), hw->regs + S3C2410_SPTDAT);//发送结束即接收结束
  18.    /*等待完成量被唤醒*/ 
  19.     wait_for_completion(&hw->done); //等待该次transfer传输完毕(被唤醒2)
  20.    return hw->count; 
  21. staticinline unsignedint hw_txbyte(struct s3c24xx_spi *hw, int count) 
  22.        return hw->tx ? hw->tx[count] : 0xff; 
  23.        //如果还有数据没接收完且要发送的数据经已发送完毕,发送空数据0xFF 
  24.  
下面来分析中断函数:
[cpp] view plain copy
  1. static irqreturn_t s3c24xx_spi_irq(int irq, void *dev) 
  2.    struct s3c24xx_spi *hw = dev; 
  3.    /*读取spi的状态寄存器*/ 
  4.     unsignedint spsta = readb(hw->regs + S3C2410_SPSTA); 
  5.     unsignedint count = hw->count; 
  6.    /*检测冲突*/ 
  7.    if (spsta & S3C2410_SPSTA_DCOL) {              
  8.         dev_dbg(hw->dev,"data-collision\n");  
  9.        /*唤醒完成量*/ 
  10.         complete(&hw->done); 
  11.        goto irq_done; 
  12.     } 
  13.    /*设备忙*/ 
  14.    if (!(spsta & S3C2410_SPSTA_READY)) { 
  15.         dev_dbg(hw->dev,"spi not ready for tx?\n"); 
  16.        /*唤醒完成量*/ 
  17.         complete(&hw->done); 
  18.        goto irq_done; 
  19.     } 
  20.  
  21.     hw->count++; 
  22.    /*接收数据*/ 
  23.    if (hw->rx) 
  24.         hw->rx[count] = readb(hw->regs + S3C2410_SPRDAT); 
  25.  
  26.     count++; //count对于发送和接受都可以用
  27.              //对于接收已经接收到一字节,要存储下一字节,自加1
  28.              //对于发送,进入到中断时已经发送完毕一字节,可以发送下一字节了,所以自加1
  29.    /*如果count小于需要发送或接收数据的数目,继续发送其他数据*/ 
  30.    if (count < hw->len) 
  31.         writeb(hw_txbyte(hw, count), hw->regs + S3C2410_SPTDAT); 
  32.    else 
  33.        /*唤醒完成量,通知s3c24xx_spi_txrx函数*/ 
  34.         complete(&hw->done); //该次transfer传输完毕(唤醒2)
  35.  
  36. irq_done: 
  37.    return IRQ_HANDLED; 
  38.  
至此spi数据传输过程完成,如果不想为自己的SPI设备写驱动,那么可以用Linux自带的spidev.c提供的驱动程序,只要在登记时,把设备名设置成spidev就可以了。spidev.c会在device目录下自动为每一个匹配的SPI设备创建设备节点,节点名"spi%d"。之后,用户程序可以通过字符型设备的通用接口控制SPI设备。需要注意的是,spidev创建的设备在设备模型中属于虚拟设备,他的class是spidev_class,他的父设备是在boardinfo中定义的spi设备。
  • if (!bitbang->txrx_bufs) { //在s3c24xx_spi_probe里定义了txrx_bufs
  •         bitbang->use_dma =0
  •         /*spi_s3c24xx.c中有spi_bitbang_bufs方法,在bitbang_work中被调用*/ 
  •         bitbang->txrx_bufs =spi_bitbang_bufs
  • 你可能感兴趣的:(spi驱动框架源码分析)