davinci平台的spi驱动框架

  1. 一、SPI总线概述
  2. SPI是英语Serial Peripheral interface的缩写,顾名思义就是串行外围设备接口,是Motorola首先在其MC68HCXX系列处理器上定义的。SPI接口主要应用在 EEPROM,FLASH,实时时钟,AD转换器,还有数字信号处理器和数字信号解码器之间。SPI是一种高速的,全双工,同步的通信总线,并且在芯片的管脚上只占用四根线,节约了芯片的管脚,同时为PCB的布局上节省空间,提供方便。
  3. SPI的通信原理很简单,它以主从方式工作,这种模式通常有一个主设备和一个或多个从设备,需要4根线,事实上3根也可以。也是所有基于SPI的设备共有的,它们是SDI(数据输入),SDO(数据输出),SCLK(时钟),CS(片选)
  4. MOSI(SDO):主器件数据输出,从器件数据输入。
  5. MISO(SDI):主器件数据输入,从器件数据输出。
  6. SCLK :时钟信号,由主器件产生。
  7. CS:从器件使能信号,由主器件控制。
  8. 其中CS是控制芯片是否被选中的,也就是说只有片选信号为预先规定的使能信号时(高电位或低电位),对此芯片的操作才有效,这就允许在同一总线上连接多个SPI设备成为可能。需要注意的是,在具体的应用中,当一条SPI总线上连接有多个设备时,SPI本身的CS有可能被其他的GPIO脚代替,即每个设备的CS脚被连接到处理器端不同的GPIO,通过操作不同的GPIO口来控制具体的需要操作的SPI设备,减少各个SPI设备间的干扰。
  9. SPI是串行通讯协议,也就是说数据是一位一位从MSB或者LSB开始传输的,这就是SCK时钟线存在的原因,由SCK提供时钟脉冲,MISO、MOSI则基于此脉冲完成数据传输。 SPI支持4-32bits的串行数据传输,支持MSB和LSB,每次数据传输时当从设备的大小端发生变化时需要重新设置SPI Master的大小端。

  10. 二、Linux SPI驱动总体架构
  11. 在2.6的linux内核中,SPI的驱动架构可以分为如下三个层次:SPI 核心层、SPI控制器驱动层和SPI设备驱动层。Linux 中SPI驱动代码位于drivers/spi目录。
  12. 1.SPI核心层
  13. SPI核心层是Linux的SPI核心部分,提供了核心数据结构的定义、SPI控制器驱动和设备驱动的注册、注销管理等API。其为硬件平台无关层,向下屏蔽了物理总线控制器的差异,定义了统一的访问策略和接口;其向上提供了统一的接口,以便SPI设备驱动通过总线控制器进行数据收发。
  14. Linux中,SPI核心层的代码位于driver/spi/spi.c。

  15. 2.SPI控制器驱动层
  16. SPI控制器驱动层,每种处理器平台都有自己的控制器驱动,属于平台移植相关层。它的职责是为系统中每条SPI总线实现相应的读写方法。在物理上,每个SPI控制器可以连接若干个SPI从设备。
  17. 在系统开机时,SPI控制器驱动被首先装载。一个控制器驱动用于支持一条特定的SPI总线的读写。一个控制器驱动可以用数据结构struct spi_master来描述。

  18. 3.SPI设备驱动层
  19. SPI设备驱动层为用户接口层,其为用户提供了通过SPI总线访问具体设备的接口。
  20. SPI设备驱动层可以用两个模块来描述,struct spi_driver和struct spi_device。
  21. Driver是为device服务的,spi_driver注册时会扫描SPI bus上的设备,进行驱动和设备的绑定,probe函数用于驱动和设备匹配时被调用。从上面的结构体注释中我们可以知道,SPI的通信是通过消息队列机制,而不是像I2C那样通过与从设备进行对话的方式。

  22. 三、spi子系统主要数据结构
  23. 1.在Linux中,使用spi_master结构来描述一个SPI主机控制器的驱动。
  24. struct spi_master { 
  25.     struct device dev; 
  26.     s16 bus_num; //为该控制器对应的SPI总线号
  27.     u16 num_chipselect; //控制器支持的片选数量,即能支持多少个spi设备,从设备的片选号不能大于这个数量
  28.     u16 dma_alignment; 
  29.     int (*setup)(struct spi_device *spi);//函数是设置SPI总线的模式,时钟等的初始化函数, 针对设备设置SPI的工作时钟及数据传输模式等。在spi_add_device函数中调用
  30.     int (*transfer)(struct spi_device *spi,struct spi_message *mesg);//实现SPI总线读写方法的函数。实现数据的双向传输,可能会睡眠 
  31.     void (*cleanup)(struct spi_device *spi); //注销时候调用
  32. };
  33. //分配,注册和注销的SPI主机的API由SPI核心提供:
  34. struct spi_master *spi_alloc_master(struct device *host, unsigned size); 
  35. int spi_register_master(struct spi_master *master); 
  36. void spi_unregister_master(struct spi_master *master); 
  37.    
  38. 2.在Linux中用spi_driver来描述一个SPI外设驱动。
  39. struct spi_driver {
  40.     const struct spi_device_id *id_table;//匹配的设备表
  41.     int            (*probe)(struct spi_device *spi);
  42.     int            (*remove)(struct spi_device *spi);
  43.     void        (*shutdown)(struct spi_device *spi);
  44.     int            (*suspend)(struct spi_device *spi, pm_message_t mesg);
  45.     int            (*resume)(struct spi_device *spi);
  46.     struct device_driver    driver;
  47. }; 

  48. 3.Linux用spi_device来描述一个SPI外设设备。
  49. struct spi_device { 
  50.     struct device        dev;
  51.     struct spi_master    *master;//对应的控制器指针
  52.     u32            max_speed_hz;//spi通信的时钟
  53.     u8            chip_select; //片选,用于区分同一总线上的不同设备
  54.     u8            mode;
  55. #define    SPI_CPHA    0x01            /* clock phase */
  56. #define    SPI_CPOL    0x02            /* clock polarity */
  57. #define    SPI_MODE_0    (0|0)            /* (original MicroWire) */
  58. #define    SPI_MODE_1    (0|SPI_CPHA)
  59. #define    SPI_MODE_2    (SPI_CPOL|0)
  60. #define    SPI_MODE_3    (SPI_CPOL|SPI_CPHA)
  61. #define    SPI_CS_HIGH    0x04            /* chipselect active high? */
  62. #define    SPI_LSB_FIRST    0x08            /* per-word bits-on-wire */
  63. #define    SPI_3WIRE    0x10            /* SI/SO signals shared */
  64. #define    SPI_LOOP    0x20            /* loopback mode */
  65. #define    SPI_NO_CS    0x40            /* 1 dev/bus, no chipselect */
  66. #define    SPI_READY    0x80            /* slave pulls low to pause */
  67.     u8            bits_per_word;//每个字长的比特数
  68.     int            irq;//使用的中断号
  69.     void            *controller_state;
  70.     void            *controller_data;
  71.     char            modalias[SPI_NAME_SIZE];//名字 
  72. }; 
  73. 看这三个结构的关系,这里spi_device与spi_master是同一个父设备,这是在spi_new_device函数中设定的,一般这个设备是一个物理设备。
  74. davinci平台的spi驱动框架_第1张图片
  75. 4.为了解决多个不同的SPI设备共享SPI控制器而带来的访问冲突,spi_bitbang使用内核提供的工作队列(workqueue)。 workqueue是Linux内核中定义的一种回调处理方式。采用这种方式需要传输数据时,不直接完成数据的传输,而是将要传输的工作分装成相应的消息 (spi_message),发送给对应的workqueue,由与workqueue关联的内核守护线程(daemon)负责具体的执行。由于 workqueue会将收到的消息按时间先后顺序排列,这样就是对设备的访问严格串行化,解决了冲突。
  76. struct spi_bitbang { 
  77.     struct workqueue_struct *workqueue;//工作队列头 
  78.     struct work_struct work;//每一次传输都传递下来一个spi_message,都向工作队列头添加一个 
  79.     workspinlock_t lock; 
  80.     struct list_head queue;//挂接spi_message,如果上一次的spi_message还没有处理完,接下来的spi_message就挂接在queue上等待处理 
  81.     u8 busy;//忙碌标志 
  82.     u8 use_dma; 
  83.     u8 flags; 
  84.     struct spi_master *master;//指向spi控制器
  85.     int (*setup_transfer)(struct spi_device *spi,struct spi_transfer *t);//设置传输模式 
  86.     void (*chipselect)(struct spi_device *spi, int is_on);//片选 
  87. #define BITBANG_CS_ACTIVE 1 /* normally nCS, active low */ 
  88. #define BITBANG_CS_INACTIVE 0 
  89.     int (*txrx_bufs)(struct spi_device *spi, struct spi_transfer *t);//传输函数
  90.     u32 (*txrx_word[4])(struct spi_device *spi,unsigned nsecs,u32 word, u8 bits); 
  91. }; 

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

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

  118. 7.spi控制器驱动的私有数据
  119. struct davinci_spi {
  120.     struct spi_bitbang    bitbang;
  121.     struct clk        *clk;//时钟
  122.     u8            version;
  123.     resource_size_t        pbase;//spi寄存器物理地址
  124.     void __iomem        *base;//spi寄存器虚拟地址
  125.     u32            irq;//spi中断号
  126.     struct completion    done;

  127.     const void    *tx;//发送buffer
  128.     void            *rx;//读buffer
  129. #define SPI_TMP_BUFSZ    (SMP_CACHE_BYTES + 1)
  130.     u8            rx_tmp_buf[SPI_TMP_BUFSZ];
  131.     int            rcount;//读数据个数
  132.     int            wcount;//写数据个数
  133.     struct davinci_spi_dma    dma;
  134.     struct davinci_spi_platform_data *pdata;

  135.     void        (*get_rx)(u32 rx_data, struct davinci_spi *);//读数据函数
  136.     u32            (*get_tx)(struct davinci_spi *);//发送数据函数
  137.     u8            bytes_per_word[SPI_MAX_CHIPSELECT];
  138.     u32            speed;
  139.     u32            cs_num;
  140.     bool        in_use;

  141. #ifdef CONFIG_CPU_FREQ
  142.     struct notifier_block freq_transition;
  143. #endif
  144. };


  145. 四、spi驱动初始化
  146. 1.spi总线注册
  147. //spi总线结构
  148. struct bus_type spi_bus_type = {
  149.     .name        = "spi",
  150.     .dev_attrs    = spi_dev_attrs,
  151.     .match        = spi_match_device,
  152.     .uevent        = spi_uevent,
  153.     .suspend    = spi_suspend,
  154.     .resume        = spi_resume,
  155. };

  156. //spi_master类,会在sysfs文件系统创建该类
  157. static struct class spi_master_class = {
  158.     .name        = "spi_master",
  159.     .owner        = THIS_MODULE,
  160.     .dev_release    = spi_master_release,
  161. };

  162. static int __init spi_init(void)
  163. {
  164.     int    status;

  165.     buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
  166.     if (!buf) {
  167.         status = -ENOMEM;
  168.         goto err0;
  169.     }
  170.     //分别对应sysfs文件系统中的sys/bus/下的spi目录和sys/class/下的spi_master目录。
  171.     status = bus_register(&spi_bus_type);//注册spi总线
  172.     if (status < 0)
  173.         goto err1;

  174.     status = class_register(&spi_master_class);//创建spi_master的类
  175.     if (status < 0)
  176.         goto err2;
  177.     return 0;

  178. err2:
  179.     bus_unregister(&spi_bus_type);
  180. err1:
  181.     kfree(buf);
  182.     buf = NULL;
  183. err0:
  184.     return status;
  185. }

  186. 2.spi控制器管脚的复用配置
  187. const short da850_spi0_pins[] __initdata = {
  188.     DA850_SPI0_CLK,DA850_SPI0_ENA,DA850_SPI0_SOMI,DA850_SPI0_SIMO,
  189.     -1
  190. };

  191. static __init void da850_evm_init(void)
  192. {
  193.     //......
  194.     ret = davinci_cfg_reg_list(da850_spi0_pins);//复用管脚配置
  195.     if (ret)
  196.         pr_warning("da850_evm_init: spi0 mux setup failed: %d\n",    ret);
  197.     //......    
  198. }

  199. 3.注册spi的platform device设备        
  200. static struct spi_board_info da850evm_spi_info[] = {
  201.     {
  202.         .modalias = "ads7846",//设备名,与spi_driver中定义的名字相同
  203.         .bus_num = 0,
  204.         .chip_select = 0,
  205.         .max_speed_hz = 1500000,
  206.         .mode             = SPI_MODE_0,
  207.         .irq = 128,//GPIO1[11]
  208.         .platform_data = &ads7846_config,
  209.         }, 
  210. };

  211. static void __init da850evm_init_spi0(struct spi_board_info *info, unsigned len)
  212. {
  213.     int ret;
  214.     
  215.     //注册spi设备的信息到board_list链表中,待spi master注册好后扫描这些板级设备再进行注册
  216.     ret = spi_register_board_info(info, len);
  217.     if (ret)
  218.         pr_warning("failed to register board info : %d\n", ret);
  219.     
  220.     //注册spi0的platform device
  221.     ret = da8xx_register_spi(0, &da850evm_spi0_pdata);
  222.     if (ret)
  223.         pr_warning("failed to register spi 1 device : %d\n", ret);

  224.     if (!(system_rev & 0x100))
  225.         register_mtd_user(&spi_notifier);
  226. }

  227. int __init spi_register_board_info(struct spi_board_info const *info, unsigned n)
  228. {
  229.     struct boardinfo *bi;
  230.     int i;

  231.     bi = kzalloc(* sizeof(*bi), GFP_KERNEL);//分配一个boardinfo结构
  232.     if (!bi)
  233.         return -ENOMEM;

  234.     for (= 0; i < n; i++, bi++, info++) {
  235.         struct spi_master *master;
  236.         memcpy(&bi->board_info, info, sizeof(*info));//填充boardinfo结构
  237.         mutex_lock(&board_lock);
  238.         list_add_tail(&bi->list, &board_list);//挂载到全局链表board_list中
  239.         
  240.         //遍历spi_master_list链表,查看是否有spi设备在此spi控制器上,现在因为spi master尚未注册,不会注册板级设备。
  241.         //待spi控制器注册后,还会扫描链表进行匹配,来注册板级设备
  242.         list_for_each_entry(master, &spi_master_list, list)
  243.             spi_match_master_to_boardinfo(master, &bi->board_info);
  244.         mutex_unlock(&board_lock);
  245.     }
  246.     return 0;
  247. }

  248. static struct resource da8xx_spi0_resources[] = {
  249.     [0] = {
  250.         .start = 0x01c41000,
  251.         .end = 0x01c41fff,
  252.         .flags = IORESOURCE_MEM,
  253.     },
  254.     [1] = {
  255.         .start = IRQ_DA8XX_SPINT0,
  256.         .end = IRQ_DA8XX_SPINT0,
  257.         .flags = IORESOURCE_IRQ,
  258.     },
  259.     [2] = {
  260.         .start = EDMA_CTLR_CHAN(0, 14),
  261.         .end = EDMA_CTLR_CHAN(0, 14),
  262.         .flags = IORESOURCE_DMA,
  263.     },
  264.     [3] = {
  265.         .start = EDMA_CTLR_CHAN(0, 15),
  266.         .end = EDMA_CTLR_CHAN(0, 15),
  267.         .flags = IORESOURCE_DMA,
  268.     },
  269.     [4] = {
  270.         .start = 0,
  271.         .end = 0,
  272.         .flags = IORESOURCE_DMA,
  273.     },
  274. };

  275. static struct platform_device da8xx_spi_device[] = {
  276.     [0] = {
  277.         .name = "spi_davinci",
  278.         .id = 0,
  279.         .num_resources = ARRAY_SIZE(da8xx_spi0_resources),
  280.         .resource = da8xx_spi0_resources,
  281.     },
  282.     [1] = {
  283.         .name = "spi_davinci",
  284.         .id = 1,
  285.         .num_resources = ARRAY_SIZE(da8xx_spi1_resources),
  286.         .resource = da8xx_spi1_resources,
  287.     },
  288. };

  289. int __init da8xx_register_spi(int instance,struct davinci_spi_platform_data *pdata)
  290. {
  291.     struct platform_device *pdev;

  292.     if (instance == 0)
  293.         pdev = &da8xx_spi_device[0];
  294.     else if (instance == 1)
  295.         pdev = &da8xx_spi_device[1];
  296.     else
  297.         return -EINVAL;

  298.     pdev->dev.platform_data = pdata;

  299.     return platform_device_register(pdev);//注册platform device设备
  300. }

  301. 4.注册platform driver,会注册spi控制器spi_master

  302. static struct platform_driver davinci_spi_driver = {
  303.     .driver = {
  304.         .name = "spi_davinci",
  305.         .owner = THIS_MODULE,
  306.     },
  307.     .remove = __exit_p(davinci_spi_remove),
  308.     .suspend = davinci_spi_suspend,
  309.     .resume = davinci_spi_resume,
  310. };

  311. static int __init davinci_spi_init(void)
  312. {
  313.     return platform_driver_probe(&davinci_spi_driver, davinci_spi_probe);
  314. }

  315. //platform driver与platform device匹配成功后,调用davinci_spi_probe
  316. static int davinci_spi_probe(struct platform_device *pdev)
  317. {
  318.     struct spi_master *master;
  319.     struct davinci_spi *dspi;
  320.     struct davinci_spi_platform_data *pdata;
  321.     struct resource *r, *mem;
  322.     resource_size_t dma_rx_chan = SPI_NO_RESOURCE;
  323.     resource_size_t    dma_tx_chan = SPI_NO_RESOURCE;
  324.     resource_size_t    dma_eventq = SPI_NO_RESOURCE;
  325.     int i = 0, ret = 0;
  326.     u32 spipc0;

  327.     pdata = pdev->dev.platform_data;
  328.     if (pdata == NULL) {
  329.         ret = -ENODEV;
  330.         goto err;
  331.     }
  332.     
  333.     //分配一个spi控制器的spi_master结构,分配struct spi_master + struct davinci_spi大小的数据,把davinci_spi设为spi_master的私有数据
  334.     master = spi_alloc_master(&pdev->dev, sizeof(struct davinci_spi));
  335.     if (master == NULL) {
  336.         ret = -ENOMEM;
  337.         goto err;
  338.     }
  339.     
  340.     //把spi_master设置为platform_device结构中dev的私有数据
  341.     dev_set_drvdata(&pdev->dev, master);
  342.     
  343.     //从master中获得私有数据davinci_spi
  344.     dspi = spi_master_get_devdata(master);
  345.     if (dspi == NULL) {
  346.         ret = -ENOENT;
  347.         goto free_master;
  348.     }
  349.     
  350.     //从platform device的私有数据中获得spi控制器的寄存器物理地址资源
  351.     r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  352.     if (== NULL) {
  353.         ret = -ENOENT;
  354.         goto free_master;
  355.     }
  356.     dspi->pbase = r->start;//spi寄存器起始物理地址
  357.     dspi->pdata = pdata;
  358.     
  359.     //为spi控制器的物理地址申请内存空间
  360.     mem = request_mem_region(r->start, resource_size(r), pdev->name);
  361.     if (mem == NULL) {
  362.         ret = -EBUSY;
  363.         goto free_master;
  364.     }
  365.     
  366.     //将spi控制器的寄存器物理地址映射到内核空间
  367.     dspi->base = ioremap(r->start, resource_size(r));
  368.     if (dspi->base == NULL) {
  369.         ret = -ENOMEM;
  370.         goto release_region;
  371.     }
  372.     
  373.     //从platform device的私有数据中获得spi控制器的中断号
  374.     dspi->irq = platform_get_irq(pdev, 0);
  375.     if (dspi->irq <= 0) {
  376.         ret = -EINVAL;
  377.         goto unmap_io;
  378.     }
  379.     
  380.     //申请中断号
  381.     ret = request_irq(dspi->irq, davinci_spi_irq, 0, dev_name(&pdev->dev),dspi);
  382.     if (ret)
  383.         goto unmap_io;
  384.     
  385.     //spi master计数加1,且
  386.     dspi->bitbang.master = spi_master_get(master);
  387.     if (dspi->bitbang.master == NULL) {
  388.         ret = -ENODEV;
  389.         goto irq_free;
  390.     }
  391.     
  392.     //获得spi时钟
  393.     dspi->clk = clk_get(&pdev->dev, NULL);
  394.     if (IS_ERR(dspi->clk)) {
  395.         ret = -ENODEV;
  396.         goto put_master;
  397.     }
  398.     clk_enable(dspi->clk);//时钟使能

  399.     master->bus_num = pdev->id;//spi控制器所在的spi总线号
  400.     master->num_chipselect = pdata->num_chipselect;//spi控制器的片选数量
  401.     master->setup = davinci_spi_setup;//spi控制器的setup函数
  402.     
  403.     //spi_bitbang专门负责数据的传输*
  404.     dspi->bitbang.chipselect = davinci_spi_chipselect;//片选选择函数
  405.     dspi->bitbang.setup_transfer = davinci_spi_setup_transfer;//建立传输的函数

  406.     dspi->version = pdata->version;//版本号SPI_VERSION_2
  407.     //设置一些标志位
  408.     dspi->bitbang.flags = SPI_NO_CS | SPI_LSB_FIRST | SPI_LOOP;
  409.     if (dspi->version == SPI_VERSION_2)
  410.         dspi->bitbang.flags |= SPI_READY;
  411.     
  412.     //DMA操作的一些设置
  413.     r = platform_get_resource(pdev, IORESOURCE_DMA, 0);
  414.     if (r)
  415.         dma_rx_chan = r->start;
  416.     r = platform_get_resource(pdev, IORESOURCE_DMA, 1);
  417.     if (r)
  418.         dma_tx_chan = r->start;
  419.     r = platform_get_resource(pdev, IORESOURCE_DMA, 2);
  420.     if (r)
  421.         dma_eventq = r->start;

  422.     //数据传输函数
  423.     dspi->bitbang.txrx_bufs = davinci_spi_bufs;
  424.     //没有使用DMA
  425.     if (dma_rx_chan != SPI_NO_RESOURCE &&dma_tx_chan != SPI_NO_RESOURCE &&dma_eventq != SPI_NO_RESOURCE) {
  426.         dspi->dma.rx_channel = dma_rx_chan;
  427.         dspi->dma.tx_channel = dma_tx_chan;
  428.         dspi->dma.eventq = dma_eventq;

  429.         ret = davinci_spi_request_dma(dspi);
  430.         if (ret)
  431.             goto free_clk;

  432.         dev_info(&pdev->dev, "DMA: supported\n");
  433.         dev_info(&pdev->dev, "DMA: RX channel: %d, TX channel: %d, event queue: %d\n", dma_rx_chan, dma_tx_chan,dma_eventq);
  434.     }
  435.     
  436.     //设置spi的读写函数
  437.     dspi->get_rx = davinci_spi_rx_buf_u8;
  438.     dspi->get_tx = davinci_spi_tx_buf_u8;

  439.     init_completion(&dspi->done);
  440.     ret = davinci_spi_cpufreq_register(dspi);//cpu变频相关操作
  441.     if (ret) {
  442.         pr_info("davinci SPI contorller driver failed to register cpufreq\n");
  443.         goto free_dma;
  444.     }

  445.     iowrite32(0, dspi->base + SPIGCR0);//reset spi控制器
  446.     udelay(100);
  447.     iowrite32(1, dspi->base + SPIGCR0);//跳出spi控制器reset状态

  448.     //初始化设置寄存器,包括对SPIMOSI,SPIMISO,SPICLK引脚的设置
  449.     spipc0 = SPIPC0_DIFUN_MASK | SPIPC0_DOFUN_MASK | SPIPC0_CLKFUN_MASK;
  450.     iowrite32(spipc0, dspi->base + SPIPC0);

  451.     //GPIO作为片选管脚的初始化
  452.     if (pdata->chip_sel) {
  453.         for (= 0; i < pdata->num_chipselect; i++) {
  454.             if (pdata->chip_sel[i] != SPI_INTERN_CS)
  455.                 gpio_direction_output(pdata->chip_sel[i], 1);
  456.         }
  457.     }

  458.     if (pdata->intr_line)
  459.         iowrite32(SPI_INTLVL_1, dspi->base + SPILVL);//设置spi中断的等级
  460.     else
  461.         iowrite32(SPI_INTLVL_0, dspi->base + SPILVL);

  462.     iowrite32(CS_DEFAULT, dspi->base + SPIDEF);//设置片选寄存器,写入默认值0xFF

  463.     /* master mode default */
  464.     set_io_bits(dspi->base + SPIGCR1, SPIGCR1_CLKMOD_MASK);//设置为master模式
  465.     set_io_bits(dspi->base + SPIGCR1, SPIGCR1_MASTER_MASK);//设置为master模式
  466.     set_io_bits(dspi->base + SPIGCR1, SPIGCR1_POWERDOWN_MASK);//设置为power-down模式

  467.     //设置bitbang传输
  468.     ret = spi_bitbang_start(&dspi->bitbang);
  469.     if (ret)
  470.         goto free_dma;

  471.     dev_info(&pdev->dev, "Controller at 0x%p\n", dspi->base);

  472.     return ret;

  473. free_dma:
  474.     edma_free_channel(dspi->dma.tx_channel);
  475.     edma_free_channel(dspi->dma.rx_channel);
  476.     edma_free_slot(dspi->dma.dummy_param_slot);
  477. free_clk:
  478.     clk_disable(dspi->clk);
  479.     clk_put(dspi->clk);
  480. put_master:
  481.     spi_master_put(master);
  482. irq_free:
  483.     free_irq(dspi->irq, dspi);
  484. unmap_io:
  485.     iounmap(dspi->base);
  486. release_region:
  487.     release_mem_region(dspi->pbase, resource_size(r));
  488. free_master:
  489.     kfree(master);
  490. err:
  491.     return ret;
  492. }

  493. int spi_bitbang_start(struct spi_bitbang *bitbang)
  494. {
  495.     int    status;

  496.     if (!bitbang->master || !bitbang->chipselect)
  497.         return -EINVAL;
  498.     
  499.      /*初始化一个工作队列,后面再create_singlethread_workqueue,等到有数据要传输的时候,在spi_bitbang_transfer函数中通过调用queue_work(bitbang->workqueue, &bitbang->work),把work扔进workqueue中调度运行,这是内核的一贯做法*/
  500.     //动态创建一个work_struct结构,它的处理函数是bitbang_work
  501.     INIT_WORK(&bitbang->work, bitbang_work);
  502.     spin_lock_init(&bitbang->lock);//初始化自旋锁和链表头
  503.     INIT_LIST_HEAD(&bitbang->queue);//初始化链表头

  504.     if (!bitbang->master->mode_bits)
  505.         bitbang->master->mode_bits = SPI_CPOL | SPI_CPHA | bitbang->flags;

  506.     if (!bitbang->master->transfer)
  507.         bitbang->master->transfer = spi_bitbang_transfer;//spi数据的传输就是通过调用这个方法来实现的
  508.     
  509.     //数据传输过程:spi_bitbang_transfer-->......-->davinci_spi_bufs
  510.     if (!bitbang->txrx_bufs) {//前边已经赋值davinci_spi_bufs
  511.         bitbang->use_dma = 0;
  512.         bitbang->txrx_bufs = spi_bitbang_bufs;
  513.         if (!bitbang->master->setup) {
  514.             if (!bitbang->setup_transfer)
  515.                 bitbang->setup_transfer =
  516.                      spi_bitbang_setup_transfer;
  517.             bitbang->master->setup = spi_bitbang_setup;
  518.             bitbang->master->cleanup = spi_bitbang_cleanup;
  519.         }
  520.     } else if (!bitbang->master->setup)
  521.         return -EINVAL;

  522.     bitbang->busy = 0;
  523.     //调用create_singlethread_workqueue创建单个工作线程
  524.     bitbang->workqueue = create_singlethread_workqueue(dev_name(bitbang->master->dev.parent));
  525.     if (bitbang->workqueue == NULL) {
  526.         status = -EBUSY;
  527.         goto err1;
  528.     }

  529.     //注册spi主机控制器
  530.     status = spi_register_master(bitbang->master);
  531.     if (status < 0)
  532.         goto err2;

  533.     return status;

  534. err2:
  535.     destroy_workqueue(bitbang->workqueue);
  536. err1:
  537.     return status;
  538. }

  539. int spi_register_master(struct spi_master *master)
  540. {
  541.     static atomic_t        dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
  542.     struct device        *dev = master->dev.parent;
  543.     struct boardinfo    *bi;
  544.     int            status = -ENODEV;
  545.     int            dynamic = 0;

  546.     if (!dev)
  547.         return -ENODEV;

  548.     //spi控制器的片选数量不能为0
  549.     if (master->num_chipselect == 0)
  550.         return -EINVAL;

  551.     if (master->bus_num < 0) {//spi控制器总线号不能为0
  552.         master->bus_num = atomic_dec_return(&dyn_bus_id);
  553.         dynamic = 1;
  554.     }

  555.     spin_lock_init(&master->bus_lock_spinlock);
  556.     mutex_init(&master->bus_lock_mutex);
  557.     master->bus_lock_flag = 0;

  558.     //设置spi控制器的名称,即在sysfs文件系统中显示的名称
  559.     dev_set_name(&master->dev, "spi%u", master->bus_num);
  560.     
  561.     //设备添加到内核,会在sysfs文件系统下创建属性文件,这也是sys/class/spi_master下产生spi0,spi1的原因
  562.     status = device_add(&master->dev);
  563.     if (status < 0)
  564.         goto done;
  565.     dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),dynamic ? " (dynamic)" : "");

  566.     mutex_lock(&board_lock);
  567.     list_add_tail(&master->list, &spi_master_list);//将spi控制器的master挂载到全局链表spi_master_list
  568.     
  569.     /*在spi controller的driver注册的时候不但注册这个主机控制器的驱动,还要遍历这个主机控制器的总线上的spi_device,
  570.     将总线上的 spi_device全部注册进内核。当注册进内核并且spi_driver已经注册的时候,如果总线match成功,
  571.     则会调用spi_driver的 probe函数,这个将在后边进行分析。
  572.     */
  573.     list_for_each_entry(bi, &board_list, list)//遍历每个boardinfo管理的spi_board_info,如果设备的总线号与控制器的总线好相等,则创建新设备
  574.         spi_match_master_to_boardinfo(master, &bi->board_info);
  575.     mutex_unlock(&board_lock);

  576.     status = 0;
  577.     /* Register devices from the device tree */
  578.     of_register_spi_devices(master);
  579. done:
  580.     return status;
  581. }

  582. static void spi_match_master_to_boardinfo(struct spi_master *master,struct spi_board_info *bi)
  583. {
  584.     struct spi_device *dev;

  585.     if (master->bus_num != bi->bus_num)//要在同一个spi总线上
  586.         return;
  587.     
  588.     //向spi控制器添加spi device
  589.     dev = spi_new_device(master, bi);
  590.     if (!dev)
  591.         dev_err(master->dev.parent, "can't create new device for %s\n",bi->modalias);
  592. }

  593. struct spi_device *spi_new_device(struct spi_master *master,struct spi_board_info *chip)
  594. {
  595.     struct spi_device    *proxy;
  596.     int            status;

  597.     //分配spi_device,并初始化spi->dev的一些字段
  598.     proxy = spi_alloc_device(master);
  599.     if (!proxy)
  600.         return NULL;

  601.     WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
  602.     //初始化spi_device的各个字段
  603.     proxy->chip_select = chip->chip_select;//片选号
  604.     proxy->max_speed_hz = chip->max_speed_hz;
  605.     proxy->mode = chip->mode;
  606.     proxy->irq = chip->irq;
  607.     strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));//spi设备的名字
  608.     proxy->dev.platform_data = (void *) chip->platform_data;
  609.     proxy->controller_data = chip->controller_data;
  610.     proxy->controller_state = NULL;
  611.     
  612.     //添加spi设备
  613.     status = spi_add_device(proxy);
  614.     if (status < 0) {
  615.         spi_dev_put(proxy);
  616.         return NULL;
  617.     }

  618.     return proxy;
  619. }

  620. int spi_add_device(struct spi_device *spi)
  621. {
  622.     static DEFINE_MUTEX(spi_add_lock);
  623.     struct device *dev = spi->master->dev.parent;
  624.     struct device *d;
  625.     int status;

  626.     //spi设备的片选号不能超过spi控制器的片选数量
  627.     if (spi->chip_select >= spi->master->num_chipselect) {
  628.         dev_err(dev, "cs%d >= max %d\n",spi->chip_select,spi->master->num_chipselect);
  629.         return -EINVAL;
  630.     }

  631.     //这里设置是spi_device在Linux设备驱动模型中的name,也就是spi0.0
  632.     dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),spi->chip_select);
  633.     mutex_lock(&spi_add_lock);

  634.     //如果总线上挂的设备已经有这个名字,则设置状态忙碌,并退出
  635.     d = bus_find_device_by_name(&spi_bus_type, NULL, dev_name(&spi->dev));
  636.     if (!= NULL) {
  637.         dev_err(dev, "chipselect %d already in use\n",spi->chip_select);
  638.         put_device(d);
  639.         status = -EBUSY;
  640.         goto done;
  641.     }

  642.     //对spi_device进行设置
  643.     status = spi_setup(spi);
  644.     if (status < 0) {
  645.         dev_err(dev, "can't setup %s, status %d\n",dev_name(&spi->dev), status);
  646.         goto done;
  647.     }

  648.     //添加到内核,在sysfs文件系统下创建相应的属性文件(设备文件dev文件不会在这里创建,下边注册spi device驱动时会创建dev文件)
  649.     status = device_add(&spi->dev);
  650.     if (status < 0)
  651.         dev_err(dev, "can't add %s, status %d\n",dev_name(&spi->dev), status);
  652.     else
  653.         dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));

  654. done:
  655.     mutex_unlock(&spi_add_lock);
  656.     return status;
  657. }

  658. int spi_setup(struct spi_device *spi)
  659. {
  660.     unsigned    bad_bits;
  661.     int        status;

  662.     bad_bits = spi->mode & ~spi->master->mode_bits;
  663.     if (bad_bits) {
  664.         dev_err(&spi->dev, "setup: unsupported mode bits %x\n",bad_bits);
  665.         return -EINVAL;
  666.     }
  667.     
  668.     if (!spi->bits_per_word)
  669.         spi->bits_per_word = 8;

  670.     status = spi->master->setup(spi);//调用davinci_spi_setup

  671.     dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s"
  672.                 "%u bits/w, %u Hz max --> %d\n",
  673.             (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
  674.             (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
  675.             (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
  676.             (spi->mode & SPI_3WIRE) ? "3wire, " : "",
  677.             (spi->mode & SPI_LOOP) ? "loopback, " : "",
  678.             spi->bits_per_word, spi->max_speed_hz,
  679.             status);

  680.     return status;
  681. }

  682. static int davinci_spi_setup(struct spi_device *spi)
  683. {
  684.     int retval = 0;
  685.     struct davinci_spi *dspi;
  686.     struct davinci_spi_platform_data *pdata;
  687.     
  688.     //从spi master的私有数据中取出davinci_spi
  689.     dspi = spi_master_get_devdata(spi->master);
  690.     pdata = dspi->pdata;

  691.     //设置了每字长的位数,发送速度
  692.     if (!spi->bits_per_word)
  693.         spi->bits_per_word = 8;

  694.     //设置spi片选管脚
  695.     if (!(spi->mode & SPI_NO_CS)) {
  696.         if ((pdata->chip_sel == NULL) ||(pdata->chip_sel[spi->chip_select] == SPI_INTERN_CS))
  697.             set_io_bits(dspi->base + SPIPC0, 1 << spi->chip_select);
  698.     }

  699.     //使能spi控制器
  700.     if (spi->mode & SPI_READY)
  701.         set_io_bits(dspi->base + SPIPC0, SPIPC0_SPIENA_MASK);

  702.     //是否使能内部loop-back测试模式
  703.     if (spi->mode & SPI_LOOP)
  704.         set_io_bits(dspi->base + SPIGCR1, SPIGCR1_LOOPBACK_MASK);
  705.     else
  706.         clear_io_bits(dspi->base + SPIGCR1, SPIGCR1_LOOPBACK_MASK);

  707.     return retval;
  708. }

  709. 5.spi device的驱动注册,并创建设备节点
  710. static struct spi_driver ads7846_driver = {
  711.     .driver = {
  712.         .name    = "ads7846",
  713.         .bus    = &spi_bus_type,
  714.         .owner    = THIS_MODULE,
  715.     },
  716.     .probe        = ads7846_probe,
  717.     .remove        = __devexit_p(ads7846_remove),
  718.     .suspend    = ads7846_suspend,
  719.     .resume        = ads7846_resume,
  720. };

  721. static int __init ads7846_init(void)
  722. {
  723.     return spi_register_driver(&ads7846_driver);
  724. }

  725. //驱动与设备匹配成功后,会调用ads7846_probe函数,此函数会创建spi设备的字符设备,设备节点,这里创建的是/dev/input/event0

你可能感兴趣的:(转载)