MSI-HOWTO

來自內核文檔/Documentation/pci/MSI-HOWTO.txt

1. 什麼是MSI

MSI全稱Message Signaled Interrupt。
當設備向一個特殊地址寫入時，會向CPU產生一箇中斷，即也MSI中斷。
MSI能力最初在PCI 2.2裏定義，在PCI 3.0裏被強化，使得每個中斷都可以單獨控制。
PCI 3.0還引入了MSI-X能力，相比MSI，每個設備可以支持更多的中斷，並且可以獨立配置。

設備可以同時支持MSI和MSI-X，但同一時刻只能使能其中一種。

2. 爲什麼使用MSI

與傳統引腳中斷相比，有三個方面的優勢。
基於引腳的PCI中斷經常在幾個設備間共享，內核必須調用與該中斷相關的每一箇中斷處理函數，降低了效率。MSI不是共享的，所以不存在這個問題。
當設備向內存寫入數據，然後發起引腳中斷時，有可能在CPU收到中斷時，數據還未到達內存（在PCI-PCI橋後的設備更有可能如此）。爲了保證數據已達內存，中斷處理程序必須輪詢產生該中斷的設備的一個寄存器，PCI事務保序規則會確保所有數據到達內存後，寄存器纔會返回值。
使用MSI時，產生中斷的寫不能越過數據寫，因而避免了這個問題。當中斷產生時，驅動可以確信所有數據已經到達內存。

PCI的每個功能設備只支持一個基於引腳的中斷，驅動常常需要查詢設備來確定發生的事件，降低了中斷處理的效率。通過MSI，一個設備可以支持多箇中斷，這樣可以爲不同的使用不同的中斷。比如：

     1. 給不常發生的事件（如錯誤）指定獨立的中斷，這樣驅動可以正常中斷路徑進行更有效的處理。

     2. 給網卡的每個報文隊列或者存儲控制器的每個端口分配中斷。

3. 如何使用MSI

PCI設備初始化爲使用基於引腳的中斷，設備驅動需要將設備配置爲使用MSI或MSI-X。不是所有的設備可以完整支持MSI，下面有些API就直接返回失敗，因此仍然使用基於引腳的中斷。

3.1 內核提供MSI支持

內核需要配置CONFIG_PCI_MSI以支持MSI或者MSI-X，該配置是否可以配置受架構和其它一些配置的影響。

3.2 使用MSI

大部分工作在PCI層的驅動裏完成，只需要請求PCI層爲設備設置MSI能力即可。

3.2.1 pci_enable_msi

int pci_enable_msi(struct pci_dev *dev)
這個調用只給設備分配一箇中斷，不管設備支持多少個MSI中斷。設備會從基於引腳中斷模式切換爲MSI模式。dev->irq會賦予一個新的代表MSI的編號。

在驅動需要在調用request_irq()之前調用這個接口。因爲打開MSI中斷的同時會禁用引腳中斷IRQ，驅動因此不會收到舊的中斷。

3.2.2 pci_enable_msi_block

int pci_enable_msi_block(struct pci_dev *dev, int count)
這個接口是pci_enable_msi的變種，它可以請求多個MSI中斷。MSI規範要求中斷必須以2的冪分配，最多爲2^5(32)。
如果函數返回0，則表示成功分配了不少於驅動請求的中斷數量（可能會大於請求數量）。該函數打開設備的MSI，並將中斷組的最小編號賦給dev->irq，該設備的中斷範圍爲dev->irq至dev->irq + count - 1。
如果函數返回負值，表示設備無法提供更多的中斷，驅動不應試圖再去請求。如果返回的是正值，這個值會小於count，表示目前最分配的最大中斷數量。對這於兩種情況，函數都不會更新irq值，設備也不會切換到MSI模式。

設備驅動必須要正確處理上述第二種情況。在中斷數量不夠的情況下，有的設備尚可工作，驅動就應再次調用pci_enable_msi_block()。不過由於一些限制，第二次調用未必也可以成功。

