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