drivers/mfd/mfd-core.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * drivers/mfd/mfd-core.c
   4  *
   5  * core MFD support
   6  * Copyright (c) 2006 Ian Molton
   7  * Copyright (c) 2007,2008 Dmitry Baryshkov
   8  */
   9
  10 #include <linux/kernel.h>
  11 #include <linux/platform_device.h>
  12 #include <linux/acpi.h>
  13 #include <linux/list.h>
  14 #include <linux/property.h>
  15 #include <linux/mfd/core.h>
  16 #include <linux/pm_runtime.h>
  17 #include <linux/slab.h>
  18 #include <linux/module.h>
  19 #include <linux/irqdomain.h>
  20 #include <linux/of.h>
  21 #include <linux/of_address.h>
  22 #include <linux/regulator/consumer.h>
  23
  24 static LIST_HEAD(mfd_of_node_list);
  25
  26 struct mfd_of_node_entry {
  27         struct list_head list;
  28         struct device *dev;
  29         struct device_node *np;
  30 };
  31
  32 static struct device_type mfd_dev_type = {
  33         .name   = "mfd_device",
  34 };
  35
  36 int mfd_cell_enable(struct platform_device *pdev)
  37 {
  38         const struct mfd_cell *cell = mfd_get_cell(pdev);
  39
  40         if (!cell->enable) {
  41                 dev_dbg(&pdev->dev, "No .enable() call-back registered\n");
  42                 return 0;
  43         }
  44
  45         return cell->enable(pdev);
  46 }
  47 EXPORT_SYMBOL(mfd_cell_enable);
  48
  49 int mfd_cell_disable(struct platform_device *pdev)
  50 {
  51         const struct mfd_cell *cell = mfd_get_cell(pdev);
  52
  53         if (!cell->disable) {
  54                 dev_dbg(&pdev->dev, "No .disable() call-back registered\n");
  55                 return 0;
  56         }
  57
  58         return cell->disable(pdev);
  59 }
  60 EXPORT_SYMBOL(mfd_cell_disable);
  61
  62 #if IS_ENABLED(CONFIG_ACPI)
  63 static void mfd_acpi_add_device(const struct mfd_cell *cell,
  64                                 struct platform_device *pdev)
  65 {
  66         const struct mfd_cell_acpi_match *match = cell->acpi_match;
  67         struct acpi_device *parent, *child;
  68         struct acpi_device *adev;
  69
  70         parent = ACPI_COMPANION(pdev->dev.parent);
  71         if (!parent)
  72                 return;
  73
  74         /*
  75          * MFD child device gets its ACPI handle either from the ACPI device
  76          * directly under the parent that matches the either _HID or _CID, or
  77          * _ADR or it will use the parent handle if is no ID is given.
  78          *
  79          * Note that use of _ADR is a grey area in the ACPI specification,
  80          * though Intel Galileo Gen2 is using it to distinguish the children
  81          * devices.
  82          */
  83         adev = parent;
  84         if (match) {
  85                 if (match->pnpid) {
  86                         struct acpi_device_id ids[2] = {};
  87
  88                         strlcpy(ids[0].id, match->pnpid, sizeof(ids[0].id));
  89                         list_for_each_entry(child, &parent->children, node) {
  90                                 if (!acpi_match_device_ids(child, ids)) {
  91                                         adev = child;
  92                                         break;
  93                                 }
  94                         }
  95                 } else {
  96                         unsigned long long adr;
  97                         acpi_status status;
  98
  99                         list_for_each_entry(child, &parent->children, node) {
 100                                 status = acpi_evaluate_integer(child->handle,
 101                                                                "_ADR", NULL,
 102                                                                &adr);
 103                                 if (ACPI_SUCCESS(status) && match->adr == adr) {
 104                                         adev = child;
 105                                         break;
 106                                 }
 107                         }
 108                 }
 109         }
 110
 111         ACPI_COMPANION_SET(&pdev->dev, adev);
 112 }
 113 #else
 114 static inline void mfd_acpi_add_device(const struct mfd_cell *cell,
 115                                        struct platform_device *pdev)
 116 {
 117 }
 118 #endif
 119
 120 static int mfd_match_of_node_to_dev(struct platform_device *pdev,
 121                                     struct device_node *np,
 122                                     const struct mfd_cell *cell)
 123 {
 124 #if IS_ENABLED(CONFIG_OF)
 125         struct mfd_of_node_entry *of_entry;
 126         const __be32 *reg;
 127         u64 of_node_addr;
 128
 129         /* Skip if OF node has previously been allocated to a device */
 130         list_for_each_entry(of_entry, &mfd_of_node_list, list)
 131                 if (of_entry->np == np)
 132                         return -EAGAIN;
 133
 134         if (!cell->use_of_reg)
 135                 /* No of_reg defined - allocate first free compatible match */
 136                 goto allocate_of_node;
 137
 138         /* We only care about each node's first defined address */
 139         reg = of_get_address(np, 0, NULL, NULL);
 140         if (!reg)
 141                 /* OF node does not contatin a 'reg' property to match to */
 142                 return -EAGAIN;
 143
 144         of_node_addr = of_read_number(reg, of_n_addr_cells(np));
 145
 146         if (cell->of_reg != of_node_addr)
 147                 /* No match */
 148                 return -EAGAIN;
 149
 150 allocate_of_node:
 151         of_entry = kzalloc(sizeof(*of_entry), GFP_KERNEL);
 152         if (!of_entry)
 153                 return -ENOMEM;
 154
 155         of_entry->dev = &pdev->dev;
 156         of_entry->np = np;
 157         list_add_tail(&of_entry->list, &mfd_of_node_list);
 158
 159         pdev->dev.of_node = np;
 160         pdev->dev.fwnode = &np->fwnode;
 161 #endif
 162         return 0;
 163 }
 164
 165 static int mfd_add_device(struct device *parent, int id,
 166                           const struct mfd_cell *cell,
 167                           struct resource *mem_base,
 168                           int irq_base, struct irq_domain *domain)
 169 {
 170         struct resource *res;
 171         struct platform_device *pdev;
 172         struct device_node *np = NULL;
 173         struct mfd_of_node_entry *of_entry, *tmp;
 174         bool disabled = false;
 175         int ret = -ENOMEM;
 176         int platform_id;
 177         int r;
 178
 179         if (id == PLATFORM_DEVID_AUTO)
 180                 platform_id = id;
 181         else
 182                 platform_id = id + cell->id;
 183
 184         pdev = platform_device_alloc(cell->name, platform_id);
 185         if (!pdev)
 186                 goto fail_alloc;
 187
 188         pdev->mfd_cell = kmemdup(cell, sizeof(*cell), GFP_KERNEL);
 189         if (!pdev->mfd_cell)
 190                 goto fail_device;
 191
 192         res = kcalloc(cell->num_resources, sizeof(*res), GFP_KERNEL);
 193         if (!res)
 194                 goto fail_device;
 195
 196         pdev->dev.parent = parent;
 197         pdev->dev.type = &mfd_dev_type;
 198         pdev->dev.dma_mask = parent->dma_mask;
 199         pdev->dev.dma_parms = parent->dma_parms;
 200         pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;
 201
 202         ret = regulator_bulk_register_supply_alias(
 203                         &pdev->dev, cell->parent_supplies,
 204                         parent, cell->parent_supplies,
 205                         cell->num_parent_supplies);
 206         if (ret < 0)
 207                 goto fail_res;
 208
 209         if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
 210                 for_each_child_of_node(parent->of_node, np) {
 211                         if (of_device_is_compatible(np, cell->of_compatible)) {
 212                                 /* Skip 'disabled' devices */
 213                                 if (!of_device_is_available(np)) {
 214                                         disabled = true;
 215                                         continue;
 216                                 }
 217
 218                                 ret = mfd_match_of_node_to_dev(pdev, np, cell);
 219                                 if (ret == -EAGAIN)
 220                                         continue;
 221                                 of_node_put(np);
 222                                 if (ret)
 223                                         goto fail_alias;
 224
 225                                 goto match;
 226                         }
 227                 }
 228
 229                 if (disabled) {
 230                         /* Ignore 'disabled' devices error free */
 231                         ret = 0;
 232                         goto fail_alias;
 233                 }
 234
 235 match:
 236                 if (!pdev->dev.of_node)
 237                         pr_warn("%s: Failed to locate of_node [id: %d]\n",
 238                                 cell->name, platform_id);
 239         }
 240
 241         mfd_acpi_add_device(cell, pdev);
 242
 243         if (cell->pdata_size) {
 244                 ret = platform_device_add_data(pdev,
 245                                         cell->platform_data, cell->pdata_size);
 246                 if (ret)
 247                         goto fail_of_entry;
 248         }
 249
 250         if (cell->properties) {
 251                 ret = platform_device_add_properties(pdev, cell->properties);
 252                 if (ret)
 253                         goto fail_of_entry;
 254         }
 255
 256         for (r = 0; r < cell->num_resources; r++) {
 257                 res[r].name = cell->resources[r].name;
 258                 res[r].flags = cell->resources[r].flags;
 259
 260                 /* Find out base to use */
 261                 if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
 262                         res[r].parent = mem_base;
 263                         res[r].start = mem_base->start +
 264                                 cell->resources[r].start;
 265                         res[r].end = mem_base->start +
 266                                 cell->resources[r].end;
 267                 } else if (cell->resources[r].flags & IORESOURCE_IRQ) {
 268                         if (domain) {
 269                                 /* Unable to create mappings for IRQ ranges. */
 270                                 WARN_ON(cell->resources[r].start !=
 271                                         cell->resources[r].end);
 272                                 res[r].start = res[r].end = irq_create_mapping(
 273                                         domain, cell->resources[r].start);
 274                         } else {
 275                                 res[r].start = irq_base +
 276                                         cell->resources[r].start;
 277                                 res[r].end   = irq_base +
 278                                         cell->resources[r].end;
 279                         }
 280                 } else {
 281                         res[r].parent = cell->resources[r].parent;
 282                         res[r].start = cell->resources[r].start;
 283                         res[r].end   = cell->resources[r].end;
 284                 }
 285
 286                 if (!cell->ignore_resource_conflicts) {
 287                         if (has_acpi_companion(&pdev->dev)) {
 288                                 ret = acpi_check_resource_conflict(&res[r]);
 289                                 if (ret)
 290                                         goto fail_of_entry;
 291                         }
 292                 }
 293         }
 294
 295         ret = platform_device_add_resources(pdev, res, cell->num_resources);
 296         if (ret)
 297                 goto fail_of_entry;
 298
 299         ret = platform_device_add(pdev);
 300         if (ret)
 301                 goto fail_of_entry;
 302
 303         if (cell->pm_runtime_no_callbacks)
 304                 pm_runtime_no_callbacks(&pdev->dev);
 305
 306         kfree(res);
 307
 308         return 0;
 309
 310 fail_of_entry:
 311         list_for_each_entry_safe(of_entry, tmp, &mfd_of_node_list, list)
 312                 if (of_entry->dev == &pdev->dev) {
 313                         list_del(&of_entry->list);
 314                         kfree(of_entry);
 315                 }
 316 fail_alias:
 317         regulator_bulk_unregister_supply_alias(&pdev->dev,
 318                                                cell->parent_supplies,
 319                                                cell->num_parent_supplies);
 320 fail_res:
 321         kfree(res);
 322 fail_device:
 323         platform_device_put(pdev);
 324 fail_alloc:
 325         return ret;
 326 }
 327
 328 /**
 329  * mfd_add_devices - register child devices
 330  *
 331  * @parent:     Pointer to parent device.
 332  * @id:         Can be PLATFORM_DEVID_AUTO to let the Platform API take care
 333  *              of device numbering, or will be added to a device's cell_id.
 334  * @cells:      Array of (struct mfd_cell)s describing child devices.
 335  * @n_devs:     Number of child devices to register.
 336  * @mem_base:   Parent register range resource for child devices.
 337  * @irq_base:   Base of the range of virtual interrupt numbers allocated for
 338  *              this MFD device. Unused if @domain is specified.
 339  * @domain:     Interrupt domain to create mappings for hardware interrupts.
 340  */
 341 int mfd_add_devices(struct device *parent, int id,
 342                     const struct mfd_cell *cells, int n_devs,
 343                     struct resource *mem_base,
 344                     int irq_base, struct irq_domain *domain)
 345 {
 346         int i;
 347         int ret;
 348
 349         for (i = 0; i < n_devs; i++) {
 350                 ret = mfd_add_device(parent, id, cells + i, mem_base,
 351                                      irq_base, domain);
 352                 if (ret)
 353                         goto fail;
 354         }
 355
 356         return 0;
 357
 358 fail:
 359         if (i)
 360                 mfd_remove_devices(parent);
 361
 362         return ret;
 363 }
 364 EXPORT_SYMBOL(mfd_add_devices);
 365
 366 static int mfd_remove_devices_fn(struct device *dev, void *data)
 367 {
 368         struct platform_device *pdev;
 369         const struct mfd_cell *cell;
 370         int *level = data;
 371
 372         if (dev->type != &mfd_dev_type)
 373                 return 0;
 374
 375         pdev = to_platform_device(dev);
 376         cell = mfd_get_cell(pdev);
 377
 378         if (level && cell->level > *level)
 379                 return 0;
 380
 381         regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies,
 382                                                cell->num_parent_supplies);
 383
 384         platform_device_unregister(pdev);
 385         return 0;
 386 }
 387
 388 void mfd_remove_devices_late(struct device *parent)
 389 {
 390         int level = MFD_DEP_LEVEL_HIGH;
 391
 392         device_for_each_child_reverse(parent, &level, mfd_remove_devices_fn);
 393 }
 394 EXPORT_SYMBOL(mfd_remove_devices_late);
 395
 396 void mfd_remove_devices(struct device *parent)
 397 {
 398         int level = MFD_DEP_LEVEL_NORMAL;
 399
 400         device_for_each_child_reverse(parent, &level, mfd_remove_devices_fn);
 401 }
 402 EXPORT_SYMBOL(mfd_remove_devices);
 403
 404 static void devm_mfd_dev_release(struct device *dev, void *res)
 405 {
 406         mfd_remove_devices(dev);
 407 }
 408
 409 /**
 410  * devm_mfd_add_devices - Resource managed version of mfd_add_devices()
 411  *
 412  * Returns 0 on success or an appropriate negative error number on failure.
 413  * All child-devices of the MFD will automatically be removed when it gets
 414  * unbinded.
 415  *
 416  * @dev:        Pointer to parent device.
 417  * @id:         Can be PLATFORM_DEVID_AUTO to let the Platform API take care
 418  *              of device numbering, or will be added to a device's cell_id.
 419  * @cells:      Array of (struct mfd_cell)s describing child devices.
 420  * @n_devs:     Number of child devices to register.
 421  * @mem_base:   Parent register range resource for child devices.
 422  * @irq_base:   Base of the range of virtual interrupt numbers allocated for
 423  *              this MFD device. Unused if @domain is specified.
 424  * @domain:     Interrupt domain to create mappings for hardware interrupts.
 425  */
 426 int devm_mfd_add_devices(struct device *dev, int id,
 427                          const struct mfd_cell *cells, int n_devs,
 428                          struct resource *mem_base,
 429                          int irq_base, struct irq_domain *domain)
 430 {
 431         struct device **ptr;
 432         int ret;
 433
 434         ptr = devres_alloc(devm_mfd_dev_release, sizeof(*ptr), GFP_KERNEL);
 435         if (!ptr)
 436                 return -ENOMEM;
 437
 438         ret = mfd_add_devices(dev, id, cells, n_devs, mem_base,
 439                               irq_base, domain);
 440         if (ret < 0) {
 441                 devres_free(ptr);
 442                 return ret;
 443         }
 444
 445         *ptr = dev;
 446         devres_add(dev, ptr);
 447
 448         return ret;
 449 }
 450 EXPORT_SYMBOL(devm_mfd_add_devices);
 451
 452 MODULE_LICENSE("GPL");
 453 MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");