msi.c 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843
  1. /*
  2. * File: msi.c
  3. * Purpose: PCI Message Signaled Interrupt (MSI)
  4. *
  5. * Copyright (C) 2003-2004 Intel
  6. * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
  7. */
  8. #include <linux/err.h>
  9. #include <linux/mm.h>
  10. #include <linux/irq.h>
  11. #include <linux/interrupt.h>
  12. #include <linux/init.h>
  13. #include <linux/ioport.h>
  14. #include <linux/pci.h>
  15. #include <linux/proc_fs.h>
  16. #include <linux/msi.h>
  17. #include <linux/smp.h>
  18. #include <linux/errno.h>
  19. #include <linux/io.h>
  20. #include <linux/slab.h>
  21. #include "pci.h"
  22. #include "msi.h"
  23. static int pci_msi_enable = 1;
  24. /* Arch hooks */
  25. #ifndef arch_msi_check_device
  26. int arch_msi_check_device(struct pci_dev *dev, int nvec, int type)
  27. {
  28. return 0;
  29. }
  30. #endif
  31. #ifndef arch_setup_msi_irqs
  32. int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
  33. {
  34. struct msi_desc *entry;
  35. int ret;
  36. /*
  37. * If an architecture wants to support multiple MSI, it needs to
  38. * override arch_setup_msi_irqs()
  39. */
  40. if (type == PCI_CAP_ID_MSI && nvec > 1)
  41. return 1;
  42. list_for_each_entry(entry, &dev->msi_list, list) {
  43. ret = arch_setup_msi_irq(dev, entry);
  44. if (ret < 0)
  45. return ret;
  46. if (ret > 0)
  47. return -ENOSPC;
  48. }
  49. return 0;
  50. }
  51. #endif
  52. #ifndef arch_teardown_msi_irqs
  53. void arch_teardown_msi_irqs(struct pci_dev *dev)
  54. {
  55. struct msi_desc *entry;
  56. list_for_each_entry(entry, &dev->msi_list, list) {
  57. int i, nvec;
  58. if (entry->irq == 0)
  59. continue;
  60. nvec = 1 << entry->msi_attrib.multiple;
  61. for (i = 0; i < nvec; i++)
  62. arch_teardown_msi_irq(entry->irq + i);
  63. }
  64. }
  65. #endif
  66. static void msi_set_enable(struct pci_dev *dev, int pos, int enable)
  67. {
  68. u16 control;
  69. BUG_ON(!pos);
  70. pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &control);
  71. control &= ~PCI_MSI_FLAGS_ENABLE;
  72. if (enable)
  73. control |= PCI_MSI_FLAGS_ENABLE;
  74. pci_write_config_word(dev, pos + PCI_MSI_FLAGS, control);
  75. }
  76. static void msix_set_enable(struct pci_dev *dev, int enable)
  77. {
  78. int pos;
  79. u16 control;
  80. pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
  81. if (pos) {
  82. pci_read_config_word(dev, pos + PCI_MSIX_FLAGS, &control);
  83. control &= ~PCI_MSIX_FLAGS_ENABLE;
  84. if (enable)
  85. control |= PCI_MSIX_FLAGS_ENABLE;
  86. pci_write_config_word(dev, pos + PCI_MSIX_FLAGS, control);
  87. }
  88. }
  89. static inline __attribute_const__ u32 msi_mask(unsigned x)
  90. {
  91. /* Don't shift by >= width of type */
  92. if (x >= 5)
  93. return 0xffffffff;
  94. return (1 << (1 << x)) - 1;
  95. }
  96. static inline __attribute_const__ u32 msi_capable_mask(u16 control)
  97. {
  98. return msi_mask((control >> 1) & 7);
  99. }
  100. static inline __attribute_const__ u32 msi_enabled_mask(u16 control)
  101. {
  102. return msi_mask((control >> 4) & 7);
  103. }
  104. /*
  105. * PCI 2.3 does not specify mask bits for each MSI interrupt. Attempting to
  106. * mask all MSI interrupts by clearing the MSI enable bit does not work
  107. * reliably as devices without an INTx disable bit will then generate a
  108. * level IRQ which will never be cleared.
  109. */
  110. static u32 __msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
  111. {
  112. u32 mask_bits = desc->masked;
  113. if (!desc->msi_attrib.maskbit)
  114. return 0;
  115. mask_bits &= ~mask;
  116. mask_bits |= flag;
  117. pci_write_config_dword(desc->dev, desc->mask_pos, mask_bits);
  118. return mask_bits;
  119. }
  120. static void msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
  121. {
  122. desc->masked = __msi_mask_irq(desc, mask, flag);
  123. }
  124. /*
  125. * This internal function does not flush PCI writes to the device.
  126. * All users must ensure that they read from the device before either
  127. * assuming that the device state is up to date, or returning out of this
  128. * file. This saves a few milliseconds when initialising devices with lots
  129. * of MSI-X interrupts.
  130. */
  131. static u32 __msix_mask_irq(struct msi_desc *desc, u32 flag)
  132. {
  133. u32 mask_bits = desc->masked;
  134. unsigned offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
  135. PCI_MSIX_ENTRY_VECTOR_CTRL;
  136. mask_bits &= ~1;
  137. mask_bits |= flag;
  138. writel(mask_bits, desc->mask_base + offset);
  139. return mask_bits;
  140. }
  141. static void msix_mask_irq(struct msi_desc *desc, u32 flag)
  142. {
  143. desc->masked = __msix_mask_irq(desc, flag);
  144. }
  145. static void msi_set_mask_bit(unsigned irq, u32 flag)
  146. {
  147. struct msi_desc *desc = get_irq_msi(irq);
  148. if (desc->msi_attrib.is_msix) {
  149. msix_mask_irq(desc, flag);
  150. readl(desc->mask_base); /* Flush write to device */
  151. } else {
  152. unsigned offset = irq - desc->dev->irq;
  153. msi_mask_irq(desc, 1 << offset, flag << offset);
  154. }
  155. }
  156. void mask_msi_irq(unsigned int irq)
  157. {
  158. msi_set_mask_bit(irq, 1);
  159. }
  160. void unmask_msi_irq(unsigned int irq)
  161. {
  162. msi_set_mask_bit(irq, 0);
  163. }
  164. void read_msi_msg_desc(struct irq_desc *desc, struct msi_msg *msg)
  165. {
  166. struct msi_desc *entry = get_irq_desc_msi(desc);
  167. if (entry->msi_attrib.is_msix) {
  168. void __iomem *base = entry->mask_base +
  169. entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
  170. msg->address_lo = readl(base + PCI_MSIX_ENTRY_LOWER_ADDR);
  171. msg->address_hi = readl(base + PCI_MSIX_ENTRY_UPPER_ADDR);
  172. msg->data = readl(base + PCI_MSIX_ENTRY_DATA);
  173. } else {
  174. struct pci_dev *dev = entry->dev;
  175. int pos = entry->msi_attrib.pos;
  176. u16 data;
  177. pci_read_config_dword(dev, msi_lower_address_reg(pos),
  178. &msg->address_lo);
  179. if (entry->msi_attrib.is_64) {
  180. pci_read_config_dword(dev, msi_upper_address_reg(pos),
  181. &msg->address_hi);
  182. pci_read_config_word(dev, msi_data_reg(pos, 1), &data);
  183. } else {
  184. msg->address_hi = 0;
  185. pci_read_config_word(dev, msi_data_reg(pos, 0), &data);
  186. }
  187. msg->data = data;
  188. }
  189. }
  190. void read_msi_msg(unsigned int irq, struct msi_msg *msg)
  191. {
  192. struct irq_desc *desc = irq_to_desc(irq);
  193. read_msi_msg_desc(desc, msg);
  194. }
  195. void write_msi_msg_desc(struct irq_desc *desc, struct msi_msg *msg)
  196. {
  197. struct msi_desc *entry = get_irq_desc_msi(desc);
  198. if (entry->msi_attrib.is_msix) {
  199. void __iomem *base;
  200. base = entry->mask_base +
  201. entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
  202. writel(msg->address_lo, base + PCI_MSIX_ENTRY_LOWER_ADDR);
  203. writel(msg->address_hi, base + PCI_MSIX_ENTRY_UPPER_ADDR);
  204. writel(msg->data, base + PCI_MSIX_ENTRY_DATA);
  205. } else {
  206. struct pci_dev *dev = entry->dev;
  207. int pos = entry->msi_attrib.pos;
  208. u16 msgctl;
  209. pci_read_config_word(dev, msi_control_reg(pos), &msgctl);
  210. msgctl &= ~PCI_MSI_FLAGS_QSIZE;
  211. msgctl |= entry->msi_attrib.multiple << 4;
  212. pci_write_config_word(dev, msi_control_reg(pos), msgctl);
  213. pci_write_config_dword(dev, msi_lower_address_reg(pos),
  214. msg->address_lo);
  215. if (entry->msi_attrib.is_64) {
  216. pci_write_config_dword(dev, msi_upper_address_reg(pos),
  217. msg->address_hi);
  218. pci_write_config_word(dev, msi_data_reg(pos, 1),
  219. msg->data);
  220. } else {
  221. pci_write_config_word(dev, msi_data_reg(pos, 0),
  222. msg->data);
  223. }
  224. }
  225. entry->msg = *msg;
  226. }
  227. void write_msi_msg(unsigned int irq, struct msi_msg *msg)
  228. {
  229. struct irq_desc *desc = irq_to_desc(irq);
  230. write_msi_msg_desc(desc, msg);
  231. }
  232. static void free_msi_irqs(struct pci_dev *dev)
  233. {
  234. struct msi_desc *entry, *tmp;
  235. list_for_each_entry(entry, &dev->msi_list, list) {
  236. int i, nvec;
  237. if (!entry->irq)
  238. continue;
  239. nvec = 1 << entry->msi_attrib.multiple;
  240. for (i = 0; i < nvec; i++)
  241. BUG_ON(irq_has_action(entry->irq + i));
  242. }
  243. arch_teardown_msi_irqs(dev);
  244. list_for_each_entry_safe(entry, tmp, &dev->msi_list, list) {
  245. if (entry->msi_attrib.is_msix) {
  246. if (list_is_last(&entry->list, &dev->msi_list))
  247. iounmap(entry->mask_base);
  248. }
  249. list_del(&entry->list);
  250. kfree(entry);
  251. }
  252. }
  253. static struct msi_desc *alloc_msi_entry(struct pci_dev *dev)
  254. {
  255. struct msi_desc *desc = kzalloc(sizeof(*desc), GFP_KERNEL);
  256. if (!desc)
  257. return NULL;
  258. INIT_LIST_HEAD(&desc->list);
  259. desc->dev = dev;
  260. return desc;
  261. }
  262. static void pci_intx_for_msi(struct pci_dev *dev, int enable)
  263. {
  264. if (!(dev->dev_flags & PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG))
  265. pci_intx(dev, enable);
  266. }
  267. static void __pci_restore_msi_state(struct pci_dev *dev)
  268. {
  269. int pos;
  270. u16 control;
  271. struct msi_desc *entry;
  272. if (!dev->msi_enabled)
  273. return;
  274. entry = get_irq_msi(dev->irq);
  275. pos = entry->msi_attrib.pos;
  276. pci_intx_for_msi(dev, 0);
  277. msi_set_enable(dev, pos, 0);
  278. write_msi_msg(dev->irq, &entry->msg);
  279. pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &control);
  280. msi_mask_irq(entry, msi_capable_mask(control), entry->masked);
  281. control &= ~PCI_MSI_FLAGS_QSIZE;
  282. control |= (entry->msi_attrib.multiple << 4) | PCI_MSI_FLAGS_ENABLE;
  283. pci_write_config_word(dev, pos + PCI_MSI_FLAGS, control);
  284. }
  285. static void __pci_restore_msix_state(struct pci_dev *dev)
  286. {
  287. int pos;
  288. struct msi_desc *entry;
  289. u16 control;
  290. if (!dev->msix_enabled)
  291. return;
  292. BUG_ON(list_empty(&dev->msi_list));
  293. entry = list_first_entry(&dev->msi_list, struct msi_desc, list);
  294. pos = entry->msi_attrib.pos;
  295. pci_read_config_word(dev, pos + PCI_MSIX_FLAGS, &control);
  296. /* route the table */
  297. pci_intx_for_msi(dev, 0);
  298. control |= PCI_MSIX_FLAGS_ENABLE | PCI_MSIX_FLAGS_MASKALL;
  299. pci_write_config_word(dev, pos + PCI_MSIX_FLAGS, control);
  300. list_for_each_entry(entry, &dev->msi_list, list) {
  301. write_msi_msg(entry->irq, &entry->msg);
  302. msix_mask_irq(entry, entry->masked);
  303. }
  304. control &= ~PCI_MSIX_FLAGS_MASKALL;
  305. pci_write_config_word(dev, pos + PCI_MSIX_FLAGS, control);
  306. }
  307. void pci_restore_msi_state(struct pci_dev *dev)
  308. {
  309. __pci_restore_msi_state(dev);
  310. __pci_restore_msix_state(dev);
  311. }
  312. EXPORT_SYMBOL_GPL(pci_restore_msi_state);
  313. /**
  314. * msi_capability_init - configure device's MSI capability structure
  315. * @dev: pointer to the pci_dev data structure of MSI device function
  316. * @nvec: number of interrupts to allocate
  317. *
  318. * Setup the MSI capability structure of the device with the requested
  319. * number of interrupts. A return value of zero indicates the successful
  320. * setup of an entry with the new MSI irq. A negative return value indicates
  321. * an error, and a positive return value indicates the number of interrupts
  322. * which could have been allocated.
  323. */
  324. static int msi_capability_init(struct pci_dev *dev, int nvec)
  325. {
  326. struct msi_desc *entry;
  327. int pos, ret;
  328. u16 control;
  329. unsigned mask;
  330. pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
  331. msi_set_enable(dev, pos, 0); /* Disable MSI during set up */
  332. pci_read_config_word(dev, msi_control_reg(pos), &control);
  333. /* MSI Entry Initialization */
  334. entry = alloc_msi_entry(dev);
  335. if (!entry)
  336. return -ENOMEM;
  337. entry->msi_attrib.is_msix = 0;
  338. entry->msi_attrib.is_64 = is_64bit_address(control);
  339. entry->msi_attrib.entry_nr = 0;
  340. entry->msi_attrib.maskbit = is_mask_bit_support(control);
  341. entry->msi_attrib.default_irq = dev->irq; /* Save IOAPIC IRQ */
  342. entry->msi_attrib.pos = pos;
  343. entry->mask_pos = msi_mask_reg(pos, entry->msi_attrib.is_64);
  344. /* All MSIs are unmasked by default, Mask them all */
  345. if (entry->msi_attrib.maskbit)
  346. pci_read_config_dword(dev, entry->mask_pos, &entry->masked);
  347. mask = msi_capable_mask(control);
  348. msi_mask_irq(entry, mask, mask);
  349. list_add_tail(&entry->list, &dev->msi_list);
  350. /* Configure MSI capability structure */
  351. ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSI);
  352. if (ret) {
  353. msi_mask_irq(entry, mask, ~mask);
  354. free_msi_irqs(dev);
  355. return ret;
  356. }
  357. /* Set MSI enabled bits */
  358. pci_intx_for_msi(dev, 0);
  359. msi_set_enable(dev, pos, 1);
  360. dev->msi_enabled = 1;
  361. dev->irq = entry->irq;
  362. return 0;
  363. }
  364. static void __iomem *msix_map_region(struct pci_dev *dev, unsigned pos,
  365. unsigned nr_entries)
  366. {
  367. unsigned long phys_addr;
  368. u32 table_offset;
  369. u8 bir;
  370. pci_read_config_dword(dev, msix_table_offset_reg(pos), &table_offset);
  371. bir = (u8)(table_offset & PCI_MSIX_FLAGS_BIRMASK);
  372. table_offset &= ~PCI_MSIX_FLAGS_BIRMASK;
  373. phys_addr = pci_resource_start(dev, bir) + table_offset;
  374. return ioremap_nocache(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
  375. }
  376. static int msix_setup_entries(struct pci_dev *dev, unsigned pos,
  377. void __iomem *base, struct msix_entry *entries,
  378. int nvec)
  379. {
  380. struct msi_desc *entry;
  381. int i;
  382. for (i = 0; i < nvec; i++) {
  383. entry = alloc_msi_entry(dev);
  384. if (!entry) {
  385. if (!i)
  386. iounmap(base);
  387. else
  388. free_msi_irqs(dev);
  389. /* No enough memory. Don't try again */
  390. return -ENOMEM;
  391. }
  392. entry->msi_attrib.is_msix = 1;
  393. entry->msi_attrib.is_64 = 1;
  394. entry->msi_attrib.entry_nr = entries[i].entry;
  395. entry->msi_attrib.default_irq = dev->irq;
  396. entry->msi_attrib.pos = pos;
  397. entry->mask_base = base;
  398. list_add_tail(&entry->list, &dev->msi_list);
  399. }
  400. return 0;
  401. }
  402. static void msix_program_entries(struct pci_dev *dev,
  403. struct msix_entry *entries)
  404. {
  405. struct msi_desc *entry;
  406. int i = 0;
  407. list_for_each_entry(entry, &dev->msi_list, list) {
  408. int offset = entries[i].entry * PCI_MSIX_ENTRY_SIZE +
  409. PCI_MSIX_ENTRY_VECTOR_CTRL;
  410. entries[i].vector = entry->irq;
  411. set_irq_msi(entry->irq, entry);
  412. entry->masked = readl(entry->mask_base + offset);
  413. msix_mask_irq(entry, 1);
  414. i++;
  415. }
  416. }
  417. /**
  418. * msix_capability_init - configure device's MSI-X capability
  419. * @dev: pointer to the pci_dev data structure of MSI-X device function
  420. * @entries: pointer to an array of struct msix_entry entries
  421. * @nvec: number of @entries
  422. *
  423. * Setup the MSI-X capability structure of device function with a
  424. * single MSI-X irq. A return of zero indicates the successful setup of
  425. * requested MSI-X entries with allocated irqs or non-zero for otherwise.
  426. **/
  427. static int msix_capability_init(struct pci_dev *dev,
  428. struct msix_entry *entries, int nvec)
  429. {
  430. int pos, ret;
  431. u16 control;
  432. void __iomem *base;
  433. pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
  434. pci_read_config_word(dev, pos + PCI_MSIX_FLAGS, &control);
  435. /* Ensure MSI-X is disabled while it is set up */
  436. control &= ~PCI_MSIX_FLAGS_ENABLE;
  437. pci_write_config_word(dev, pos + PCI_MSIX_FLAGS, control);
  438. /* Request & Map MSI-X table region */
  439. base = msix_map_region(dev, pos, multi_msix_capable(control));
  440. if (!base)
  441. return -ENOMEM;
  442. ret = msix_setup_entries(dev, pos, base, entries, nvec);
  443. if (ret)
  444. return ret;
  445. ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
  446. if (ret)
  447. goto error;
  448. /*
  449. * Some devices require MSI-X to be enabled before we can touch the
  450. * MSI-X registers. We need to mask all the vectors to prevent
  451. * interrupts coming in before they're fully set up.
  452. */
  453. control |= PCI_MSIX_FLAGS_MASKALL | PCI_MSIX_FLAGS_ENABLE;
  454. pci_write_config_word(dev, pos + PCI_MSIX_FLAGS, control);
  455. msix_program_entries(dev, entries);
  456. /* Set MSI-X enabled bits and unmask the function */
  457. pci_intx_for_msi(dev, 0);
  458. dev->msix_enabled = 1;
  459. control &= ~PCI_MSIX_FLAGS_MASKALL;
  460. pci_write_config_word(dev, pos + PCI_MSIX_FLAGS, control);
  461. return 0;
  462. error:
  463. if (ret < 0) {
  464. /*
  465. * If we had some success, report the number of irqs
  466. * we succeeded in setting up.
  467. */
  468. struct msi_desc *entry;
  469. int avail = 0;
  470. list_for_each_entry(entry, &dev->msi_list, list) {
  471. if (entry->irq != 0)
  472. avail++;
  473. }
  474. if (avail != 0)
  475. ret = avail;
  476. }
  477. free_msi_irqs(dev);
  478. return ret;
  479. }
  480. /**
  481. * pci_msi_check_device - check whether MSI may be enabled on a device
  482. * @dev: pointer to the pci_dev data structure of MSI device function
  483. * @nvec: how many MSIs have been requested ?
  484. * @type: are we checking for MSI or MSI-X ?
  485. *
  486. * Look at global flags, the device itself, and its parent busses
  487. * to determine if MSI/-X are supported for the device. If MSI/-X is
  488. * supported return 0, else return an error code.
  489. **/
  490. static int pci_msi_check_device(struct pci_dev *dev, int nvec, int type)
  491. {
  492. struct pci_bus *bus;
  493. int ret;
  494. /* MSI must be globally enabled and supported by the device */
  495. if (!pci_msi_enable || !dev || dev->no_msi)
  496. return -EINVAL;
  497. /*
  498. * You can't ask to have 0 or less MSIs configured.
  499. * a) it's stupid ..
  500. * b) the list manipulation code assumes nvec >= 1.
  501. */
  502. if (nvec < 1)
  503. return -ERANGE;
  504. /*
  505. * Any bridge which does NOT route MSI transactions from its
  506. * secondary bus to its primary bus must set NO_MSI flag on
  507. * the secondary pci_bus.
  508. * We expect only arch-specific PCI host bus controller driver
  509. * or quirks for specific PCI bridges to be setting NO_MSI.
  510. */
  511. for (bus = dev->bus; bus; bus = bus->parent)
  512. if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
  513. return -EINVAL;
  514. ret = arch_msi_check_device(dev, nvec, type);
  515. if (ret)
  516. return ret;
  517. if (!pci_find_capability(dev, type))
  518. return -EINVAL;
  519. return 0;
  520. }
  521. /**
  522. * pci_enable_msi_block - configure device's MSI capability structure
  523. * @dev: device to configure
  524. * @nvec: number of interrupts to configure
  525. *
  526. * Allocate IRQs for a device with the MSI capability.
  527. * This function returns a negative errno if an error occurs. If it
  528. * is unable to allocate the number of interrupts requested, it returns
  529. * the number of interrupts it might be able to allocate. If it successfully
  530. * allocates at least the number of interrupts requested, it returns 0 and
  531. * updates the @dev's irq member to the lowest new interrupt number; the
  532. * other interrupt numbers allocated to this device are consecutive.
  533. */
  534. int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
  535. {
  536. int status, pos, maxvec;
  537. u16 msgctl;
  538. pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
  539. if (!pos)
  540. return -EINVAL;
  541. pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &msgctl);
  542. maxvec = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
  543. if (nvec > maxvec)
  544. return maxvec;
  545. status = pci_msi_check_device(dev, nvec, PCI_CAP_ID_MSI);
  546. if (status)
  547. return status;
  548. WARN_ON(!!dev->msi_enabled);
  549. /* Check whether driver already requested MSI-X irqs */
  550. if (dev->msix_enabled) {
  551. dev_info(&dev->dev, "can't enable MSI "
  552. "(MSI-X already enabled)\n");
  553. return -EINVAL;
  554. }
  555. status = msi_capability_init(dev, nvec);
  556. return status;
  557. }
  558. EXPORT_SYMBOL(pci_enable_msi_block);
  559. void pci_msi_shutdown(struct pci_dev *dev)
  560. {
  561. struct msi_desc *desc;
  562. u32 mask;
  563. u16 ctrl;
  564. unsigned pos;
  565. if (!pci_msi_enable || !dev || !dev->msi_enabled)
  566. return;
  567. BUG_ON(list_empty(&dev->msi_list));
  568. desc = list_first_entry(&dev->msi_list, struct msi_desc, list);
  569. pos = desc->msi_attrib.pos;
  570. msi_set_enable(dev, pos, 0);
  571. pci_intx_for_msi(dev, 1);
  572. dev->msi_enabled = 0;
  573. /* Return the device with MSI unmasked as initial states */
  574. pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &ctrl);
  575. mask = msi_capable_mask(ctrl);
  576. /* Keep cached state to be restored */
  577. __msi_mask_irq(desc, mask, ~mask);
  578. /* Restore dev->irq to its default pin-assertion irq */
  579. dev->irq = desc->msi_attrib.default_irq;
  580. }
  581. void pci_disable_msi(struct pci_dev *dev)
  582. {
  583. if (!pci_msi_enable || !dev || !dev->msi_enabled)
  584. return;
  585. pci_msi_shutdown(dev);
  586. free_msi_irqs(dev);
  587. }
  588. EXPORT_SYMBOL(pci_disable_msi);
  589. /**
  590. * pci_msix_table_size - return the number of device's MSI-X table entries
  591. * @dev: pointer to the pci_dev data structure of MSI-X device function
  592. */
  593. int pci_msix_table_size(struct pci_dev *dev)
  594. {
  595. int pos;
  596. u16 control;
  597. pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
  598. if (!pos)
  599. return 0;
  600. pci_read_config_word(dev, msi_control_reg(pos), &control);
  601. return multi_msix_capable(control);
  602. }
  603. /**
  604. * pci_enable_msix - configure device's MSI-X capability structure
  605. * @dev: pointer to the pci_dev data structure of MSI-X device function
  606. * @entries: pointer to an array of MSI-X entries
  607. * @nvec: number of MSI-X irqs requested for allocation by device driver
  608. *
  609. * Setup the MSI-X capability structure of device function with the number
  610. * of requested irqs upon its software driver call to request for
  611. * MSI-X mode enabled on its hardware device function. A return of zero
  612. * indicates the successful configuration of MSI-X capability structure
  613. * with new allocated MSI-X irqs. A return of < 0 indicates a failure.
  614. * Or a return of > 0 indicates that driver request is exceeding the number
  615. * of irqs or MSI-X vectors available. Driver should use the returned value to
  616. * re-send its request.
  617. **/
  618. int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec)
  619. {
  620. int status, nr_entries;
  621. int i, j;
  622. if (!entries)
  623. return -EINVAL;
  624. status = pci_msi_check_device(dev, nvec, PCI_CAP_ID_MSIX);
  625. if (status)
  626. return status;
  627. nr_entries = pci_msix_table_size(dev);
  628. if (nvec > nr_entries)
  629. return nr_entries;
  630. /* Check for any invalid entries */
  631. for (i = 0; i < nvec; i++) {
  632. if (entries[i].entry >= nr_entries)
  633. return -EINVAL; /* invalid entry */
  634. for (j = i + 1; j < nvec; j++) {
  635. if (entries[i].entry == entries[j].entry)
  636. return -EINVAL; /* duplicate entry */
  637. }
  638. }
  639. WARN_ON(!!dev->msix_enabled);
  640. /* Check whether driver already requested for MSI irq */
  641. if (dev->msi_enabled) {
  642. dev_info(&dev->dev, "can't enable MSI-X "
  643. "(MSI IRQ already assigned)\n");
  644. return -EINVAL;
  645. }
  646. status = msix_capability_init(dev, entries, nvec);
  647. return status;
  648. }
  649. EXPORT_SYMBOL(pci_enable_msix);
  650. void pci_msix_shutdown(struct pci_dev *dev)
  651. {
  652. struct msi_desc *entry;
  653. if (!pci_msi_enable || !dev || !dev->msix_enabled)
  654. return;
  655. /* Return the device with MSI-X masked as initial states */
  656. list_for_each_entry(entry, &dev->msi_list, list) {
  657. /* Keep cached states to be restored */
  658. __msix_mask_irq(entry, 1);
  659. }
  660. msix_set_enable(dev, 0);
  661. pci_intx_for_msi(dev, 1);
  662. dev->msix_enabled = 0;
  663. }
  664. void pci_disable_msix(struct pci_dev *dev)
  665. {
  666. if (!pci_msi_enable || !dev || !dev->msix_enabled)
  667. return;
  668. pci_msix_shutdown(dev);
  669. free_msi_irqs(dev);
  670. }
  671. EXPORT_SYMBOL(pci_disable_msix);
  672. /**
  673. * msi_remove_pci_irq_vectors - reclaim MSI(X) irqs to unused state
  674. * @dev: pointer to the pci_dev data structure of MSI(X) device function
  675. *
  676. * Being called during hotplug remove, from which the device function
  677. * is hot-removed. All previous assigned MSI/MSI-X irqs, if
  678. * allocated for this device function, are reclaimed to unused state,
  679. * which may be used later on.
  680. **/
  681. void msi_remove_pci_irq_vectors(struct pci_dev *dev)
  682. {
  683. if (!pci_msi_enable || !dev)
  684. return;
  685. if (dev->msi_enabled || dev->msix_enabled)
  686. free_msi_irqs(dev);
  687. }
  688. void pci_no_msi(void)
  689. {
  690. pci_msi_enable = 0;
  691. }
  692. /**
  693. * pci_msi_enabled - is MSI enabled?
  694. *
  695. * Returns true if MSI has not been disabled by the command-line option
  696. * pci=nomsi.
  697. **/
  698. int pci_msi_enabled(void)
  699. {
  700. return pci_msi_enable;
  701. }
  702. EXPORT_SYMBOL(pci_msi_enabled);
  703. void pci_msi_init_pci_dev(struct pci_dev *dev)
  704. {
  705. INIT_LIST_HEAD(&dev->msi_list);
  706. }