include/linux/msi.h

   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 extern int pci_msi_ignore_mask;
  14 /* Helper functions */
  15 struct irq_data;
  16 struct msi_desc;
  17 void mask_msi_irq(struct irq_data *data);
  18 void unmask_msi_irq(struct irq_data *data);
  19 void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
  20 void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
  21
  22 u32 __msix_mask_irq(struct msi_desc *desc, u32 flag);
  23 u32 __msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
  24
  25 struct msi_desc {
  26         struct {
  27                 __u8    is_msix : 1;
  28                 __u8    multiple: 3;    /* log2 num of messages allocated */
  29                 __u8    multi_cap : 3;  /* log2 num of messages supported */
  30                 __u8    maskbit : 1;    /* mask-pending bit supported ? */
  31                 __u8    is_64   : 1;    /* Address size: 0=32bit 1=64bit */
  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
  51 void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
  52 void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
  53 void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
  54
  55 /* Conversion helpers. Should be removed after merging */
  56 static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
  57 {
  58         __pci_write_msi_msg(entry, msg);
  59 }
  60 static inline void write_msi_msg(int irq, struct msi_msg *msg)
  61 {
  62         pci_write_msi_msg(irq, msg);
  63 }
  64
  65 /*
  66  * 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.
  69  */
  70 int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
  71 void arch_teardown_msi_irq(unsigned int irq);
  72 int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
  73 void arch_teardown_msi_irqs(struct pci_dev *dev);
  74 void arch_restore_msi_irqs(struct pci_dev *dev);
  75
  76 void default_teardown_msi_irqs(struct pci_dev *dev);
  77 void default_restore_msi_irqs(struct pci_dev *dev);
  78
  79 struct msi_controller {
  80         struct module *owner;
  81         struct device *dev;
  82         struct device_node *of_node;
  83         struct list_head list;
  84
  85         int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
  86                          struct msi_desc *desc);
  87         void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
  88 };
  89
  90 #endif /* LINUX_MSI_H */