[mirror_ubuntu-bionic-kernel.git] / include / linux / msi.h

#ifndef LINUX_MSI_H
#define LINUX_MSI_H

#include <linux/kobject.h>
#include <linux/list.h>

struct msi_msg {
	u32	address_lo;	/* low 32 bits of msi message address */
	u32	address_hi;	/* high 32 bits of msi message address */
	u32	data;		/* 16 bits of msi message data */
};

/* Helper functions */
struct irq_data;
struct msi_desc;
void mask_msi_irq(struct irq_data *data);
void unmask_msi_irq(struct irq_data *data);
void __read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
void read_msi_msg(unsigned int irq, struct msi_msg *msg);
void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
void write_msi_msg(unsigned int irq, struct msi_msg *msg);

struct msi_desc {
	struct {
		__u8	is_msix	: 1;
		__u8	multiple: 3;	/* log2 number of messages */
		__u8	maskbit	: 1; 	/* mask-pending bit supported ?   */
		__u8	is_64	: 1;	/* Address size: 0=32bit 1=64bit  */
		__u8	pos;	 	/* Location of the msi capability */
		__u16	entry_nr;    	/* specific enabled entry 	  */
		unsigned default_irq;	/* default pre-assigned irq	  */
	} msi_attrib;

	u32 masked;			/* mask bits */
	unsigned int irq;
	unsigned int nvec_used;		/* number of messages */
	struct list_head list;

	union {
		void __iomem *mask_base;
		u8 mask_pos;
	};
	struct pci_dev *dev;

	/* Last set MSI message */
	struct msi_msg msg;

	struct kobject kobj;
};

/*
 * The arch hooks to setup up msi irqs. Those functions are
 * implemented as weak symbols so that they /can/ be overriden by
 * architecture specific code if needed.
 */
int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
void arch_teardown_msi_irq(unsigned int irq);
int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
void arch_teardown_msi_irqs(struct pci_dev *dev);
int arch_msi_check_device(struct pci_dev* dev, int nvec, int type);
void arch_restore_msi_irqs(struct pci_dev *dev, int irq);

void default_teardown_msi_irqs(struct pci_dev *dev);
void default_restore_msi_irqs(struct pci_dev *dev, int irq);
u32 default_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
u32 default_msix_mask_irq(struct msi_desc *desc, u32 flag);

struct msi_chip {
	struct module *owner;
	struct device *dev;
	struct device_node *of_node;
	struct list_head list;

	int (*setup_irq)(struct msi_chip *chip, struct pci_dev *dev,
			 struct msi_desc *desc);
	void (*teardown_irq)(struct msi_chip *chip, unsigned int irq);
	int (*check_device)(struct msi_chip *chip, struct pci_dev *dev,
			    int nvec, int type);
};

#endif /* LINUX_MSI_H */
Commit	Line	Data
3b7d1921 EB	1	#ifndef LINUX_MSI_H
	2	#define LINUX_MSI_H
	3
b50cac55	4	#include <linux/kobject.h>
4aa9bc95 ME	5	#include <linux/list.h>
4aa9bc95 ME	6
3b7d1921 EB	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
c54c1879	13	/* Helper functions */
1c9db525	14	struct irq_data;
39431acb	15	struct msi_desc;
2366d06e BH	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);
3b7d1921 EB	24
	25	struct msi_desc {
	26	struct {
24d27553	27	__u8 is_msix : 1;
1c8d7b0a	28	__u8 multiple: 3; /* log2 number of messages */
3b7d1921	29	__u8 maskbit : 1; /* mask-pending bit supported ? */
3b7d1921 EB	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 */
f2440d9a	34	} msi_attrib;
3b7d1921	35
f2440d9a	36	u32 masked; /* mask bits */
4aa9bc95	37	unsigned int irq;
65f6ae66	38	unsigned int nvec_used; /* number of messages */
4aa9bc95	39	struct list_head list;
3b7d1921	40
264d9caa MW	41	union {
	42	void __iomem *mask_base;
	43	u8 mask_pos;
	44	};
3b7d1921 EB	45	struct pci_dev *dev;
3b7d1921 EB	46
392ee1e6 EB	47	/* Last set MSI message */
392ee1e6 EB	48	struct msi_msg msg;
b50cac55 NH	49
b50cac55 NH	50	struct kobject kobj;
3b7d1921 EB	51	};
	52
	53	/*
4287d824 TP	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.
3b7d1921	57	*/
f7feaca7	58	int arch_setup_msi_irq(struct pci_dev dev, struct msi_desc desc);
3b7d1921	59	void arch_teardown_msi_irq(unsigned int irq);
2366d06e BH	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);
4287d824 TP	63	void arch_restore_msi_irqs(struct pci_dev *dev, int irq);
	64
	65	void default_teardown_msi_irqs(struct pci_dev *dev);
	66	void default_restore_msi_irqs(struct pci_dev *dev, int irq);
0e4ccb15 KRW	67	u32 default_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
0e4ccb15 KRW	68	u32 default_msix_mask_irq(struct msi_desc *desc, u32 flag);
3b7d1921	69
0cbdcfcf TR	70	struct msi_chip {
	71	struct module *owner;
	72	struct device *dev;
0d5a6db3 TP	73	struct device_node *of_node;
0d5a6db3 TP	74	struct list_head list;
0cbdcfcf TR	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
3b7d1921	83	#endif /* LINUX_MSI_H */