Documentation/driver-model/devres.txt

   1 Devres - Managed Device Resource
   2 ================================
   3
   4 Tejun Heo       <teheo@suse.de>
   5
   6 First draft     10 January 2007
   7
   8
   9 1. Intro                        : Huh? Devres?
  10 2. Devres                       : Devres in a nutshell
  11 3. Devres Group                 : Group devres'es and release them together
  12 4. Details                      : Life time rules, calling context, ...
  13 5. Overhead                     : How much do we have to pay for this?
  14 6. List of managed interfaces   : Currently implemented managed interfaces
  15
  16
  17   1. Intro
  18   --------
  19
  20 devres came up while trying to convert libata to use iomap.  Each
  21 iomapped address should be kept and unmapped on driver detach.  For
  22 example, a plain SFF ATA controller (that is, good old PCI IDE) in
  23 native mode makes use of 5 PCI BARs and all of them should be
  24 maintained.
  25
  26 As with many other device drivers, libata low level drivers have
  27 sufficient bugs in ->remove and ->probe failure path.  Well, yes,
  28 that's probably because libata low level driver developers are lazy
  29 bunch, but aren't all low level driver developers?  After spending a
  30 day fiddling with braindamaged hardware with no document or
  31 braindamaged document, if it's finally working, well, it's working.
  32
  33 For one reason or another, low level drivers don't receive as much
  34 attention or testing as core code, and bugs on driver detach or
  35 initialization failure don't happen often enough to be noticeable.
  36 Init failure path is worse because it's much less travelled while
  37 needs to handle multiple entry points.
  38
  39 So, many low level drivers end up leaking resources on driver detach
  40 and having half broken failure path implementation in ->probe() which
  41 would leak resources or even cause oops when failure occurs.  iomap
  42 adds more to this mix.  So do msi and msix.
  43
  44
  45   2. Devres
  46   ---------
  47
  48 devres is basically linked list of arbitrarily sized memory areas
  49 associated with a struct device.  Each devres entry is associated with
  50 a release function.  A devres can be released in several ways.  No
  51 matter what, all devres entries are released on driver detach.  On
  52 release, the associated release function is invoked and then the
  53 devres entry is freed.
  54
  55 Managed interface is created for resources commonly used by device
  56 drivers using devres.  For example, coherent DMA memory is acquired
  57 using dma_alloc_coherent().  The managed version is called
  58 dmam_alloc_coherent().  It is identical to dma_alloc_coherent() except
  59 for the DMA memory allocated using it is managed and will be
  60 automatically released on driver detach.  Implementation looks like
  61 the following.
  62
  63   struct dma_devres {
  64         size_t          size;
  65         void            *vaddr;
  66         dma_addr_t      dma_handle;
  67   };
  68
  69   static void dmam_coherent_release(struct device *dev, void *res)
  70   {
  71         struct dma_devres *this = res;
  72
  73         dma_free_coherent(dev, this->size, this->vaddr, this->dma_handle);
  74   }
  75
  76   dmam_alloc_coherent(dev, size, dma_handle, gfp)
  77   {
  78         struct dma_devres *dr;
  79         void *vaddr;
  80
  81         dr = devres_alloc(dmam_coherent_release, sizeof(*dr), gfp);
  82         ...
  83
  84         /* alloc DMA memory as usual */
  85         vaddr = dma_alloc_coherent(...);
  86         ...
  87
  88         /* record size, vaddr, dma_handle in dr */
  89         dr->vaddr = vaddr;
  90         ...
  91
  92         devres_add(dev, dr);
  93
  94         return vaddr;
  95   }
  96
  97 If a driver uses dmam_alloc_coherent(), the area is guaranteed to be
  98 freed whether initialization fails half-way or the device gets
  99 detached.  If most resources are acquired using managed interface, a
 100 driver can have much simpler init and exit code.  Init path basically
 101 looks like the following.
 102
 103   my_init_one()
 104   {
 105         struct mydev *d;
 106
 107         d = devm_kzalloc(dev, sizeof(*d), GFP_KERNEL);
 108         if (!d)
 109                 return -ENOMEM;
 110
 111         d->ring = dmam_alloc_coherent(...);
 112         if (!d->ring)
 113                 return -ENOMEM;
 114
 115         if (check something)
 116                 return -EINVAL;
 117         ...
 118
 119         return register_to_upper_layer(d);
 120   }
 121
 122 And exit path,
 123
 124   my_remove_one()
 125   {
 126         unregister_from_upper_layer(d);
 127         shutdown_my_hardware();
 128   }
 129
 130 As shown above, low level drivers can be simplified a lot by using
 131 devres.  Complexity is shifted from less maintained low level drivers
 132 to better maintained higher layer.  Also, as init failure path is
 133 shared with exit path, both can get more testing.
 134
 135 Note though that when converting current calls or assignments to
 136 managed devm_* versions it is up to you to check if internal operations
 137 like allocating memory, have failed. Managed resources pertains to the
 138 freeing of these resources *only* - all other checks needed are still
 139 on you. In some cases this may mean introducing checks that were not
 140 necessary before moving to the managed devm_* calls.
 141
 142
 143   3. Devres group
 144   ---------------
 145
 146 Devres entries can be grouped using devres group.  When a group is
 147 released, all contained normal devres entries and properly nested
 148 groups are released.  One usage is to rollback series of acquired
 149 resources on failure.  For example,
 150
 151   if (!devres_open_group(dev, NULL, GFP_KERNEL))
 152         return -ENOMEM;
 153
 154   acquire A;
 155   if (failed)
 156         goto err;
 157
 158   acquire B;
 159   if (failed)
 160         goto err;
 161   ...
 162
 163   devres_remove_group(dev, NULL);
 164   return 0;
 165
 166  err:
 167   devres_release_group(dev, NULL);
 168   return err_code;
 169
 170 As resource acquisition failure usually means probe failure, constructs
 171 like above are usually useful in midlayer driver (e.g. libata core
 172 layer) where interface function shouldn't have side effect on failure.
 173 For LLDs, just returning error code suffices in most cases.
 174
 175 Each group is identified by void *id.  It can either be explicitly
 176 specified by @id argument to devres_open_group() or automatically
 177 created by passing NULL as @id as in the above example.  In both
 178 cases, devres_open_group() returns the group's id.  The returned id
 179 can be passed to other devres functions to select the target group.
 180 If NULL is given to those functions, the latest open group is
 181 selected.
 182
 183 For example, you can do something like the following.
 184
 185   int my_midlayer_create_something()
 186   {
 187         if (!devres_open_group(dev, my_midlayer_create_something, GFP_KERNEL))
 188                 return -ENOMEM;
 189
 190         ...
 191
 192         devres_close_group(dev, my_midlayer_create_something);
 193         return 0;
 194   }
 195
 196   void my_midlayer_destroy_something()
 197   {
 198         devres_release_group(dev, my_midlayer_create_something);
 199   }
 200
 201
 202   4. Details
 203   ----------
 204
 205 Lifetime of a devres entry begins on devres allocation and finishes
 206 when it is released or destroyed (removed and freed) - no reference
 207 counting.
 208
 209 devres core guarantees atomicity to all basic devres operations and
 210 has support for single-instance devres types (atomic
 211 lookup-and-add-if-not-found).  Other than that, synchronizing
 212 concurrent accesses to allocated devres data is caller's
 213 responsibility.  This is usually non-issue because bus ops and
 214 resource allocations already do the job.
 215
 216 For an example of single-instance devres type, read pcim_iomap_table()
 217 in lib/devres.c.
 218
 219 All devres interface functions can be called without context if the
 220 right gfp mask is given.
 221
 222
 223   5. Overhead
 224   -----------
 225
 226 Each devres bookkeeping info is allocated together with requested data
 227 area.  With debug option turned off, bookkeeping info occupies 16
 228 bytes on 32bit machines and 24 bytes on 64bit (three pointers rounded
 229 up to ull alignment).  If singly linked list is used, it can be
 230 reduced to two pointers (8 bytes on 32bit, 16 bytes on 64bit).
 231
 232 Each devres group occupies 8 pointers.  It can be reduced to 6 if
 233 singly linked list is used.
 234
 235 Memory space overhead on ahci controller with two ports is between 300
 236 and 400 bytes on 32bit machine after naive conversion (we can
 237 certainly invest a bit more effort into libata core layer).
 238
 239
 240   6. List of managed interfaces
 241   -----------------------------
 242
 243 CLOCK
 244   devm_clk_get()
 245   devm_clk_put()
 246   devm_clk_hw_register()
 247   devm_of_clk_add_hw_provider()
 248
 249 DMA
 250   dmaenginem_async_device_register()
 251   dmam_alloc_coherent()
 252   dmam_alloc_attrs()
 253   dmam_free_coherent()
 254   dmam_pool_create()
 255   dmam_pool_destroy()
 256
 257 DRM
 258   devm_drm_dev_init()
 259
 260 GPIO
 261   devm_gpiod_get()
 262   devm_gpiod_get_index()
 263   devm_gpiod_get_index_optional()
 264   devm_gpiod_get_optional()
 265   devm_gpiod_put()
 266   devm_gpiod_unhinge()
 267   devm_gpiochip_add_data()
 268   devm_gpio_request()
 269   devm_gpio_request_one()
 270   devm_gpio_free()
 271
 272 IIO
 273   devm_iio_device_alloc()
 274   devm_iio_device_free()
 275   devm_iio_device_register()
 276   devm_iio_device_unregister()
 277   devm_iio_kfifo_allocate()
 278   devm_iio_kfifo_free()
 279   devm_iio_triggered_buffer_setup()
 280   devm_iio_triggered_buffer_cleanup()
 281   devm_iio_trigger_alloc()
 282   devm_iio_trigger_free()
 283   devm_iio_trigger_register()
 284   devm_iio_trigger_unregister()
 285   devm_iio_channel_get()
 286   devm_iio_channel_release()
 287   devm_iio_channel_get_all()
 288   devm_iio_channel_release_all()
 289
 290 INPUT
 291   devm_input_allocate_device()
 292
 293 IO region
 294   devm_release_mem_region()
 295   devm_release_region()
 296   devm_release_resource()
 297   devm_request_mem_region()
 298   devm_request_region()
 299   devm_request_resource()
 300
 301 IOMAP
 302   devm_ioport_map()
 303   devm_ioport_unmap()
 304   devm_ioremap()
 305   devm_ioremap_nocache()
 306   devm_ioremap_wc()
 307   devm_ioremap_resource() : checks resource, requests memory region, ioremaps
 308   devm_iounmap()
 309   pcim_iomap()
 310   pcim_iomap_regions()  : do request_region() and iomap() on multiple BARs
 311   pcim_iomap_table()    : array of mapped addresses indexed by BAR
 312   pcim_iounmap()
 313
 314 IRQ
 315   devm_free_irq()
 316   devm_request_any_context_irq()
 317   devm_request_irq()
 318   devm_request_threaded_irq()
 319   devm_irq_alloc_descs()
 320   devm_irq_alloc_desc()
 321   devm_irq_alloc_desc_at()
 322   devm_irq_alloc_desc_from()
 323   devm_irq_alloc_descs_from()
 324   devm_irq_alloc_generic_chip()
 325   devm_irq_setup_generic_chip()
 326   devm_irq_sim_init()
 327
 328 LED
 329   devm_led_classdev_register()
 330   devm_led_classdev_unregister()
 331
 332 MDIO
 333   devm_mdiobus_alloc()
 334   devm_mdiobus_alloc_size()
 335   devm_mdiobus_free()
 336
 337 MEM
 338   devm_free_pages()
 339   devm_get_free_pages()
 340   devm_kasprintf()
 341   devm_kcalloc()
 342   devm_kfree()
 343   devm_kmalloc()
 344   devm_kmalloc_array()
 345   devm_kmemdup()
 346   devm_kstrdup()
 347   devm_kvasprintf()
 348   devm_kzalloc()
 349
 350 MFD
 351   devm_mfd_add_devices()
 352
 353 MUX
 354   devm_mux_chip_alloc()
 355   devm_mux_chip_register()
 356   devm_mux_control_get()
 357
 358 PER-CPU MEM
 359   devm_alloc_percpu()
 360   devm_free_percpu()
 361
 362 PCI
 363   devm_pci_alloc_host_bridge()  : managed PCI host bridge allocation
 364   devm_pci_remap_cfgspace()     : ioremap PCI configuration space
 365   devm_pci_remap_cfg_resource() : ioremap PCI configuration space resource
 366   pcim_enable_device()          : after success, all PCI ops become managed
 367   pcim_pin_device()             : keep PCI device enabled after release
 368
 369 PHY
 370   devm_usb_get_phy()
 371   devm_usb_put_phy()
 372
 373 PINCTRL
 374   devm_pinctrl_get()
 375   devm_pinctrl_put()
 376   devm_pinctrl_register()
 377   devm_pinctrl_unregister()
 378
 379 POWER
 380   devm_reboot_mode_register()
 381   devm_reboot_mode_unregister()
 382
 383 PWM
 384   devm_pwm_get()
 385   devm_pwm_put()
 386
 387 REGULATOR
 388   devm_regulator_bulk_get()
 389   devm_regulator_get()
 390   devm_regulator_put()
 391   devm_regulator_register()
 392
 393 RESET
 394   devm_reset_control_get()
 395   devm_reset_controller_register()
 396
 397 SERDEV
 398   devm_serdev_device_open()
 399
 400 SLAVE DMA ENGINE
 401   devm_acpi_dma_controller_register()
 402
 403 SPI
 404   devm_spi_register_master()
 405
 406 WATCHDOG
 407   devm_watchdog_register_device()