blob: 8103f32f6d87f39af2e494ee4948b98188150936 [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
Satoru Takeuchic54c1872007-01-18 13:50:05 +090013/* Helper functions */
Thomas Gleixner1c9db522010-09-28 16:46:51 +020014struct irq_data;
Thomas Gleixner39431ac2010-09-28 19:09:51 +020015struct msi_desc;
Bjorn Helgaas2366d062013-04-18 10:55:46 -060016void mask_msi_irq(struct irq_data *data);
17void unmask_msi_irq(struct irq_data *data);
18void __read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
19void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
20void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
21void read_msi_msg(unsigned int irq, struct msi_msg *msg);
22void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
23void write_msi_msg(unsigned int irq, struct msi_msg *msg);
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 */
32 __u8 pos; /* Location of the msi capability */
33 __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;
Neil Hormanb50cac52011-10-06 14:08:18 -040050
51 struct kobject kobj;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070052};
53
54/*
Thomas Petazzoni4287d822013-08-09 22:27:06 +020055 * The arch hooks to setup up msi irqs. Those functions are
56 * implemented as weak symbols so that they /can/ be overriden by
57 * architecture specific code if needed.
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070058 */
Eric W. Biedermanf7feaca2007-01-28 12:56:37 -070059int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070060void arch_teardown_msi_irq(unsigned int irq);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060061int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
62void arch_teardown_msi_irqs(struct pci_dev *dev);
63int arch_msi_check_device(struct pci_dev* dev, int nvec, int type);
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);
Konrad Rzeszutek Wilk0e4ccb12013-11-06 16:16:56 -050068u32 default_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
69u32 default_msix_mask_irq(struct msi_desc *desc, u32 flag);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070070
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020071struct msi_chip {
72 struct module *owner;
73 struct device *dev;
Thomas Petazzoni0d5a6db2013-08-09 22:27:09 +020074 struct device_node *of_node;
75 struct list_head list;
Thierry Reding0cbdcfc2013-08-09 22:27:08 +020076
77 int (*setup_irq)(struct msi_chip *chip, struct pci_dev *dev,
78 struct msi_desc *desc);
79 void (*teardown_irq)(struct msi_chip *chip, unsigned int irq);
80 int (*check_device)(struct msi_chip *chip, struct pci_dev *dev,
81 int nvec, int type);
82};
83
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070084#endif /* LINUX_MSI_H */