3.2.3 pci_disable_msi

void pci_disable_msi(struct pci_dev *dev)
該函數的功能是撤消pci_enable_msi()或pci_enable_msi_block()的工作。它恢復dev->irq爲引腳中斷號，釋放此前分配的MSI。中斷號之後有可能分配給其它設備，因此驅動不應保留dev->irq的值。

驅動必須調用free_irq()以釋放之前request_irq()分配的中斷號。否則會產生BUG_ON()，設備將繼續保持MSI使能，並泄露中斷向量。

3.3 使用MSI-X

MSI-X能力比MSI更爲靈活，它支持2048箇中斷，每個中斷都可以單獨控制。要支持這種能力，驅動必須使用結構數組struct msix_entry。

struct msix_entry {
     u16 vector;     /* kernel uses to write alloc vector */
     u16 entry;     /* driver uses to specify entry */
}

struct msix_entry {
     u16 vector;     /* kernel uses to write alloc vector */
     u16 entry;     /* driver uses to specify entry */
}

這個定義允許設備以分散的方式使用中斷（比如使用中斷3和1027，只需分配兩個數組元素）。驅動負責填充數組各元素的entry部分，以使內核爲其分配中斷。不能給多個entry賦予相同的編號。

3.3.1 pci_enable_msix

int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec)
該函數向PCI子系統請求分配nvec個MSI中斷。入參entries指向結構數組，元素個數不少於nvec。函數返回0表示調用成功，設備被切換至MSI-X中斷模式，數組元素中的vector字段也被填充爲中斷號。驅動接下來爲每個需要使用的vector調用request_irq()。
如果函數返回負值，則表示出錯，驅動不應再從該設備申請分配MSI-X中斷。如果返回的是正值，則表示最大可以分配的中斷數。
該函數與pci_enable_msi()不同之處在於它不修改dev->irq，一旦MSI-X使能後，dev->irq這個中斷號不會再產生中斷。驅動需要記錄已分配的MSI-X中斷號，以保證後續的資源釋放。
一般來說，驅動在設備初始化時調用一次該函數。
由於種種原因，內核有可能無法提供驅動所要求的中斷數量，一個好的驅動應該能夠處理可變數量的MSI-X中斷。下面是一個例子：

static int foo_driver_enable_msix(struct foo_adapter *adapter,
int nvec)
{
     while (nvec >= FOO_DRIVER_MINIMUM_NVEC)
     {
          rc = pci_enable_msix(adapter->pdev, adapter->msix_entries, nvec);
          if (rc > 0)
               nvec = rc;
          else
               return rc;
     }
     return -ENOSPC;

}

static int foo_driver_enable_msix(struct foo_adapter *adapter, int nvec)
{
     while (nvec >= FOO_DRIVER_MINIMUM_NVEC)
     {
          rc = pci_enable_msix(adapter->pdev, adapter->msix_entries, nvec);
          if (rc > 0)
               nvec = rc;
          else
               return rc;
     }
     return -ENOSPC;

}

3.3.2 pci_disable_msix

void pci_disable_msix(struct pci_dev *dev)
這個函數的作用是撤銷pci_enable_msix()的工作，它釋放之前分配的MSI中斷。同樣，釋放的中斷號後續可能會分配給其它設備，驅動不應再記錄使用這些中斷號。

在調用這個函數之前，驅動必須調用free_irq()以釋放request_irq()分配的中斷號，否則會產生BUG_ON，設備將維持在MSI使能的狀態，並泄漏中斷向量。

3.3.3 MSI-X表

MSI-X能力指定了一個BAR及BAR內偏移量用於訪問MSI-X表，這個地址由PCI子系統映射，驅動不應該直接訪問。如果驅動想屏蔽或者開啓一箇中斷，應該調用disable_irq()/enable_irq()。

3.4 處理同時支持MSI和MSI-X能力的設備

