drivers/mfd/mfd-core.c

   1 /*
   2  * drivers/mfd/mfd-core.c
   3  *
   4  * core MFD support
   5  * Copyright (c) 2006 Ian Molton
   6  * Copyright (c) 2007,2008 Dmitry Baryshkov
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  */
  13
  14 #include <linux/kernel.h>
  15 #include <linux/platform_device.h>
  16 #include <linux/acpi.h>
  17 #include <linux/property.h>
  18 #include <linux/mfd/core.h>
  19 #include <linux/pm_runtime.h>
  20 #include <linux/slab.h>
  21 #include <linux/module.h>
  22 #include <linux/irqdomain.h>
  23 #include <linux/of.h>
  24 #include <linux/regulator/consumer.h>
  25
  26 static struct device_type mfd_dev_type = {
  27         .name   = "mfd_device",
  28 };
  29
  30 int mfd_cell_enable(struct platform_device *pdev)
  31 {
  32         const struct mfd_cell *cell = mfd_get_cell(pdev);
  33         int err = 0;
  34
  35         /* only call enable hook if the cell wasn't previously enabled */
  36         if (atomic_inc_return(cell->usage_count) == 1)
  37                 err = cell->enable(pdev);
  38
  39         /* if the enable hook failed, decrement counter to allow retries */
  40         if (err)
  41                 atomic_dec(cell->usage_count);
  42
  43         return err;
  44 }
  45 EXPORT_SYMBOL(mfd_cell_enable);
  46
  47 int mfd_cell_disable(struct platform_device *pdev)
  48 {
  49         const struct mfd_cell *cell = mfd_get_cell(pdev);
  50         int err = 0;
  51
  52         /* only disable if no other clients are using it */
  53         if (atomic_dec_return(cell->usage_count) == 0)
  54                 err = cell->disable(pdev);
  55
  56         /* if the disable hook failed, increment to allow retries */
  57         if (err)
  58                 atomic_inc(cell->usage_count);
  59
  60         /* sanity check; did someone call disable too many times? */
  61         WARN_ON(atomic_read(cell->usage_count) < 0);
  62
  63         return err;
  64 }
  65 EXPORT_SYMBOL(mfd_cell_disable);
  66
  67 static int mfd_platform_add_cell(struct platform_device *pdev,
  68                                  const struct mfd_cell *cell,
  69                                  atomic_t *usage_count)
  70 {
  71         if (!cell)
  72                 return 0;
  73
  74         pdev->mfd_cell = kmemdup(cell, sizeof(*cell), GFP_KERNEL);
  75         if (!pdev->mfd_cell)
  76                 return -ENOMEM;
  77
  78         pdev->mfd_cell->usage_count = usage_count;
  79         return 0;
  80 }
  81
  82 #if IS_ENABLED(CONFIG_ACPI)
  83 static void mfd_acpi_add_device(const struct mfd_cell *cell,
  84                                 struct platform_device *pdev)
  85 {
  86         const struct mfd_cell_acpi_match *match = cell->acpi_match;
  87         struct acpi_device *parent, *child;
  88         struct acpi_device *adev;
  89
  90         parent = ACPI_COMPANION(pdev->dev.parent);
  91         if (!parent)
  92                 return;
  93
  94         /*
  95          * MFD child device gets its ACPI handle either from the ACPI device
  96          * directly under the parent that matches the either _HID or _CID, or
  97          * _ADR or it will use the parent handle if is no ID is given.
  98          *
  99          * Note that use of _ADR is a grey area in the ACPI specification,
 100          * though Intel Galileo Gen2 is using it to distinguish the children
 101          * devices.
 102          */
 103         adev = parent;
 104         if (match) {
 105                 if (match->pnpid) {
 106                         struct acpi_device_id ids[2] = {};
 107
 108                         strlcpy(ids[0].id, match->pnpid, sizeof(ids[0].id));
 109                         list_for_each_entry(child, &parent->children, node) {
 110                                 if (!acpi_match_device_ids(child, ids)) {
 111                                         adev = child;
 112                                         break;
 113                                 }
 114                         }
 115                 } else {
 116                         unsigned long long adr;
 117                         acpi_status status;
 118
 119                         list_for_each_entry(child, &parent->children, node) {
 120                                 status = acpi_evaluate_integer(child->handle,
 121                                                                "_ADR", NULL,
 122                                                                &adr);
 123                                 if (ACPI_SUCCESS(status) && match->adr == adr) {
 124                                         adev = child;
 125                                         break;
 126                                 }
 127                         }
 128                 }
 129         }
 130
 131         ACPI_COMPANION_SET(&pdev->dev, adev);
 132 }
 133 #else
 134 static inline void mfd_acpi_add_device(const struct mfd_cell *cell,
 135                                        struct platform_device *pdev)
 136 {
 137 }
 138 #endif
 139
 140 static int mfd_add_device(struct device *parent, int id,
 141                           const struct mfd_cell *cell, atomic_t *usage_count,
 142                           struct resource *mem_base,
 143                           int irq_base, struct irq_domain *domain)
 144 {
 145         struct resource *res;
 146         struct platform_device *pdev;
 147         struct device_node *np = NULL;
 148         int ret = -ENOMEM;
 149         int platform_id;
 150         int r;
 151
 152         if (id == PLATFORM_DEVID_AUTO)
 153                 platform_id = id;
 154         else
 155                 platform_id = id + cell->id;
 156
 157         pdev = platform_device_alloc(cell->name, platform_id);
 158         if (!pdev)
 159                 goto fail_alloc;
 160
 161         res = kcalloc(cell->num_resources, sizeof(*res), GFP_KERNEL);
 162         if (!res)
 163                 goto fail_device;
 164
 165         pdev->dev.parent = parent;
 166         pdev->dev.type = &mfd_dev_type;
 167         pdev->dev.dma_mask = parent->dma_mask;
 168         pdev->dev.dma_parms = parent->dma_parms;
 169         pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;
 170
 171         ret = regulator_bulk_register_supply_alias(
 172                         &pdev->dev, cell->parent_supplies,
 173                         parent, cell->parent_supplies,
 174                         cell->num_parent_supplies);
 175         if (ret < 0)
 176                 goto fail_res;
 177
 178         if (parent->of_node && cell->of_compatible) {
 179                 for_each_child_of_node(parent->of_node, np) {
 180                         if (of_device_is_compatible(np, cell->of_compatible)) {
 181                                 pdev->dev.of_node = np;
 182                                 pdev->dev.fwnode = &np->fwnode;
 183                                 break;
 184                         }
 185                 }
 186         }
 187
 188         mfd_acpi_add_device(cell, pdev);
 189
 190         if (cell->pdata_size) {
 191                 ret = platform_device_add_data(pdev,
 192                                         cell->platform_data, cell->pdata_size);
 193                 if (ret)
 194                         goto fail_alias;
 195         }
 196
 197         if (cell->properties) {
 198                 ret = platform_device_add_properties(pdev, cell->properties);
 199                 if (ret)
 200                         goto fail_alias;
 201         }
 202
 203         ret = mfd_platform_add_cell(pdev, cell, usage_count);
 204         if (ret)
 205                 goto fail_alias;
 206
 207         for (r = 0; r < cell->num_resources; r++) {
 208                 res[r].name = cell->resources[r].name;
 209                 res[r].flags = cell->resources[r].flags;
 210
 211                 /* Find out base to use */
 212                 if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
 213                         res[r].parent = mem_base;
 214                         res[r].start = mem_base->start +
 215                                 cell->resources[r].start;
 216                         res[r].end = mem_base->start +
 217                                 cell->resources[r].end;
 218                 } else if (cell->resources[r].flags & IORESOURCE_IRQ) {
 219                         if (domain) {
 220                                 /* Unable to create mappings for IRQ ranges. */
 221                                 WARN_ON(cell->resources[r].start !=
 222                                         cell->resources[r].end);
 223                                 res[r].start = res[r].end = irq_create_mapping(
 224                                         domain, cell->resources[r].start);
 225                         } else {
 226                                 res[r].start = irq_base +
 227                                         cell->resources[r].start;
 228                                 res[r].end   = irq_base +
 229                                         cell->resources[r].end;
 230                         }
 231                 } else {
 232                         res[r].parent = cell->resources[r].parent;
 233                         res[r].start = cell->resources[r].start;
 234                         res[r].end   = cell->resources[r].end;
 235                 }
 236
 237                 if (!cell->ignore_resource_conflicts) {
 238                         if (has_acpi_companion(&pdev->dev)) {
 239                                 ret = acpi_check_resource_conflict(&res[r]);
 240                                 if (ret)
 241                                         goto fail_alias;
 242                         }
 243                 }
 244         }
 245
 246         ret = platform_device_add_resources(pdev, res, cell->num_resources);
 247         if (ret)
 248                 goto fail_alias;
 249
 250         ret = platform_device_add(pdev);
 251         if (ret)
 252                 goto fail_alias;
 253
 254         if (cell->pm_runtime_no_callbacks)
 255                 pm_runtime_no_callbacks(&pdev->dev);
 256
 257         kfree(res);
 258
 259         return 0;
 260
 261 fail_alias:
 262         regulator_bulk_unregister_supply_alias(&pdev->dev,
 263                                                cell->parent_supplies,
 264                                                cell->num_parent_supplies);
 265 fail_res:
 266         kfree(res);
 267 fail_device:
 268         platform_device_put(pdev);
 269 fail_alloc:
 270         return ret;
 271 }
 272
 273 int mfd_add_devices(struct device *parent, int id,
 274                     const struct mfd_cell *cells, int n_devs,
 275                     struct resource *mem_base,
 276                     int irq_base, struct irq_domain *domain)
 277 {
 278         int i;
 279         int ret;
 280         atomic_t *cnts;
 281
 282         /* initialize reference counting for all cells */
 283         cnts = kcalloc(n_devs, sizeof(*cnts), GFP_KERNEL);
 284         if (!cnts)
 285                 return -ENOMEM;
 286
 287         for (i = 0; i < n_devs; i++) {
 288                 atomic_set(&cnts[i], 0);
 289                 ret = mfd_add_device(parent, id, cells + i, cnts + i, mem_base,
 290                                      irq_base, domain);
 291                 if (ret)
 292                         goto fail;
 293         }
 294
 295         return 0;
 296
 297 fail:
 298         if (i)
 299                 mfd_remove_devices(parent);
 300         else
 301                 kfree(cnts);
 302         return ret;
 303 }
 304 EXPORT_SYMBOL(mfd_add_devices);
 305
 306 static int mfd_remove_devices_fn(struct device *dev, void *c)
 307 {
 308         struct platform_device *pdev;
 309         const struct mfd_cell *cell;
 310         atomic_t **usage_count = c;
 311
 312         if (dev->type != &mfd_dev_type)
 313                 return 0;
 314
 315         pdev = to_platform_device(dev);
 316         cell = mfd_get_cell(pdev);
 317
 318         regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies,
 319                                                cell->num_parent_supplies);
 320
 321         /* find the base address of usage_count pointers (for freeing) */
 322         if (!*usage_count || (cell->usage_count < *usage_count))
 323                 *usage_count = cell->usage_count;
 324
 325         platform_device_unregister(pdev);
 326         return 0;
 327 }
 328
 329 void mfd_remove_devices(struct device *parent)
 330 {
 331         atomic_t *cnts = NULL;
 332
 333         device_for_each_child_reverse(parent, &cnts, mfd_remove_devices_fn);
 334         kfree(cnts);
 335 }
 336 EXPORT_SYMBOL(mfd_remove_devices);
 337
 338 static void devm_mfd_dev_release(struct device *dev, void *res)
 339 {
 340         mfd_remove_devices(dev);
 341 }
 342
 343 /**
 344  * devm_mfd_add_devices - Resource managed version of mfd_add_devices()
 345  *
 346  * Returns 0 on success or an appropriate negative error number on failure.
 347  * All child-devices of the MFD will automatically be removed when it gets
 348  * unbinded.
 349  */
 350 int devm_mfd_add_devices(struct device *dev, int id,
 351                          const struct mfd_cell *cells, int n_devs,
 352                          struct resource *mem_base,
 353                          int irq_base, struct irq_domain *domain)
 354 {
 355         struct device **ptr;
 356         int ret;
 357
 358         ptr = devres_alloc(devm_mfd_dev_release, sizeof(*ptr), GFP_KERNEL);
 359         if (!ptr)
 360                 return -ENOMEM;
 361
 362         ret = mfd_add_devices(dev, id, cells, n_devs, mem_base,
 363                               irq_base, domain);
 364         if (ret < 0) {
 365                 devres_free(ptr);
 366                 return ret;
 367         }
 368
 369         *ptr = dev;
 370         devres_add(dev, ptr);
 371
 372         return ret;
 373 }
 374 EXPORT_SYMBOL(devm_mfd_add_devices);
 375
 376 int mfd_clone_cell(const char *cell, const char **clones, size_t n_clones)
 377 {
 378         struct mfd_cell cell_entry;
 379         struct device *dev;
 380         struct platform_device *pdev;
 381         int i;
 382
 383         /* fetch the parent cell's device (should already be registered!) */
 384         dev = bus_find_device_by_name(&platform_bus_type, NULL, cell);
 385         if (!dev) {
 386                 printk(KERN_ERR "failed to find device for cell %s\n", cell);
 387                 return -ENODEV;
 388         }
 389         pdev = to_platform_device(dev);
 390         memcpy(&cell_entry, mfd_get_cell(pdev), sizeof(cell_entry));
 391
 392         WARN_ON(!cell_entry.enable);
 393
 394         for (i = 0; i < n_clones; i++) {
 395                 cell_entry.name = clones[i];
 396                 /* don't give up if a single call fails; just report error */
 397                 if (mfd_add_device(pdev->dev.parent, -1, &cell_entry,
 398                                    cell_entry.usage_count, NULL, 0, NULL))
 399                         dev_err(dev, "failed to create platform device '%s'\n",
 400                                         clones[i]);
 401         }
 402
 403         put_device(dev);
 404
 405         return 0;
 406 }
 407 EXPORT_SYMBOL(mfd_clone_cell);
 408
 409 MODULE_LICENSE("GPL");
 410 MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");