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                __u8    pos;            /* Location of the msi capability */
  33                __u16   entry_nr;       /* specific enabled entry */
  34                unsigned default_irq;   /* default pre-assigned irq */
  35        } msi_attrib;
  36
  37        u32 masked;                     /* mask bits */
  38        unsigned int irq;
  39        unsigned int nvec_used;         /* number of messages */
  40        struct list_head list;
  41
  42        union {
  43                void __iomem *mask_base;
  44                u8 mask_pos;
  45        };
  46        struct pci_dev *dev;
  47
  48        /* Last set MSI message */
  49        struct msi_msg msg;
  50
  51        struct kobject kobj;
  52};
  53
  54/*
  55 * 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.
  58 */
  59int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
  60void arch_teardown_msi_irq(unsigned int irq);
  61int 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);
  64void arch_restore_msi_irqs(struct pci_dev *dev);
  65
  66void default_teardown_msi_irqs(struct pci_dev *dev);
  67void default_restore_msi_irqs(struct pci_dev *dev);
  68u32 default_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
  69u32 default_msix_mask_irq(struct msi_desc *desc, u32 flag);
  70
  71struct msi_chip {
  72        struct module *owner;
  73        struct device *dev;
  74        struct device_node *of_node;
  75        struct list_head list;
  76
  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
  84#endif /* LINUX_MSI_H */
  85