blob: 1dcad0c1e80692df26713221eb81b74913f42967 [file] [log] [blame]
Eric W. Biederman3b7d1922006-10-04 02:16:59 -07001#ifndef LINUX_MSI_H
2#define LINUX_MSI_H
3
Neil Hormanb50cac52011-10-06 14:08:18 -04004#include <linux/kobject.h>
Michael Ellerman4aa9bc92007-04-05 17:19:10 +10005#include <linux/list.h>
6
Eric W. Biederman3b7d1922006-10-04 02:16:59 -07007struct msi_msg {
8 u32 address_lo; /* low 32 bits of msi message address */
9 u32 address_hi; /* high 32 bits of msi message address */
10 u32 data; /* 16 bits of msi message data */
11};
12
Yijing Wang38737d82014-10-27 10:44:36 +080013extern int pci_msi_ignore_mask;
Satoru Takeuchic54c1872007-01-18 13:50:05 +090014/* Helper functions */
Thomas Gleixner1c9db522010-09-28 16:46:51 +020015struct irq_data;
Thomas Gleixner39431ac2010-09-28 19:09:51 +020016struct msi_desc;
Bjorn Helgaas2366d062013-04-18 10:55:46 -060017void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060018void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
Jiang Liu891d4a42014-11-09 23:10:33 +080019
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070020struct msi_desc {
21 struct {
Matthew Wilcox24d275532009-03-17 08:54:06 -040022 __u8 is_msix : 1;
Yijing Wang31ea5d42014-06-19 16:30:30 +080023 __u8 multiple: 3; /* log2 num of messages allocated */
24 __u8 multi_cap : 3; /* log2 num of messages supported */
Bjorn Helgaasf7625982013-11-14 11:28:18 -070025 __u8 maskbit : 1; /* mask-pending bit supported ? */
26 __u8 is_64 : 1; /* Address size: 0=32bit 1=64bit */
Bjorn Helgaasf7625982013-11-14 11:28:18 -070027 __u16 entry_nr; /* specific enabled entry */
28 unsigned default_irq; /* default pre-assigned irq */
Matthew Wilcoxf2440d92009-03-17 08:54:09 -040029 } msi_attrib;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070030
Matthew Wilcoxf2440d92009-03-17 08:54:09 -040031 u32 masked; /* mask bits */
Michael Ellerman4aa9bc92007-04-05 17:19:10 +100032 unsigned int irq;
Alexander Gordeev65f6ae62013-05-13 11:05:48 +020033 unsigned int nvec_used; /* number of messages */
Michael Ellerman4aa9bc92007-04-05 17:19:10 +100034 struct list_head list;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070035
Matthew Wilcox264d9ca2009-03-17 08:54:08 -040036 union {
37 void __iomem *mask_base;
38 u8 mask_pos;
39 };
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070040 struct pci_dev *dev;
41
Eric W. Biederman392ee1e2007-03-08 13:04:57 -070042 /* Last set MSI message */
43 struct msi_msg msg;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070044};
45
Jiang Liu891d4a42014-11-09 23:10:33 +080046void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
Jiang Liu83a18912014-11-09 23:10:34 +080047void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
48void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
49
Thomas Gleixner23ed8d52014-11-23 11:55:58 +010050u32 __pci_msix_desc_mask_irq(struct msi_desc *desc, u32 flag);
51u32 __pci_msi_desc_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
52void pci_msi_mask_irq(struct irq_data *data);
53void pci_msi_unmask_irq(struct irq_data *data);
54
Jiang Liu83a18912014-11-09 23:10:34 +080055/* Conversion helpers. Should be removed after merging */
56static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
57{
58 __pci_write_msi_msg(entry, msg);
59}
60static inline void write_msi_msg(int irq, struct msi_msg *msg)
61{
62 pci_write_msi_msg(irq, msg);
63}
Thomas Gleixner23ed8d52014-11-23 11:55:58 +010064static inline void mask_msi_irq(struct irq_data *data)
65{
66 pci_msi_mask_irq(data);
67}
68static inline void unmask_msi_irq(struct irq_data *data)
69{
70 pci_msi_unmask_irq(data);
71}
Jiang Liu891d4a42014-11-09 23:10:33 +080072
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070073/*
Thomas Petazzoni4287d822013-08-09 22:27:06 +020074 * The arch hooks to setup up msi irqs. Those functions are
75 * implemented as weak symbols so that they /can/ be overriden by
76 * architecture specific code if needed.
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070077 */
Eric W. Biedermanf7feaca2007-01-28 12:56:37 -070078int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070079void arch_teardown_msi_irq(unsigned int irq);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060080int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
81void arch_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +080082void arch_restore_msi_irqs(struct pci_dev *dev);
Thomas Petazzoni4287d822013-08-09 22:27:06 +020083
84void default_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +080085void default_restore_msi_irqs(struct pci_dev *dev);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070086
Yijing Wangc2791b82014-11-11 17:45:45 -070087struct msi_controller {
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020088 struct module *owner;
89 struct device *dev;
Thomas Petazzoni0d5a6db2013-08-09 22:27:09 +020090 struct device_node *of_node;
91 struct list_head list;
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020092
Yijing Wangc2791b82014-11-11 17:45:45 -070093 int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020094 struct msi_desc *desc);
Yijing Wangc2791b82014-11-11 17:45:45 -070095 void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020096};
97
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070098#endif /* LINUX_MSI_H */