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 struct pci_dev;
  18 struct platform_msi_priv_data;
  19 void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
  20 #ifdef CONFIG_GENERIC_MSI_IRQ
  21 void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
  22 #else
  23 static inline void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg)
  24 {
  25 }
  26 #endif
  27
  28 typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
  29                                     struct msi_msg *msg);
  30
  31 /**
  32  * platform_msi_desc - Platform device specific msi descriptor data
  33  * @msi_priv_data:      Pointer to platform private data
  34  * @msi_index:          The index of the MSI descriptor for multi MSI
  35  */
  36 struct platform_msi_desc {
  37         struct platform_msi_priv_data   *msi_priv_data;
  38         u16                             msi_index;
  39 };
  40
  41 /**
  42  * struct msi_desc - Descriptor structure for MSI based interrupts
  43  * @list:       List head for management
  44  * @irq:        The base interrupt number
  45  * @nvec_used:  The number of vectors used
  46  * @dev:        Pointer to the device which uses this descriptor
  47  * @msg:        The last set MSI message cached for reuse
  48  *
  49  * @masked:     [PCI MSI/X] Mask bits
  50  * @is_msix:    [PCI MSI/X] True if MSI-X
  51  * @multiple:   [PCI MSI/X] log2 num of messages allocated
  52  * @multi_cap:  [PCI MSI/X] log2 num of messages supported
  53  * @maskbit:    [PCI MSI/X] Mask-Pending bit supported?
  54  * @is_64:      [PCI MSI/X] Address size: 0=32bit 1=64bit
  55  * @entry_nr:   [PCI MSI/X] Entry which is described by this descriptor
  56  * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
  57  * @mask_pos:   [PCI MSI]   Mask register position
  58  * @mask_base:  [PCI MSI-X] Mask register base address
  59  * @platform:   [platform]  Platform device specific msi descriptor data
  60  */
  61 struct msi_desc {
  62         /* Shared device/bus type independent data */
  63         struct list_head                list;
  64         unsigned int                    irq;
  65         unsigned int                    nvec_used;
  66         struct device                   *dev;
  67         struct msi_msg                  msg;
  68
  69         union {
  70                 /* PCI MSI/X specific data */
  71                 struct {
  72                         u32 masked;
  73                         struct {
  74                                 __u8    is_msix         : 1;
  75                                 __u8    multiple        : 3;
  76                                 __u8    multi_cap       : 3;
  77                                 __u8    maskbit         : 1;
  78                                 __u8    is_64           : 1;
  79                                 __u16   entry_nr;
  80                                 unsigned default_irq;
  81                         } msi_attrib;
  82                         union {
  83                                 u8      mask_pos;
  84                                 void __iomem *mask_base;
  85                         };
  86                 };
  87
  88                 /*
  89                  * Non PCI variants add their data structure here. New
  90                  * entries need to use a named structure. We want
  91                  * proper name spaces for this. The PCI part is
  92                  * anonymous for now as it would require an immediate
  93                  * tree wide cleanup.
  94                  */
  95                 struct platform_msi_desc platform;
  96         };
  97 };
  98
  99 /* Helpers to hide struct msi_desc implementation details */
 100 #define msi_desc_to_dev(desc)           ((desc)->dev)
 101 #define dev_to_msi_list(dev)            (&(dev)->msi_list)
 102 #define first_msi_entry(dev)            \
 103         list_first_entry(dev_to_msi_list((dev)), struct msi_desc, list)
 104 #define for_each_msi_entry(desc, dev)   \
 105         list_for_each_entry((desc), dev_to_msi_list((dev)), list)
 106
 107 #ifdef CONFIG_PCI_MSI
 108 #define first_pci_msi_entry(pdev)       first_msi_entry(&(pdev)->dev)
 109 #define for_each_pci_msi_entry(desc, pdev)      \
 110         for_each_msi_entry((desc), &(pdev)->dev)
 111
 112 struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc);
 113 void *msi_desc_to_pci_sysdata(struct msi_desc *desc);
 114 void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
 115 #else /* CONFIG_PCI_MSI */
 116 static inline void *msi_desc_to_pci_sysdata(struct msi_desc *desc)
 117 {
 118         return NULL;
 119 }
 120 static inline void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg)
 121 {
 122 }
 123 #endif /* CONFIG_PCI_MSI */
 124
 125 struct msi_desc *alloc_msi_entry(struct device *dev);
 126 void free_msi_entry(struct msi_desc *entry);
 127 void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
 128 void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
 129
 130 u32 __pci_msix_desc_mask_irq(struct msi_desc *desc, u32 flag);
 131 void __pci_msi_desc_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
 132 void pci_msi_mask_irq(struct irq_data *data);
 133 void pci_msi_unmask_irq(struct irq_data *data);
 134
 135 /* Conversion helpers. Should be removed after merging */
 136 static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 137 {
 138         __pci_write_msi_msg(entry, msg);
 139 }
 140 static inline void write_msi_msg(int irq, struct msi_msg *msg)
 141 {
 142         pci_write_msi_msg(irq, msg);
 143 }
 144 static inline void mask_msi_irq(struct irq_data *data)
 145 {
 146         pci_msi_mask_irq(data);
 147 }
 148 static inline void unmask_msi_irq(struct irq_data *data)
 149 {
 150         pci_msi_unmask_irq(data);
 151 }
 152
 153 /*
 154  * The arch hooks to setup up msi irqs. Those functions are
 155  * implemented as weak symbols so that they /can/ be overriden by
 156  * architecture specific code if needed.
 157  */
 158 int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
 159 void arch_teardown_msi_irq(unsigned int irq);
 160 int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
 161 void arch_teardown_msi_irqs(struct pci_dev *dev);
 162 void arch_restore_msi_irqs(struct pci_dev *dev);
 163
 164 void default_teardown_msi_irqs(struct pci_dev *dev);
 165 void default_restore_msi_irqs(struct pci_dev *dev);
 166
 167 struct msi_controller {
 168         struct module *owner;
 169         struct device *dev;
 170         struct device_node *of_node;
 171         struct list_head list;
 172
 173         int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
 174                          struct msi_desc *desc);
 175         int (*setup_irqs)(struct msi_controller *chip, struct pci_dev *dev,
 176                           int nvec, int type);
 177         void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
 178 };
 179
 180 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
 181
 182 #include <linux/irqhandler.h>
 183 #include <asm/msi.h>
 184
 185 struct irq_domain;
 186 struct irq_chip;
 187 struct device_node;
 188 struct fwnode_handle;
 189 struct msi_domain_info;
 190
 191 /**
 192  * struct msi_domain_ops - MSI interrupt domain callbacks
 193  * @get_hwirq:          Retrieve the resulting hw irq number
 194  * @msi_init:           Domain specific init function for MSI interrupts
 195  * @msi_free:           Domain specific function to free a MSI interrupts
 196  * @msi_check:          Callback for verification of the domain/info/dev data
 197  * @msi_prepare:        Prepare the allocation of the interrupts in the domain
 198  * @msi_finish:         Optional callbacl to finalize the allocation
 199  * @set_desc:           Set the msi descriptor for an interrupt
 200  * @handle_error:       Optional error handler if the allocation fails
 201  *
 202  * @get_hwirq, @msi_init and @msi_free are callbacks used by
 203  * msi_create_irq_domain() and related interfaces
 204  *
 205  * @msi_check, @msi_prepare, @msi_finish, @set_desc and @handle_error
 206  * are callbacks used by msi_irq_domain_alloc_irqs() and related
 207  * interfaces which are based on msi_desc.
 208  */
 209 struct msi_domain_ops {
 210         irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
 211                                      msi_alloc_info_t *arg);
 212         int             (*msi_init)(struct irq_domain *domain,
 213                                     struct msi_domain_info *info,
 214                                     unsigned int virq, irq_hw_number_t hwirq,
 215                                     msi_alloc_info_t *arg);
 216         void            (*msi_free)(struct irq_domain *domain,
 217                                     struct msi_domain_info *info,
 218                                     unsigned int virq);
 219         int             (*msi_check)(struct irq_domain *domain,
 220                                      struct msi_domain_info *info,
 221                                      struct device *dev);
 222         int             (*msi_prepare)(struct irq_domain *domain,
 223                                        struct device *dev, int nvec,
 224                                        msi_alloc_info_t *arg);
 225         void            (*msi_finish)(msi_alloc_info_t *arg, int retval);
 226         void            (*set_desc)(msi_alloc_info_t *arg,
 227                                     struct msi_desc *desc);
 228         int             (*handle_error)(struct irq_domain *domain,
 229                                         struct msi_desc *desc, int error);
 230 };
 231
 232 /**
 233  * struct msi_domain_info - MSI interrupt domain data
 234  * @flags:              Flags to decribe features and capabilities
 235  * @ops:                The callback data structure
 236  * @chip:               Optional: associated interrupt chip
 237  * @chip_data:          Optional: associated interrupt chip data
 238  * @handler:            Optional: associated interrupt flow handler
 239  * @handler_data:       Optional: associated interrupt flow handler data
 240  * @handler_name:       Optional: associated interrupt flow handler name
 241  * @data:               Optional: domain specific data
 242  */
 243 struct msi_domain_info {
 244         u32                     flags;
 245         struct msi_domain_ops   *ops;
 246         struct irq_chip         *chip;
 247         void                    *chip_data;
 248         irq_flow_handler_t      handler;
 249         void                    *handler_data;
 250         const char              *handler_name;
 251         void                    *data;
 252 };
 253
 254 /* Flags for msi_domain_info */
 255 enum {
 256         /*
 257          * Init non implemented ops callbacks with default MSI domain
 258          * callbacks.
 259          */
 260         MSI_FLAG_USE_DEF_DOM_OPS        = (1 << 0),
 261         /*
 262          * Init non implemented chip callbacks with default MSI chip
 263          * callbacks.
 264          */
 265         MSI_FLAG_USE_DEF_CHIP_OPS       = (1 << 1),
 266         /* Support multiple PCI MSI interrupts */
 267         MSI_FLAG_MULTI_PCI_MSI          = (1 << 2),
 268         /* Support PCI MSIX interrupts */
 269         MSI_FLAG_PCI_MSIX               = (1 << 3),
 270         /* Needs early activate, required for PCI */
 271         MSI_FLAG_ACTIVATE_EARLY         = (1 << 4),
 272 };
 273
 274 int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask,
 275                             bool force);
 276
 277 struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
 278                                          struct msi_domain_info *info,
 279                                          struct irq_domain *parent);
 280 int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
 281                           int nvec);
 282 void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
 283 struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain);
 284
 285 struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode,
 286                                                   struct msi_domain_info *info,
 287                                                   struct irq_domain *parent);
 288 int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec,
 289                                    irq_write_msi_msg_t write_msi_msg);
 290 void platform_msi_domain_free_irqs(struct device *dev);
 291 #endif /* CONFIG_GENERIC_MSI_IRQ_DOMAIN */
 292
 293 #ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
 294 void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg);
 295 struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode,
 296                                              struct msi_domain_info *info,
 297                                              struct irq_domain *parent);
 298 int pci_msi_domain_alloc_irqs(struct irq_domain *domain, struct pci_dev *dev,
 299                               int nvec, int type);
 300 void pci_msi_domain_free_irqs(struct irq_domain *domain, struct pci_dev *dev);
 301 struct irq_domain *pci_msi_create_default_irq_domain(struct fwnode_handle *fwnode,
 302                  struct msi_domain_info *info, struct irq_domain *parent);
 303
 304 irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev,
 305                                           struct msi_desc *desc);
 306 int pci_msi_domain_check_cap(struct irq_domain *domain,
 307                              struct msi_domain_info *info, struct device *dev);
 308 u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev);
 309 struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev);
 310 #else
 311 static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev)
 312 {
 313         return NULL;
 314 }
 315 #endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */
 316
 317 #endif /* LINUX_MSI_H */