blob: 86dc501a15345846db405ef4470b5194637cedca [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 mask_msi_irq(struct irq_data *data);
18void unmask_msi_irq(struct irq_data *data);
19void __read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
20void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
21void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
22void read_msi_msg(unsigned int irq, struct msi_msg *msg);
23void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
24void write_msi_msg(unsigned int irq, struct msi_msg *msg);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070025
26struct msi_desc {
27 struct {
Matthew Wilcox24d275532009-03-17 08:54:06 -040028 __u8 is_msix : 1;
Yijing Wang31ea5d42014-06-19 16:30:30 +080029 __u8 multiple: 3; /* log2 num of messages allocated */
30 __u8 multi_cap : 3; /* log2 num of messages supported */
Bjorn Helgaasf7625982013-11-14 11:28:18 -070031 __u8 maskbit : 1; /* mask-pending bit supported ? */
32 __u8 is_64 : 1; /* Address size: 0=32bit 1=64bit */
Bjorn Helgaasf7625982013-11-14 11:28:18 -070033 __u16 entry_nr; /* specific enabled entry */
34 unsigned default_irq; /* default pre-assigned irq */
Matthew Wilcoxf2440d92009-03-17 08:54:09 -040035 } msi_attrib;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070036
Matthew Wilcoxf2440d92009-03-17 08:54:09 -040037 u32 masked; /* mask bits */
Michael Ellerman4aa9bc92007-04-05 17:19:10 +100038 unsigned int irq;
Alexander Gordeev65f6ae62013-05-13 11:05:48 +020039 unsigned int nvec_used; /* number of messages */
Michael Ellerman4aa9bc92007-04-05 17:19:10 +100040 struct list_head list;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070041
Matthew Wilcox264d9ca2009-03-17 08:54:08 -040042 union {
43 void __iomem *mask_base;
44 u8 mask_pos;
45 };
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070046 struct pci_dev *dev;
47
Eric W. Biederman392ee1e2007-03-08 13:04:57 -070048 /* Last set MSI message */
49 struct msi_msg msg;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070050};
51
52/*
Thomas Petazzoni4287d822013-08-09 22:27:06 +020053 * The arch hooks to setup up msi irqs. Those functions are
54 * implemented as weak symbols so that they /can/ be overriden by
55 * architecture specific code if needed.
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070056 */
Eric W. Biedermanf7feaca2007-01-28 12:56:37 -070057int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070058void arch_teardown_msi_irq(unsigned int irq);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060059int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
60void arch_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +080061void arch_restore_msi_irqs(struct pci_dev *dev);
Thomas Petazzoni4287d822013-08-09 22:27:06 +020062
63void default_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +080064void default_restore_msi_irqs(struct pci_dev *dev);
Konrad Rzeszutek Wilk0e4ccb12013-11-06 16:16:56 -050065u32 default_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
66u32 default_msix_mask_irq(struct msi_desc *desc, u32 flag);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070067
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020068struct msi_chip {
69 struct module *owner;
70 struct device *dev;
Thomas Petazzoni0d5a6db2013-08-09 22:27:09 +020071 struct device_node *of_node;
72 struct list_head list;
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020073
74 int (*setup_irq)(struct msi_chip *chip, struct pci_dev *dev,
75 struct msi_desc *desc);
76 void (*teardown_irq)(struct msi_chip *chip, unsigned int irq);
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020077};
78
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070079#endif /* LINUX_MSI_H */