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
  13extern int pci_msi_ignore_mask;
  14/* Helper functions */
  15struct irq_data;
  16struct msi_desc;
  17struct pci_dev;
  18struct platform_msi_priv_data;
  19void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
  20void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
  21
  22typedef 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 */
  30struct 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 */
  39struct 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 */
  64struct 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
 112#ifdef CONFIG_PCI_MSI
 113#define first_pci_msi_entry(pdev)       first_msi_entry(&(pdev)->dev)
 114#define for_each_pci_msi_entry(desc, pdev)      \
 115        for_each_msi_entry((desc), &(pdev)->dev)
 116
 117struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc);
 118void *msi_desc_to_pci_sysdata(struct msi_desc *desc);
 119#else /* CONFIG_PCI_MSI */
 120static inline void *msi_desc_to_pci_sysdata(struct msi_desc *desc)
 121{
 122        return NULL;
 123}
 124#endif /* CONFIG_PCI_MSI */
 125
 126struct msi_desc *alloc_msi_entry(struct device *dev, int nvec,
 127                                 const struct cpumask *affinity);
 128void free_msi_entry(struct msi_desc *entry);
 129void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
 130void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
 131void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
 132
 133u32 __pci_msix_desc_mask_irq(struct msi_desc *desc, u32 flag);
 134u32 __pci_msi_desc_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
 135void pci_msi_mask_irq(struct irq_data *data);
 136void pci_msi_unmask_irq(struct irq_data *data);
 137
 138/* Conversion helpers. Should be removed after merging */
 139static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 140{
 141        __pci_write_msi_msg(entry, msg);
 142}
 143static inline void write_msi_msg(int irq, struct msi_msg *msg)
 144{
 145        pci_write_msi_msg(irq, msg);
 146}
 147static inline void mask_msi_irq(struct irq_data *data)
 148{
 149        pci_msi_mask_irq(data);
 150}
 151static inline void unmask_msi_irq(struct irq_data *data)
 152{
 153        pci_msi_unmask_irq(data);
 154}
 155
 156/*
 157 * The arch hooks to setup up msi irqs. Those functions are
 158 * implemented as weak symbols so that they /can/ be overriden by
 159 * architecture specific code if needed.
 160 */
 161int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
 162void arch_teardown_msi_irq(unsigned int irq);
 163int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
 164void arch_teardown_msi_irqs(struct pci_dev *dev);
 165void arch_restore_msi_irqs(struct pci_dev *dev);
 166
 167void default_teardown_msi_irqs(struct pci_dev *dev);
 168void default_restore_msi_irqs(struct pci_dev *dev);
 169
 170struct msi_controller {
 171        struct module *owner;
 172        struct device *dev;
 173        struct device_node *of_node;
 174        struct list_head list;
 175
 176        int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
 177                         struct msi_desc *desc);
 178        int (*setup_irqs)(struct msi_controller *chip, struct pci_dev *dev,
 179                          int nvec, int type);
 180        void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
 181};
 182
 183#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
 184
 185#include <linux/irqhandler.h>
 186#include <asm/msi.h>
 187
 188struct irq_domain;
 189struct irq_domain_ops;
 190struct irq_chip;
 191struct device_node;
 192struct fwnode_handle;
 193struct msi_domain_info;
 194
 195/**
 196 * struct msi_domain_ops - MSI interrupt domain callbacks
 197 * @get_hwirq:          Retrieve the resulting hw irq number
 198 * @msi_init:           Domain specific init function for MSI interrupts
 199 * @msi_free:           Domain specific function to free a MSI interrupts
 200 * @msi_check:          Callback for verification of the domain/info/dev data
 201 * @msi_prepare:        Prepare the allocation of the interrupts in the domain
 202 * @msi_finish:         Optional callback to finalize the allocation
 203 * @set_desc:           Set the msi descriptor for an interrupt
 204 * @handle_error:       Optional error handler if the allocation fails
 205 *
 206 * @get_hwirq, @msi_init and @msi_free are callbacks used by
 207 * msi_create_irq_domain() and related interfaces
 208 *
 209 * @msi_check, @msi_prepare, @msi_finish, @set_desc and @handle_error
 210 * are callbacks used by msi_domain_alloc_irqs() and related
 211 * interfaces which are based on msi_desc.
 212 */
 213struct msi_domain_ops {
 214        irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
 215                                     msi_alloc_info_t *arg);
 216        int             (*msi_init)(struct irq_domain *domain,
 217                                    struct msi_domain_info *info,
 218                                    unsigned int virq, irq_hw_number_t hwirq,
 219                                    msi_alloc_info_t *arg);
 220        void            (*msi_free)(struct irq_domain *domain,
 221                                    struct msi_domain_info *info,
 222                                    unsigned int virq);
 223        int             (*msi_check)(struct irq_domain *domain,
 224                                     struct msi_domain_info *info,
 225                                     struct device *dev);
 226        int             (*msi_prepare)(struct irq_domain *domain,
 227                                       struct device *dev, int nvec,
 228                                       msi_alloc_info_t *arg);
 229        void            (*msi_finish)(msi_alloc_info_t *arg, int retval);
 230        void            (*set_desc)(msi_alloc_info_t *arg,
 231                                    struct msi_desc *desc);
 232        int             (*handle_error)(struct irq_domain *domain,
 233                                        struct msi_desc *desc, int error);
 234};
 235
 236/**
 237 * struct msi_domain_info - MSI interrupt domain data
 238 * @flags:              Flags to decribe features and capabilities
 239 * @ops:                The callback data structure
 240 * @chip:               Optional: associated interrupt chip
 241 * @chip_data:          Optional: associated interrupt chip data
 242 * @handler:            Optional: associated interrupt flow handler
 243 * @handler_data:       Optional: associated interrupt flow handler data
 244 * @handler_name:       Optional: associated interrupt flow handler name
 245 * @data:               Optional: domain specific data
 246 */
 247struct msi_domain_info {
 248        u32                     flags;
 249        struct msi_domain_ops   *ops;
 250        struct irq_chip         *chip;
 251        void                    *chip_data;
 252        irq_flow_handler_t      handler;
 253        void                    *handler_data;
 254        const char              *handler_name;
 255        void                    *data;
 256};
 257
 258/* Flags for msi_domain_info */
 259enum {
 260        /*
 261         * Init non implemented ops callbacks with default MSI domain
 262         * callbacks.
 263         */
 264        MSI_FLAG_USE_DEF_DOM_OPS        = (1 << 0),
 265        /*
 266         * Init non implemented chip callbacks with default MSI chip
 267         * callbacks.
 268         */
 269        MSI_FLAG_USE_DEF_CHIP_OPS       = (1 << 1),
 270        /* Support multiple PCI MSI interrupts */
 271        MSI_FLAG_MULTI_PCI_MSI          = (1 << 2),
 272        /* Support PCI MSIX interrupts */
 273        MSI_FLAG_PCI_MSIX               = (1 << 3),
 274        /* Needs early activate, required for PCI */
 275        MSI_FLAG_ACTIVATE_EARLY         = (1 << 4),
 276};
 277
 278int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask,
 279                            bool force);
 280
 281struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
 282                                         struct msi_domain_info *info,
 283                                         struct irq_domain *parent);
 284int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
 285                          int nvec);
 286void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
 287struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain);
 288
 289struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode,
 290                                                  struct msi_domain_info *info,
 291                                                  struct irq_domain *parent);
 292int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec,
 293                                   irq_write_msi_msg_t write_msi_msg);
 294void platform_msi_domain_free_irqs(struct device *dev);
 295
 296/* When an MSI domain is used as an intermediate domain */
 297int msi_domain_prepare_irqs(struct irq_domain *domain, struct device *dev,
 298                            int nvec, msi_alloc_info_t *args);
 299int msi_domain_populate_irqs(struct irq_domain *domain, struct device *dev,
 300                             int virq, int nvec, msi_alloc_info_t *args);
 301struct irq_domain *
 302platform_msi_create_device_domain(struct device *dev,
 303                                  unsigned int nvec,
 304                                  irq_write_msi_msg_t write_msi_msg,
 305                                  const struct irq_domain_ops *ops,
 306                                  void *host_data);
 307int platform_msi_domain_alloc(struct irq_domain *domain, unsigned int virq,
 308                              unsigned int nr_irqs);
 309void platform_msi_domain_free(struct irq_domain *domain, unsigned int virq,
 310                              unsigned int nvec);
 311void *platform_msi_get_host_data(struct irq_domain *domain);
 312#endif /* CONFIG_GENERIC_MSI_IRQ_DOMAIN */
 313
 314#ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
 315void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg);
 316struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode,
 317                                             struct msi_domain_info *info,
 318                                             struct irq_domain *parent);
 319int pci_msi_domain_alloc_irqs(struct irq_domain *domain, struct pci_dev *dev,
 320                              int nvec, int type);
 321void pci_msi_domain_free_irqs(struct irq_domain *domain, struct pci_dev *dev);
 322struct irq_domain *pci_msi_create_default_irq_domain(struct fwnode_handle *fwnode,
 323                 struct msi_domain_info *info, struct irq_domain *parent);
 324
 325irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev,
 326                                          struct msi_desc *desc);
 327int pci_msi_domain_check_cap(struct irq_domain *domain,
 328                             struct msi_domain_info *info, struct device *dev);
 329u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev);
 330struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev);
 331#else
 332static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev)
 333{
 334        return NULL;
 335}
 336#endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */
 337
 338#endif /* LINUX_MSI_H */
 339