分析Linux內核中的SPI驅動源碼

作者：編碼小哥 2023-04-28 08:42:08

系統 Linux

本文分析了Linux內核中的SPI驅動源碼，介紹了SPI驅動框架的基本結構、Spi.c的結構和作用以及SPI驅動中的重要數據結構和函數。

本文將對Linux內核中的SPI驅動源碼進行分析，包括SPI驅動框架的基本結構、各文件的作用、重要的數據結構和函數等。

SPI(Serial Peripheral Interface)是一種串行通信接口，常常用于與數字外設進行通信，如傳感器、存儲器、網卡等。Linux內核提供了SPI驅動框架，用于向上層應用程序提供SPI接口。本文將對該框架進行深入分析。

一、SPI驅動框架的基本結構

在Linux內核中，SPI驅動框架的代碼位于/drivers/spi目錄下。該目錄下的源文件主要包括以下幾個：

spi.c：SPI總線設備驅動程序。
spi-bitbang.c：位壓縮SPI驅動程序。
spi-dw-dma.c：SPI DMA驅動程序。
spi-dw-mmio.c：SPI MMIO驅動程序。
spi-fsl-dspi.c：FSL DSPI驅動程序。
spi-imx.c：i.MX SPI驅動程序。
spi-pl022.c：ARM PrimeCell PL022 SPI驅動程序。
spi-s3c24xx.c：Samsung S3C24xx SPI驅動程序。
spi-tegra20-sflash.c：Nvidia SPI Flash驅動程序。
spi-ti-qspi.c：TI Quad SPI驅動程序。

這些驅動程序分別對應不同的SPI控制器。其中，spi.c是SPI驅動的核心文件，提供了SPI驅動框架的基本結構和主要函數。

二、spi.c的結構和作用

1、SPI驅動框架的初始化

SPI驅動框架的初始化主要在spi_init()函數中完成。該函數首先調用spi_bus_type_init()函數，注冊SPI設備總線，然后向/sys/class下的spi_master目錄中創建spi設備目錄，最后調用probe_master()函數，搜索當前系統中的SPI設備并添加到bus層中。該函數的代碼如下：

static int __init spi_init(void)
{
int status;
status = spi_bus_type_init();
if (status)
goto out;
status = class_register(&spi_master_class);
if (status)
goto bus_unregister;
status = spi_proc_init();
if (status)
goto class_unregister;
status = spi_gpio_register_board_info(NULL, 0);
if (status)
goto proc_cleanup;
status = spi_read_configfile();
if (status)
goto board_cleanup;
status = spi_master_probe_devices();
if (status)
goto board_cleanup;
printk(KERN_INFO "%s\n", spi_revision);
return 0;
board_cleanup:
spi_board_cleanup();
proc_cleanup:
spi_proc_cleanup();
class_unregister:
class_unregister(&spi_master_class);
bus_unregister:
spi_bus_type_exit();
out:
return status;
}

2、SPI總線設備的添加和刪除

當SPI總線設備（spi_master）被發現并添加到bus層時，會自動調用spi_master_add()函數，該函數會為SPI總線設備創建一個spi_master結構體，并將其添加到bus層中。

static int spi_master_add(struct spi_master *master)
{
struct device *dev = master->dev.parent;
struct spi_controller *ctlr = master->controller;
mutex_lock(&spi_mutex);
/*
? Implementation restriction: each SPI MASTER talks with other
? devices at constant signal levels, which don't change once
? operation starts. We don't provide any synchronization
? primitives that would be necessary for anything else.
*/
if (master->num_chipselect)
dev_warn(dev, "num_chipselect should == 1 when !is_slave\n");
if (!ctlr) {
ctlr = kzalloc(sizeof(struct spi_controller), GFP_KERNEL);
if (!ctlr) {
mutex_unlock(&spi_mutex);
return -ENOMEM;
}
ctlr->master = master;
master->controller = ctlr;
master->bits_per_word_mask = 0xFFFF;
if (!spi_controller_is_slave(master)) {
ctlr->max_speed_hz = spi_max_speed_hz(&ctlr->dev, master);
ctlr->setup = spi_master_setup;
ctlr->transfer_one = spi_transfer_one;
} else {
ctlr->max_speed_hz = master->max_speed_hz;
ctlr->setup = spi_slave_setup;
ctlr->transfer_one = spi_transfer_one_slave;
}
ctlr->bits_per_word_mask = master->bits_per_word_mask;
ctlr->flags = 0;
ctlr->mode_bits = master->mode_bits;
if (spi_controller_is_slave(master)) {
ctlr->mode_bits = 0;
ctlr->flags = SPI_CONTROLLER_SLAVE;
ctlr->bus_num = spi_slave_controller_id++;
idr_init(&ctlr->idr);
} else {
ctlr->mode_bits &= ctlr->controller_ops->get_mode_bits;
ctlr->flags |= SPI_CONTROLLER_MASTER;
ctlr->bus_num = spi_master_controller_id++;
}
dev_set_drvdata(dev, master);
dev_info(dev, "registered, %s%s%s%s%s\n",
ctlr->flags & SPI_CONTROLLER_MASTER ? "master" : "",
ctlr->flags & SPI_CONTROLLER_SLAVE ? "slave" : "",
ctlr->flags & SPI_CONTROLLER_CS_WORD ? "cs-high" : "",
ctlr->flags & SPI_CONTROLLER_NEEDS_POLL ? ", polling" : "",
ctlr->mode_bits ? ", mode " : "");
list_add_tail(&ctlr->list, &ctlr_list);
}
mutex_unlock(&spi_mutex);
return 0;
}