如果設備同時支持MSI和MSI-X，則可以運行在MSI模式或者MSI-X模式下，但不能同時運行，這是PCI規則的要求，因此PCI層也進行了限制。在MSI-X使能的情況下調用pci_enable_msi()或者在MSI使能的情況下調用pci_enable_msix()將產生錯誤。如果設備驅動在運行時希望在MSI和MSI-X之間切換，它必須先停止設備，然後將其切換爲引腳中斷模式，然後再通過pci_enable_msi()或pci_enable_msix()進入MSI或MSI-X模式。這種操作並不常見，在開發過程中用於調試/測試。

3.5 使用MSI的考慮

3.5.1 選擇MSI-X和MSI

如果設備同時支持MSI-X和MSI能力，應優先考慮使用MSI-X。MSI-X支持1~2048間任意數量的中斷，而MSI只支持32箇中斷（並且必須是2的冪）。MSI中斷必須是連續分配的，系統不能像MSI-X那樣分配這麼多的中斷向量。在某些平臺上，MSI中斷只能發送給一個CPU組，MSI-X中斷可以發給不同的CPU。

3.5.2 spinlock

多數驅動爲每個設備定義了一個spinlock，在中斷處理函數中取鎖，對於引腳中斷或者單個MSI中斷，不需要禁用中斷（Linux保證同一個中斷不會重入）。如果設備使用了多箇中斷，驅動在持鎖期間必須禁用中斷，否則在設備產生另一箇中斷時，驅動會遞歸取鎖從而產生死鎖。
有兩個解決方法，一個是使用spin_lock_irqsave()或spin_lock_irq()，另一個是在request_irq()調用時指定IRQF_DISABLED，內核會在禁用中斷的環境下完成整個中斷處理過程。

如果MSI中斷處理程序不在整個過程中持鎖，使用第一種方法是最好的。如果想避免在中斷禁用/使能狀態間切換，則選擇第二種方法。

3.6 如何得知設備的MSI/MSI-X已經使能

使用lspci -v。有些設備會顯示"MSI"、"Message Signaled Interrupts"或者"MSI-X"能力，使能的會在前面顯示+，禁用的會顯示"-"。

4. MSI quirks

一些PCI芯片或設備不支持MSI，PCI子系統提供了三種方法禁用MSI：
     1. 全局禁用
     2. 禁用特定橋之下的所有設備

     3. 禁用某個設備

4.1 全局禁用

有些host芯片不能正確支持MSI，如果廠家在ACPI FADT表中明確了，Linux會自動禁用MSI。有些單板沒有在這個表包含這樣的信息，需要自己檢測，這些都列在drivers/pci/quriks.c中的quirk_disable_all_msi()中了。

如果單板在MSI支持上有問題，可以在內核命令參數里加上pci=nomsi以禁用所有設備的MSI。

4.2 禁用特定橋之下的所有設備

有些PCI橋不能在總線間正確地傳遞MSI，這種情況必須禁用該橋之下所有設備的MSI。
有些橋允許通過配置空間的某些位來使能MSI。在可能的情況下，Linux會盡量打開host芯片的MSI支持。如果某個橋片Linux並不識別，而你確定它可以使用MSI，可以通過下面的命令打開MSI支持。
     echo 1 > /sys/bus/pci/devices/$bridge/msi_bus
$bridge是橋的PCI地址（比如0000:00:0e.0）。

要禁用MSI，使用echo 0即可。

4.3 禁用某個設備

如果某些設備已知在MSI實現上有問題，一般是在設備驅動裏處理，如果有必要，也可以在quirk裏處理。

4.4 設備MSI被禁用的原因查找

除上述情況外，還有很多原因會導致一個設備的MSI沒有使能，第一步應該仔細檢查dmesg，看MSI有沒有使能，還要檢查CONFIG_PCI_MSI配置有沒有打開。
通過lspci -t可以查看設備之上的橋，讀取/sys/bus/pci/devices/*/msi_bus看MSI是否使能了。
檢查設備驅動是否支持MSI，比如是否調用了pci_enable_msi(), pci_enable_msix()或者pci_enable_msi_block()等等。