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/cpumask.h>
   6 #include <linux/list.h>
   7 #include <asm/msi.h>
   8
   9 /* Dummy shadow structures if an architecture does not define them */
  10 #ifndef arch_msi_msg_addr_lo
  11 typedef struct arch_msi_msg_addr_lo {
  12         u32     address_lo;
  13 } __attribute__ ((packed)) arch_msi_msg_addr_lo_t;
  14 #endif
  15
  16 #ifndef arch_msi_msg_addr_hi
  17 typedef struct arch_msi_msg_addr_hi {
  18         u32     address_hi;
  19 } __attribute__ ((packed)) arch_msi_msg_addr_hi_t;
  20 #endif
  21
  22 #ifndef arch_msi_msg_data
  23 typedef struct arch_msi_msg_data {
  24         u32     data;
  25 } __attribute__ ((packed)) arch_msi_msg_data_t;
  26 #endif
  27
  28 /**
  29  * msi_msg - Representation of a MSI message
  30  * @address_lo:         Low 32 bits of msi message address
  31  * @arch_addrlo:        Architecture specific shadow of @address_lo
  32  * @address_hi:         High 32 bits of msi message address
  33  *                      (only used when device supports it)
  34  * @arch_addrhi:        Architecture specific shadow of @address_hi
  35  * @data:               MSI message data (usually 16 bits)
  36  * @arch_data:          Architecture specific shadow of @data
  37  */
  38 struct msi_msg {
  39         union {
  40                 u32                     address_lo;
  41                 arch_msi_msg_addr_lo_t  arch_addr_lo;
  42         };
  43         union {
  44                 u32                     address_hi;
  45                 arch_msi_msg_addr_hi_t  arch_addr_hi;
  46         };
  47         union {
  48                 u32                     data;
  49                 arch_msi_msg_data_t     arch_data;
  50         };
  51 };
  52
  53 extern int pci_msi_ignore_mask;
  54 /* Helper functions */
  55 struct irq_data;
  56 struct msi_desc;
  57 struct pci_dev;
  58 struct platform_msi_priv_data;
  59 struct attribute_group;
  60
  61 void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
  62 #ifdef CONFIG_GENERIC_MSI_IRQ
  63 void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
  64 #else
  65 static inline void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg)
  66 {
  67 }
  68 #endif
  69
  70 typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
  71                                     struct msi_msg *msg);
  72
  73 /**
  74  * pci_msi_desc - PCI/MSI specific MSI descriptor data
  75  *
  76  * @msi_mask:   [PCI MSI]   MSI cached mask bits
  77  * @msix_ctrl:  [PCI MSI-X] MSI-X cached per vector control bits
  78  * @is_msix:    [PCI MSI/X] True if MSI-X
  79  * @multiple:   [PCI MSI/X] log2 num of messages allocated
  80  * @multi_cap:  [PCI MSI/X] log2 num of messages supported
  81  * @can_mask:   [PCI MSI/X] Masking supported?
  82  * @is_64:      [PCI MSI/X] Address size: 0=32bit 1=64bit
  83  * @entry_nr:   [PCI MSI/X] Entry which is described by this descriptor
  84  * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
  85  * @mask_pos:   [PCI MSI]   Mask register position
  86  * @mask_base:  [PCI MSI-X] Mask register base address
  87  */
  88 struct pci_msi_desc {
  89         union {
  90                 u32 msi_mask;
  91                 u32 msix_ctrl;
  92         };
  93         struct {
  94                 u8      is_msix         : 1;
  95                 u8      multiple        : 3;
  96                 u8      multi_cap       : 3;
  97                 u8      can_mask        : 1;
  98                 u8      is_64           : 1;
  99                 u8      is_virtual      : 1;
 100                 u16     entry_nr;
 101                 unsigned default_irq;
 102         } msi_attrib;
 103         union {
 104                 u8      mask_pos;
 105                 void __iomem *mask_base;
 106         };
 107 };
 108
 109 /**
 110  * platform_msi_desc - Platform device specific msi descriptor data
 111  * @msi_priv_data:      Pointer to platform private data
 112  * @msi_index:          The index of the MSI descriptor for multi MSI
 113  */
 114 struct platform_msi_desc {
 115         struct platform_msi_priv_data   *msi_priv_data;
 116         u16                             msi_index;
 117 };
 118
 119 /**
 120  * fsl_mc_msi_desc - FSL-MC device specific msi descriptor data
 121  * @msi_index:          The index of the MSI descriptor
 122  */
 123 struct fsl_mc_msi_desc {
 124         u16                             msi_index;
 125 };
 126
 127 /**
 128  * ti_sci_inta_msi_desc - TISCI based INTA specific msi descriptor data
 129  * @dev_index: TISCI device index
 130  */
 131 struct ti_sci_inta_msi_desc {
 132         u16     dev_index;
 133 };
 134
 135 /**
 136  * struct msi_desc - Descriptor structure for MSI based interrupts
 137  * @list:       List head for management
 138  * @irq:        The base interrupt number
 139  * @nvec_used:  The number of vectors used
 140  * @dev:        Pointer to the device which uses this descriptor
 141  * @msg:        The last set MSI message cached for reuse
 142  * @affinity:   Optional pointer to a cpu affinity mask for this descriptor
 143  *
 144  * @write_msi_msg:      Callback that may be called when the MSI message
 145  *                      address or data changes
 146  * @write_msi_msg_data: Data parameter for the callback.
 147  *
 148  * @pci:        [PCI]       PCI speficic msi descriptor data
 149  * @platform:   [platform]  Platform device specific msi descriptor data
 150  * @fsl_mc:     [fsl-mc]    FSL MC device specific msi descriptor data
 151  * @inta:       [INTA]      TISCI based INTA specific msi descriptor data
 152  */
 153 struct msi_desc {
 154         /* Shared device/bus type independent data */
 155         struct list_head                list;
 156         unsigned int                    irq;
 157         unsigned int                    nvec_used;
 158         struct device                   *dev;
 159         struct msi_msg                  msg;
 160         struct irq_affinity_desc        *affinity;
 161 #ifdef CONFIG_IRQ_MSI_IOMMU
 162         const void                      *iommu_cookie;
 163 #endif
 164
 165         void (*write_msi_msg)(struct msi_desc *entry, void *data);
 166         void *write_msi_msg_data;
 167
 168         union {
 169                 struct pci_msi_desc             pci;
 170                 struct platform_msi_desc        platform;
 171                 struct fsl_mc_msi_desc          fsl_mc;
 172                 struct ti_sci_inta_msi_desc     inta;
 173         };
 174 };
 175
 176 /**
 177  * msi_device_data - MSI per device data
 178  * @properties:         MSI properties which are interesting to drivers
 179  * @attrs:              Pointer to the sysfs attribute group
 180  */
 181 struct msi_device_data {
 182         unsigned long                   properties;
 183         const struct attribute_group    **attrs;
 184 };
 185
 186 int msi_setup_device_data(struct device *dev);
 187
 188 /* Helpers to hide struct msi_desc implementation details */
 189 #define msi_desc_to_dev(desc)           ((desc)->dev)
 190 #define dev_to_msi_list(dev)            (&(dev)->msi_list)
 191 #define first_msi_entry(dev)            \
 192         list_first_entry(dev_to_msi_list((dev)), struct msi_desc, list)
 193 #define for_each_msi_entry(desc, dev)   \
 194         list_for_each_entry((desc), dev_to_msi_list((dev)), list)
 195 #define for_each_msi_entry_safe(desc, tmp, dev) \
 196         list_for_each_entry_safe((desc), (tmp), dev_to_msi_list((dev)), list)
 197 #define for_each_msi_vector(desc, __irq, dev)                           \
 198         for_each_msi_entry((desc), (dev))                               \
 199                 if ((desc)->irq)                                        \
 200                         for (__irq = (desc)->irq;                       \
 201                              __irq < ((desc)->irq + (desc)->nvec_used); \
 202                              __irq++)
 203
 204 #ifdef CONFIG_IRQ_MSI_IOMMU
 205 static inline const void *msi_desc_get_iommu_cookie(struct msi_desc *desc)
 206 {
 207         return desc->iommu_cookie;
 208 }
 209
 210 static inline void msi_desc_set_iommu_cookie(struct msi_desc *desc,
 211                                              const void *iommu_cookie)
 212 {
 213         desc->iommu_cookie = iommu_cookie;
 214 }
 215 #else
 216 static inline const void *msi_desc_get_iommu_cookie(struct msi_desc *desc)
 217 {
 218         return NULL;
 219 }
 220
 221 static inline void msi_desc_set_iommu_cookie(struct msi_desc *desc,
 222                                              const void *iommu_cookie)
 223 {
 224 }
 225 #endif
 226
 227 #ifdef CONFIG_PCI_MSI
 228 #define first_pci_msi_entry(pdev)       first_msi_entry(&(pdev)->dev)
 229 #define for_each_pci_msi_entry(desc, pdev)      \
 230         for_each_msi_entry((desc), &(pdev)->dev)
 231
 232 struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc);
 233 void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
 234 #else /* CONFIG_PCI_MSI */
 235 static inline void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg)
 236 {
 237 }
 238 #endif /* CONFIG_PCI_MSI */
 239
 240 struct msi_desc *alloc_msi_entry(struct device *dev, int nvec,
 241                                  const struct irq_affinity_desc *affinity);
 242 void free_msi_entry(struct msi_desc *entry);
 243 void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
 244 void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
 245
 246 void pci_msi_mask_irq(struct irq_data *data);
 247 void pci_msi_unmask_irq(struct irq_data *data);
 248
 249 #ifdef CONFIG_SYSFS
 250 int msi_device_populate_sysfs(struct device *dev);
 251 void msi_device_destroy_sysfs(struct device *dev);
 252 #else /* CONFIG_SYSFS */
 253 static inline int msi_device_populate_sysfs(struct device *dev) { return 0; }
 254 static inline void msi_device_destroy_sysfs(struct device *dev) { }
 255 #endif /* !CONFIG_SYSFS */
 256
 257 /*
 258  * The arch hooks to setup up msi irqs. Default functions are implemented
 259  * as weak symbols so that they /can/ be overriden by architecture specific
 260  * code if needed. These hooks can only be enabled by the architecture.
 261  *
 262  * If CONFIG_PCI_MSI_ARCH_FALLBACKS is not selected they are replaced by
 263  * stubs with warnings.
 264  */
 265 #ifdef CONFIG_PCI_MSI_ARCH_FALLBACKS
 266 int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
 267 void arch_teardown_msi_irq(unsigned int irq);
 268 int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
 269 void arch_teardown_msi_irqs(struct pci_dev *dev);
 270 #endif /* CONFIG_PCI_MSI_ARCH_FALLBACKS */
 271
 272 /*
 273  * The restore hook is still available even for fully irq domain based
 274  * setups. Courtesy to XEN/X86.
 275  */
 276 bool arch_restore_msi_irqs(struct pci_dev *dev);
 277
 278 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
 279
 280 #include <linux/irqhandler.h>
 281
 282 struct irq_domain;
 283 struct irq_domain_ops;
 284 struct irq_chip;
 285 struct device_node;
 286 struct fwnode_handle;
 287 struct msi_domain_info;
 288
 289 /**
 290  * struct msi_domain_ops - MSI interrupt domain callbacks
 291  * @get_hwirq:          Retrieve the resulting hw irq number
 292  * @msi_init:           Domain specific init function for MSI interrupts
 293  * @msi_free:           Domain specific function to free a MSI interrupts
 294  * @msi_check:          Callback for verification of the domain/info/dev data
 295  * @msi_prepare:        Prepare the allocation of the interrupts in the domain
 296  * @set_desc:           Set the msi descriptor for an interrupt
 297  * @domain_alloc_irqs:  Optional function to override the default allocation
 298  *                      function.
 299  * @domain_free_irqs:   Optional function to override the default free
 300  *                      function.
 301  *
 302  * @get_hwirq, @msi_init and @msi_free are callbacks used by the underlying
 303  * irqdomain.
 304  *
 305  * @msi_check, @msi_prepare and @set_desc are callbacks used by
 306  * msi_domain_alloc/free_irqs().
 307  *
 308  * @domain_alloc_irqs, @domain_free_irqs can be used to override the
 309  * default allocation/free functions (__msi_domain_alloc/free_irqs). This
 310  * is initially for a wrapper around XENs seperate MSI universe which can't
 311  * be wrapped into the regular irq domains concepts by mere mortals.  This
 312  * allows to universally use msi_domain_alloc/free_irqs without having to
 313  * special case XEN all over the place.
 314  *
 315  * Contrary to other operations @domain_alloc_irqs and @domain_free_irqs
 316  * are set to the default implementation if NULL and even when
 317  * MSI_FLAG_USE_DEF_DOM_OPS is not set to avoid breaking existing users and
 318  * because these callbacks are obviously mandatory.
 319  *
 320  * This is NOT meant to be abused, but it can be useful to build wrappers
 321  * for specialized MSI irq domains which need extra work before and after
 322  * calling __msi_domain_alloc_irqs()/__msi_domain_free_irqs().
 323  */
 324 struct msi_domain_ops {
 325         irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
 326                                      msi_alloc_info_t *arg);
 327         int             (*msi_init)(struct irq_domain *domain,
 328                                     struct msi_domain_info *info,
 329                                     unsigned int virq, irq_hw_number_t hwirq,
 330                                     msi_alloc_info_t *arg);
 331         void            (*msi_free)(struct irq_domain *domain,
 332                                     struct msi_domain_info *info,
 333                                     unsigned int virq);
 334         int             (*msi_check)(struct irq_domain *domain,
 335                                      struct msi_domain_info *info,
 336                                      struct device *dev);
 337         int             (*msi_prepare)(struct irq_domain *domain,
 338                                        struct device *dev, int nvec,
 339                                        msi_alloc_info_t *arg);
 340         void            (*set_desc)(msi_alloc_info_t *arg,
 341                                     struct msi_desc *desc);
 342         int             (*domain_alloc_irqs)(struct irq_domain *domain,
 343                                              struct device *dev, int nvec);
 344         void            (*domain_free_irqs)(struct irq_domain *domain,
 345                                             struct device *dev);
 346 };
 347
 348 /**
 349  * struct msi_domain_info - MSI interrupt domain data
 350  * @flags:              Flags to decribe features and capabilities
 351  * @ops:                The callback data structure
 352  * @chip:               Optional: associated interrupt chip
 353  * @chip_data:          Optional: associated interrupt chip data
 354  * @handler:            Optional: associated interrupt flow handler
 355  * @handler_data:       Optional: associated interrupt flow handler data
 356  * @handler_name:       Optional: associated interrupt flow handler name
 357  * @data:               Optional: domain specific data
 358  */
 359 struct msi_domain_info {
 360         u32                     flags;
 361         struct msi_domain_ops   *ops;
 362         struct irq_chip         *chip;
 363         void                    *chip_data;
 364         irq_flow_handler_t      handler;
 365         void                    *handler_data;
 366         const char              *handler_name;
 367         void                    *data;
 368 };
 369
 370 /* Flags for msi_domain_info */
 371 enum {
 372         /*
 373          * Init non implemented ops callbacks with default MSI domain
 374          * callbacks.
 375          */
 376         MSI_FLAG_USE_DEF_DOM_OPS        = (1 << 0),
 377         /*
 378          * Init non implemented chip callbacks with default MSI chip
 379          * callbacks.
 380          */
 381         MSI_FLAG_USE_DEF_CHIP_OPS       = (1 << 1),
 382         /* Support multiple PCI MSI interrupts */
 383         MSI_FLAG_MULTI_PCI_MSI          = (1 << 2),
 384         /* Support PCI MSIX interrupts */
 385         MSI_FLAG_PCI_MSIX               = (1 << 3),
 386         /* Needs early activate, required for PCI */
 387         MSI_FLAG_ACTIVATE_EARLY         = (1 << 4),
 388         /*
 389          * Must reactivate when irq is started even when
 390          * MSI_FLAG_ACTIVATE_EARLY has been set.
 391          */
 392         MSI_FLAG_MUST_REACTIVATE        = (1 << 5),
 393         /* Is level-triggered capable, using two messages */
 394         MSI_FLAG_LEVEL_CAPABLE          = (1 << 6),
 395         /* Populate sysfs on alloc() and destroy it on free() */
 396         MSI_FLAG_DEV_SYSFS              = (1 << 7),
 397 };
 398
 399 int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask,
 400                             bool force);
 401
 402 struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
 403                                          struct msi_domain_info *info,
 404                                          struct irq_domain *parent);
 405 int __msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
 406                             int nvec);
 407 int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
 408                           int nvec);
 409 void __msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
 410 void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
 411 struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain);
 412
 413 struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode,
 414                                                   struct msi_domain_info *info,
 415                                                   struct irq_domain *parent);
 416 int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec,
 417                                    irq_write_msi_msg_t write_msi_msg);
 418 void platform_msi_domain_free_irqs(struct device *dev);
 419
 420 /* When an MSI domain is used as an intermediate domain */
 421 int msi_domain_prepare_irqs(struct irq_domain *domain, struct device *dev,
 422                             int nvec, msi_alloc_info_t *args);
 423 int msi_domain_populate_irqs(struct irq_domain *domain, struct device *dev,
 424                              int virq, int nvec, msi_alloc_info_t *args);
 425 struct irq_domain *
 426 __platform_msi_create_device_domain(struct device *dev,
 427                                     unsigned int nvec,
 428                                     bool is_tree,
 429                                     irq_write_msi_msg_t write_msi_msg,
 430                                     const struct irq_domain_ops *ops,
 431                                     void *host_data);
 432
 433 #define platform_msi_create_device_domain(dev, nvec, write, ops, data)  \
 434         __platform_msi_create_device_domain(dev, nvec, false, write, ops, data)
 435 #define platform_msi_create_device_tree_domain(dev, nvec, write, ops, data) \
 436         __platform_msi_create_device_domain(dev, nvec, true, write, ops, data)
 437
 438 int platform_msi_domain_alloc(struct irq_domain *domain, unsigned int virq,
 439                               unsigned int nr_irqs);
 440 void platform_msi_domain_free(struct irq_domain *domain, unsigned int virq,
 441                               unsigned int nvec);
 442 void *platform_msi_get_host_data(struct irq_domain *domain);
 443 #endif /* CONFIG_GENERIC_MSI_IRQ_DOMAIN */
 444
 445 #ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
 446 struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode,
 447                                              struct msi_domain_info *info,
 448                                              struct irq_domain *parent);
 449 u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev);
 450 struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev);
 451 bool pci_dev_has_special_msi_domain(struct pci_dev *pdev);
 452 #else
 453 static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev)
 454 {
 455         return NULL;
 456 }
 457 #endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */
 458
 459 #endif /* LINUX_MSI_H */