xref: /linux-6.15/include/linux/msi.h (revision bb66fc67)
1 #ifndef LINUX_MSI_H
2 #define LINUX_MSI_H
3 
4 #include <linux/kobject.h>
5 #include <linux/list.h>
6 
7 struct 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 
13 /* Helper functions */
14 struct irq_data;
15 struct msi_desc;
16 void mask_msi_irq(struct irq_data *data);
17 void unmask_msi_irq(struct irq_data *data);
18 void __read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
19 void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
20 void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
21 void read_msi_msg(unsigned int irq, struct msi_msg *msg);
22 void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
23 void write_msi_msg(unsigned int irq, struct msi_msg *msg);
24 
25 struct msi_desc {
26 	struct {
27 		__u8	is_msix	: 1;
28 		__u8	multiple: 3;	/* log2 number of messages */
29 		__u8	maskbit	: 1;	/* mask-pending bit supported ? */
30 		__u8	is_64	: 1;	/* Address size: 0=32bit 1=64bit */
31 		__u8	pos;		/* Location of the msi capability */
32 		__u16	entry_nr;	/* specific enabled entry */
33 		unsigned default_irq;	/* default pre-assigned irq */
34 	} msi_attrib;
35 
36 	u32 masked;			/* mask bits */
37 	unsigned int irq;
38 	unsigned int nvec_used;		/* number of messages */
39 	struct list_head list;
40 
41 	union {
42 		void __iomem *mask_base;
43 		u8 mask_pos;
44 	};
45 	struct pci_dev *dev;
46 
47 	/* Last set MSI message */
48 	struct msi_msg msg;
49 
50 	struct kobject kobj;
51 };
52 
53 /*
54  * The arch hooks to setup up msi irqs. Those functions are
55  * implemented as weak symbols so that they /can/ be overriden by
56  * architecture specific code if needed.
57  */
58 int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
59 void arch_teardown_msi_irq(unsigned int irq);
60 int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
61 void arch_teardown_msi_irqs(struct pci_dev *dev);
62 int arch_msi_check_device(struct pci_dev* dev, int nvec, int type);
63 void arch_restore_msi_irqs(struct pci_dev *dev);
64 
65 void default_teardown_msi_irqs(struct pci_dev *dev);
66 void default_restore_msi_irqs(struct pci_dev *dev);
67 u32 default_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
68 u32 default_msix_mask_irq(struct msi_desc *desc, u32 flag);
69 
70 struct msi_chip {
71 	struct module *owner;
72 	struct device *dev;
73 	struct device_node *of_node;
74 	struct list_head list;
75 
76 	int (*setup_irq)(struct msi_chip *chip, struct pci_dev *dev,
77 			 struct msi_desc *desc);
78 	void (*teardown_irq)(struct msi_chip *chip, unsigned int irq);
79 	int (*check_device)(struct msi_chip *chip, struct pci_dev *dev,
80 			    int nvec, int type);
81 };
82 
83 #endif /* LINUX_MSI_H */
84