當SPI總線設備從bus層中刪除時，會自動調用spi_master_del()函數，該函數會刪除spi_master結構體并釋放相關資源。

static int spi_master_del(struct spi_master *master)
{
int my_bus_num = master->controller->bus_num;
mutex_lock(&spi_mutex);
if (my_bus_num < 0) { /* not yet attached */
mutex_unlock(&spi_mutex);
return -EINVAL;
}
if (!spi_controller_is_slave(master)) {
if (spi_master_get(master)) {
mutex_unlock(&spi_mutex);
return -EINVAL;
}
}
dev_info(&master->dev, "removed\n");
spi_controller_cleanup(master->controller);
kfree(master->controller);
return 0;
}

三、重要的數據結構和函數

1、spi_device

spi_device結構體表示一個SPI設備，包含了設備的名稱、片選信號、總線速率、數據位數、SPI傳輸設置等信息。該結構體被定義在include/linux/spi/spi.h頭文件中，其定義如下：

struct spi_device {
struct device dev;
spinlock_t regs_lock;
const struct spi_device *next;
u32 max_speed_hz;
u8 chip_select;
u8 mode;
u8 bit_order;
u16 flags;
u32 irq;
struct mutex io_mutex;
/* RT signal stuff */
struct rt_mutex rt;
struct spi_controller *controller;
};

spi_transfer結構體表示一次SPI傳輸，包含了傳輸的緩沖區、字節長度、傳輸設置等信息以及一個回調函數，用于在傳輸完成時通知上層應用程序。該結構體被定義在include/linux/spi/spi.h頭文件中，其定義如下：

struct spi_transfer {
const void *tx_buf;
void *rx_buf;
unsigned len;
u32 speed_hz;
u16 delay_usecs;
u8 bits_per_word;
/* Used internally, by spi_sync() and the SPI core code */
u8 cs_change:1;
u8 do_read:1;
u8 tx_nbits:6; /* internal, for packing only */
u8 rx_nbits:6; /* internal, for packing only */
u16 rdy_for_tx:1;
u16 rdy_for_rx:1;
u16 cs_change_delay:14;
u16 large_buf:1;
u8 *tx_buf_wr;
u8 *rx_buf_wr;
void *private_data;
void (*complete)(void *private_data);
};

3、spi_sync()

spi_sync()函數用于同步傳輸數據，該函數會等待傳輸完成并返回傳輸結果。該函數的代碼如下：

int spi_sync(struct spi_device *spi, struct spi_transfer *t)
{
DECLARE_COMPLETION_ONSTACK(done);
int status;
t->complete = spi_complete;
t->private_data = &done;
t->rdy_for_tx = t->rdy_for_rx = 0;
t->cs_change = spi->controller->cs_gpiod ? 1 : 0;
status = spi_async(spi, t);
if (status == 0) {
wait_for_completion(&done);
status = t->status;
if (status == -ETIMEDOUT)
status = -EIO;
}
return status;
}

4、spi_async()

spi_async()函數用于異步傳輸數據，該函數會啟動SPI傳輸，并立即返回，不等待傳輸完成。該函數的代碼如下：

int spi_async(struct spi_device *spi, struct spi_transfer *t)
{
struct spi_message msg;
int status;
memset(&msg, 0, sizeof(msg));
msg.spi = spi;
msg.complete = spi_complete;
msg.context = t;
msg.state = NULL;
msg.is_dma_mapped = false;
spi_prepare_message(&msg, t);
status = spi_async_locked(spi_get_parent_master(spi), &msg);
if (status == -EBUSY)
return -EAGAIN;
t->status = status;
if (msg.is_dma_mapped)
dma_unmap_sg(&spi->dev, msg.sgbuf, msg.nents, msg.direction);
if (msg.is_dma_mapped && msg.context && spi_need_dma_clean_up_on_error()) {
struct spi_controller *ctlr = spi->controller;
struct spi_transfer *xfer = msg.contexte
if (xfer->tx_buf && ctlr->dma_tx && ctlr->dma_tx->device->dev) {
dma_sync_sg_for_device(ctlr->dma_tx->device->dev,
msg.sgbuf,
msg.nents,
(ctlr->dma_tx_dir == DMA_MEM_TO_DEV) ?
DMA_TO_DEVICE : DMA_FROM_DEVICE);
dma_unmap_sg(ctlr->dma_tx->device->dev,
msg.sgbuf,
msg.nents,
ctlr->dma_tx_dir);
}
if (xfer->rx_buf && ctlr->dma_rx && ctlr->dma_rx->device->dev) {
dma_sync_sg_for_device(ctlr->dma_rx->device->dev,
msg.sgbuf,
msg.nents,
(ctlr->dma_rx_dir == DMA_MEM_TO_DEV) ?
DMA_TO_DEVICE : DMA_FROM_DEVICE);
dma_unmap_sg(ctlr->dma_rx->device->dev,
msg.sgbuf,
msg.nents,
ctlr->dma_rx_dir);
}
}
if (status == -EINPROGRESS || status == -EBUSY) {
status = 0;
} else if (unlikely(status)) {
dev_err(spi->dev.parent, "%s: spi_sync failed with status %d\n",
func, status);
}
return status;
}

四、總結

本文分析了Linux內核中的SPI驅動源碼，介紹了SPI驅動框架的基本結構、spi.c的結構和作用以及SPI驅動中的重要數據結構和函數。通讀本文后，讀者應該了解了SPI設備的工作原理和Linux內核中提供的SPI驅動框架的實現方式，理解了相關代碼的運行過程和涉及的系統調用，有助于讀者熟練掌握SPI驅動的編寫技巧。

責任編輯：姜華來源：今日頭條

Linux內核 SPI驅動