drivers/staging/fsl-mc/bus/fsl-mc-msi.c

   1 /*
   2  * Freescale Management Complex (MC) bus driver MSI support
   3  *
   4  * Copyright (C) 2015-2016 Freescale Semiconductor, Inc.
   5  * Author: German Rivera <German.Rivera@freescale.com>
   6  *
   7  * This file is licensed under the terms of the GNU General Public
   8  * License version 2. This program is licensed "as is" without any
   9  * warranty of any kind, whether express or implied.
  10  */
  11
  12 #include <linux/of_device.h>
  13 #include <linux/of_address.h>
  14 #include <linux/of_irq.h>
  15 #include <linux/irq.h>
  16 #include <linux/irqdomain.h>
  17 #include <linux/msi.h>
  18 #include "fsl-mc-private.h"
  19
  20 #ifdef GENERIC_MSI_DOMAIN_OPS
  21 /*
  22  * Generate a unique ID identifying the interrupt (only used within the MSI
  23  * irqdomain.  Combine the icid with the interrupt index.
  24  */
  25 static irq_hw_number_t fsl_mc_domain_calc_hwirq(struct fsl_mc_device *dev,
  26                                                 struct msi_desc *desc)
  27 {
  28         /*
  29          * Make the base hwirq value for ICID*10000 so it is readable
  30          * as a decimal value in /proc/interrupts.
  31          */
  32         return (irq_hw_number_t)(desc->fsl_mc.msi_index + (dev->icid * 10000));
  33 }
  34
  35 static void fsl_mc_msi_set_desc(msi_alloc_info_t *arg,
  36                                 struct msi_desc *desc)
  37 {
  38         arg->desc = desc;
  39         arg->hwirq = fsl_mc_domain_calc_hwirq(to_fsl_mc_device(desc->dev),
  40                                               desc);
  41 }
  42 #else
  43 #define fsl_mc_msi_set_desc NULL
  44 #endif
  45
  46 static void fsl_mc_msi_update_dom_ops(struct msi_domain_info *info)
  47 {
  48         struct msi_domain_ops *ops = info->ops;
  49
  50         if (WARN_ON(!ops))
  51                 return;
  52
  53         /*
  54          * set_desc should not be set by the caller
  55          */
  56         if (!ops->set_desc)
  57                 ops->set_desc = fsl_mc_msi_set_desc;
  58 }
  59
  60 static void __fsl_mc_msi_write_msg(struct fsl_mc_device *mc_bus_dev,
  61                                    struct fsl_mc_device_irq *mc_dev_irq)
  62 {
  63         int error;
  64         struct fsl_mc_device *owner_mc_dev = mc_dev_irq->mc_dev;
  65         struct msi_desc *msi_desc = mc_dev_irq->msi_desc;
  66         struct dprc_irq_cfg irq_cfg;
  67
  68         /*
  69          * msi_desc->msg.address is 0x0 when this function is invoked in
  70          * the free_irq() code path. In this case, for the MC, we don't
  71          * really need to "unprogram" the MSI, so we just return.
  72          */
  73         if (msi_desc->msg.address_lo == 0x0 && msi_desc->msg.address_hi == 0x0)
  74                 return;
  75
  76         if (WARN_ON(!owner_mc_dev))
  77                 return;
  78
  79         irq_cfg.paddr = ((u64)msi_desc->msg.address_hi << 32) |
  80                         msi_desc->msg.address_lo;
  81         irq_cfg.val = msi_desc->msg.data;
  82         irq_cfg.irq_num = msi_desc->irq;
  83
  84         if (owner_mc_dev == mc_bus_dev) {
  85                 /*
  86                  * IRQ is for the mc_bus_dev's DPRC itself
  87                  */
  88                 error = dprc_set_irq(mc_bus_dev->mc_io,
  89                                      MC_CMD_FLAG_INTR_DIS | MC_CMD_FLAG_PRI,
  90                                      mc_bus_dev->mc_handle,
  91                                      mc_dev_irq->dev_irq_index,
  92                                      &irq_cfg);
  93                 if (error < 0) {
  94                         dev_err(&owner_mc_dev->dev,
  95                                 "dprc_set_irq() failed: %d\n", error);
  96                 }
  97         } else {
  98                 /*
  99                  * IRQ is for for a child device of mc_bus_dev
 100                  */
 101                 error = dprc_set_obj_irq(mc_bus_dev->mc_io,
 102                                          MC_CMD_FLAG_INTR_DIS | MC_CMD_FLAG_PRI,
 103                                          mc_bus_dev->mc_handle,
 104                                          owner_mc_dev->obj_desc.type,
 105                                          owner_mc_dev->obj_desc.id,
 106                                          mc_dev_irq->dev_irq_index,
 107                                          &irq_cfg);
 108                 if (error < 0) {
 109                         dev_err(&owner_mc_dev->dev,
 110                                 "dprc_obj_set_irq() failed: %d\n", error);
 111                 }
 112         }
 113 }
 114
 115 /*
 116  * NOTE: This function is invoked with interrupts disabled
 117  */
 118 static void fsl_mc_msi_write_msg(struct irq_data *irq_data,
 119                                  struct msi_msg *msg)
 120 {
 121         struct msi_desc *msi_desc = irq_data_get_msi_desc(irq_data);
 122         struct fsl_mc_device *mc_bus_dev = to_fsl_mc_device(msi_desc->dev);
 123         struct fsl_mc_bus *mc_bus = to_fsl_mc_bus(mc_bus_dev);
 124         struct fsl_mc_device_irq *mc_dev_irq =
 125                 &mc_bus->irq_resources[msi_desc->fsl_mc.msi_index];
 126
 127         WARN_ON(mc_dev_irq->msi_desc != msi_desc);
 128         msi_desc->msg = *msg;
 129
 130         /*
 131          * Program the MSI (paddr, value) pair in the device:
 132          */
 133         __fsl_mc_msi_write_msg(mc_bus_dev, mc_dev_irq);
 134 }
 135
 136 static void fsl_mc_msi_update_chip_ops(struct msi_domain_info *info)
 137 {
 138         struct irq_chip *chip = info->chip;
 139
 140         if (WARN_ON((!chip)))
 141                 return;
 142
 143         /*
 144          * irq_write_msi_msg should not be set by the caller
 145          */
 146         if (!chip->irq_write_msi_msg)
 147                 chip->irq_write_msi_msg = fsl_mc_msi_write_msg;
 148 }
 149
 150 /**
 151  * fsl_mc_msi_create_irq_domain - Create a fsl-mc MSI interrupt domain
 152  * @np:         Optional device-tree node of the interrupt controller
 153  * @info:       MSI domain info
 154  * @parent:     Parent irq domain
 155  *
 156  * Updates the domain and chip ops and creates a fsl-mc MSI
 157  * interrupt domain.
 158  *
 159  * Returns:
 160  * A domain pointer or NULL in case of failure.
 161  */
 162 struct irq_domain *fsl_mc_msi_create_irq_domain(struct fwnode_handle *fwnode,
 163                                                 struct msi_domain_info *info,
 164                                                 struct irq_domain *parent)
 165 {
 166         struct irq_domain *domain;
 167
 168         if (info->flags & MSI_FLAG_USE_DEF_DOM_OPS)
 169                 fsl_mc_msi_update_dom_ops(info);
 170         if (info->flags & MSI_FLAG_USE_DEF_CHIP_OPS)
 171                 fsl_mc_msi_update_chip_ops(info);
 172
 173         domain = msi_create_irq_domain(fwnode, info, parent);
 174         if (domain)
 175                 irq_domain_update_bus_token(domain, DOMAIN_BUS_FSL_MC_MSI);
 176
 177         return domain;
 178 }
 179
 180 int fsl_mc_find_msi_domain(struct device *mc_platform_dev,
 181                            struct irq_domain **mc_msi_domain)
 182 {
 183         struct irq_domain *msi_domain;
 184         struct device_node *mc_of_node = mc_platform_dev->of_node;
 185
 186         msi_domain = of_msi_get_domain(mc_platform_dev, mc_of_node,
 187                                        DOMAIN_BUS_FSL_MC_MSI);
 188         if (!msi_domain) {
 189                 pr_err("Unable to find fsl-mc MSI domain for %pOF\n",
 190                        mc_of_node);
 191
 192                 return -ENOENT;
 193         }
 194
 195         *mc_msi_domain = msi_domain;
 196         return 0;
 197 }
 198
 199 static void fsl_mc_msi_free_descs(struct device *dev)
 200 {
 201         struct msi_desc *desc, *tmp;
 202
 203         list_for_each_entry_safe(desc, tmp, dev_to_msi_list(dev), list) {
 204                 list_del(&desc->list);
 205                 free_msi_entry(desc);
 206         }
 207 }
 208
 209 static int fsl_mc_msi_alloc_descs(struct device *dev, unsigned int irq_count)
 210
 211 {
 212         unsigned int i;
 213         int error;
 214         struct msi_desc *msi_desc;
 215
 216         for (i = 0; i < irq_count; i++) {
 217                 msi_desc = alloc_msi_entry(dev, 1, NULL);
 218                 if (!msi_desc) {
 219                         dev_err(dev, "Failed to allocate msi entry\n");
 220                         error = -ENOMEM;
 221                         goto cleanup_msi_descs;
 222                 }
 223
 224                 msi_desc->fsl_mc.msi_index = i;
 225                 INIT_LIST_HEAD(&msi_desc->list);
 226                 list_add_tail(&msi_desc->list, dev_to_msi_list(dev));
 227         }
 228
 229         return 0;
 230
 231 cleanup_msi_descs:
 232         fsl_mc_msi_free_descs(dev);
 233         return error;
 234 }
 235
 236 int fsl_mc_msi_domain_alloc_irqs(struct device *dev,
 237                                  unsigned int irq_count)
 238 {
 239         struct irq_domain *msi_domain;
 240         int error;
 241
 242         if (WARN_ON(!list_empty(dev_to_msi_list(dev))))
 243                 return -EINVAL;
 244
 245         error = fsl_mc_msi_alloc_descs(dev, irq_count);
 246         if (error < 0)
 247                 return error;
 248
 249         msi_domain = dev_get_msi_domain(dev);
 250         if (WARN_ON(!msi_domain)) {
 251                 error = -EINVAL;
 252                 goto cleanup_msi_descs;
 253         }
 254
 255         /*
 256          * NOTE: Calling this function will trigger the invocation of the
 257          * its_fsl_mc_msi_prepare() callback
 258          */
 259         error = msi_domain_alloc_irqs(msi_domain, dev, irq_count);
 260
 261         if (error) {
 262                 dev_err(dev, "Failed to allocate IRQs\n");
 263                 goto cleanup_msi_descs;
 264         }
 265
 266         return 0;
 267
 268 cleanup_msi_descs:
 269         fsl_mc_msi_free_descs(dev);
 270         return error;
 271 }
 272
 273 void fsl_mc_msi_domain_free_irqs(struct device *dev)
 274 {
 275         struct irq_domain *msi_domain;
 276
 277         msi_domain = dev_get_msi_domain(dev);
 278         if (WARN_ON(!msi_domain))
 279                 return;
 280
 281         msi_domain_free_irqs(msi_domain, dev);
 282
 283         if (WARN_ON(list_empty(dev_to_msi_list(dev))))
 284                 return;
 285
 286         fsl_mc_msi_free_descs(dev);
 287 }