include/linux/msi.h

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