blob: f36c37b46f100660f0887ef011c292c951b7ba95 [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);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060019void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
20void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060021void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
22void write_msi_msg(unsigned int irq, struct msi_msg *msg);
Jiang Liu891d4a42014-11-09 23:10:33 +080023
Yijing Wang03f56e42014-10-27 10:44:37 +080024u32 __msix_mask_irq(struct msi_desc *desc, u32 flag);
25u32 __msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070026
27struct msi_desc {
28 struct {
Matthew Wilcox24d27552009-03-17 08:54:06 -040029 __u8 is_msix : 1;
Yijing Wang31ea5d42014-06-19 16:30:30 +080030 __u8 multiple: 3; /* log2 num of messages allocated */
31 __u8 multi_cap : 3; /* log2 num of messages supported */
Bjorn Helgaasf7625982013-11-14 11:28:18 -070032 __u8 maskbit : 1; /* mask-pending bit supported ? */
33 __u8 is_64 : 1; /* Address size: 0=32bit 1=64bit */
Bjorn Helgaasf7625982013-11-14 11:28:18 -070034 __u16 entry_nr; /* specific enabled entry */
35 unsigned default_irq; /* default pre-assigned irq */
Matthew Wilcoxf2440d92009-03-17 08:54:09 -040036 } msi_attrib;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070037
Matthew Wilcoxf2440d92009-03-17 08:54:09 -040038 u32 masked; /* mask bits */
Michael Ellerman4aa9bc92007-04-05 17:19:10 +100039 unsigned int irq;
Alexander Gordeev65f6ae62013-05-13 11:05:48 +020040 unsigned int nvec_used; /* number of messages */
Michael Ellerman4aa9bc92007-04-05 17:19:10 +100041 struct list_head list;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070042
Matthew Wilcox264d9ca2009-03-17 08:54:08 -040043 union {
44 void __iomem *mask_base;
45 u8 mask_pos;
46 };
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070047 struct pci_dev *dev;
48
Eric W. Biederman392ee1e2007-03-08 13:04:57 -070049 /* Last set MSI message */
50 struct msi_msg msg;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070051};
52
Jiang Liu891d4a42014-11-09 23:10:33 +080053void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
54
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070055/*
Thomas Petazzoni4287d822013-08-09 22:27:06 +020056 * The arch hooks to setup up msi irqs. Those functions are
57 * implemented as weak symbols so that they /can/ be overriden by
58 * architecture specific code if needed.
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070059 */
Eric W. Biedermanf7feaca2007-01-28 12:56:37 -070060int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070061void arch_teardown_msi_irq(unsigned int irq);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060062int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
63void arch_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +080064void arch_restore_msi_irqs(struct pci_dev *dev);
Thomas Petazzoni4287d822013-08-09 22:27:06 +020065
66void default_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +080067void default_restore_msi_irqs(struct pci_dev *dev);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070068
Yijing Wangc2791b82014-11-11 17:45:45 -070069struct msi_controller {
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020070 struct module *owner;
71 struct device *dev;
Thomas Petazzoni0d5a6db2013-08-09 22:27:09 +020072 struct device_node *of_node;
73 struct list_head list;
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020074
Yijing Wangc2791b82014-11-11 17:45:45 -070075 int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020076 struct msi_desc *desc);
Yijing Wangc2791b82014-11-11 17:45:45 -070077 void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020078};
79
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070080#endif /* LINUX_MSI_H */