blob: 301adecbc34d66b96f0ea790dec1941cb368d14e [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);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060020void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
Jiang Liu891d4a42014-11-09 23:10:33 +080021
Yijing Wang03f56e42014-10-27 10:44:37 +080022u32 __msix_mask_irq(struct msi_desc *desc, u32 flag);
23u32 __msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070024
25struct msi_desc {
26 struct {
Matthew Wilcox24d27552009-03-17 08:54:06 -040027 __u8 is_msix : 1;
Yijing Wang31ea5d42014-06-19 16:30:30 +080028 __u8 multiple: 3; /* log2 num of messages allocated */
29 __u8 multi_cap : 3; /* log2 num of messages supported */
Bjorn Helgaasf7625982013-11-14 11:28:18 -070030 __u8 maskbit : 1; /* mask-pending bit supported ? */
31 __u8 is_64 : 1; /* Address size: 0=32bit 1=64bit */
Bjorn Helgaasf7625982013-11-14 11:28:18 -070032 __u16 entry_nr; /* specific enabled entry */
33 unsigned default_irq; /* default pre-assigned irq */
Matthew Wilcoxf2440d92009-03-17 08:54:09 -040034 } msi_attrib;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070035
Matthew Wilcoxf2440d92009-03-17 08:54:09 -040036 u32 masked; /* mask bits */
Michael Ellerman4aa9bc92007-04-05 17:19:10 +100037 unsigned int irq;
Alexander Gordeev65f6ae62013-05-13 11:05:48 +020038 unsigned int nvec_used; /* number of messages */
Michael Ellerman4aa9bc92007-04-05 17:19:10 +100039 struct list_head list;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070040
Matthew Wilcox264d9ca2009-03-17 08:54:08 -040041 union {
42 void __iomem *mask_base;
43 u8 mask_pos;
44 };
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070045 struct pci_dev *dev;
46
Eric W. Biederman392ee1e2007-03-08 13:04:57 -070047 /* Last set MSI message */
48 struct msi_msg msg;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070049};
50
Jiang Liu891d4a42014-11-09 23:10:33 +080051void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
Jiang Liu83a18912014-11-09 23:10:34 +080052void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
53void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
54
55/* 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}
Jiang Liu891d4a42014-11-09 23:10:33 +080064
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070065/*
Thomas Petazzoni4287d822013-08-09 22:27:06 +020066 * The arch hooks to setup up msi irqs. Those functions are
67 * implemented as weak symbols so that they /can/ be overriden by
68 * architecture specific code if needed.
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070069 */
Eric W. Biedermanf7feaca2007-01-28 12:56:37 -070070int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070071void arch_teardown_msi_irq(unsigned int irq);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060072int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
73void arch_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +080074void arch_restore_msi_irqs(struct pci_dev *dev);
Thomas Petazzoni4287d822013-08-09 22:27:06 +020075
76void default_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +080077void default_restore_msi_irqs(struct pci_dev *dev);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070078
Yijing Wangc2791b82014-11-11 17:45:45 -070079struct msi_controller {
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020080 struct module *owner;
81 struct device *dev;
Thomas Petazzoni0d5a6db2013-08-09 22:27:09 +020082 struct device_node *of_node;
83 struct list_head list;
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020084
Yijing Wangc2791b82014-11-11 17:45:45 -070085 int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020086 struct msi_desc *desc);
Yijing Wangc2791b82014-11-11 17:45:45 -070087 void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020088};
89
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070090#endif /* LINUX_MSI_H */