LXR linux/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
   7struct 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 */
  14struct irq_data;
  15struct msi_desc;
  16void 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);
  24
  25struct 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/*
  52 * The arch hooks to setup up msi irqs. Those functions are
  53 * implemented as weak symbols so that they /can/ be overriden by
  54 * architecture specific code if needed.
  55 */
  56int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
  57void arch_teardown_msi_irq(unsigned int irq);
  58int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
  59void arch_teardown_msi_irqs(struct pci_dev *dev);
  60void arch_restore_msi_irqs(struct pci_dev *dev);
  61
  62void default_teardown_msi_irqs(struct pci_dev *dev);
  63void default_restore_msi_irqs(struct pci_dev *dev);
  64u32 default_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
  65u32 default_msix_mask_irq(struct msi_desc *desc, u32 flag);
  66
  67struct msi_chip {
  68        struct module *owner;
  69        struct device *dev;
  70        struct device_node *of_node;
  71        struct list_head list;
  72
  73        int (*setup_irq)(struct msi_chip *chip, struct pci_dev *dev,
  74                         struct msi_desc *desc);
  75        void (*teardown_irq)(struct msi_chip *chip, unsigned int irq);
  76};
  77
  78#endif /* LINUX_MSI_H */
  79