GNU Linux-libre 4.19.211-gnu1
[releases.git] / Documentation / driver-api / device_link.rst
1 .. |struct dev_pm_domain| replace:: :c:type:`struct dev_pm_domain <dev_pm_domain>`
2 .. |struct generic_pm_domain| replace:: :c:type:`struct generic_pm_domain <generic_pm_domain>`
3
4 ============
5 Device links
6 ============
7
8 By default, the driver core only enforces dependencies between devices
9 that are borne out of a parent/child relationship within the device
10 hierarchy: When suspending, resuming or shutting down the system, devices
11 are ordered based on this relationship, i.e. children are always suspended
12 before their parent, and the parent is always resumed before its children.
13
14 Sometimes there is a need to represent device dependencies beyond the
15 mere parent/child relationship, e.g. between siblings, and have the
16 driver core automatically take care of them.
17
18 Secondly, the driver core by default does not enforce any driver presence
19 dependencies, i.e. that one device must be bound to a driver before
20 another one can probe or function correctly.
21
22 Often these two dependency types come together, so a device depends on
23 another one both with regards to driver presence *and* with regards to
24 suspend/resume and shutdown ordering.
25
26 Device links allow representation of such dependencies in the driver core.
27
28 In its standard or *managed* form, a device link combines *both* dependency
29 types:  It guarantees correct suspend/resume and shutdown ordering between a
30 "supplier" device and its "consumer" devices, and it guarantees driver
31 presence on the supplier.  The consumer devices are not probed before the
32 supplier is bound to a driver, and they're unbound before the supplier
33 is unbound.
34
35 When driver presence on the supplier is irrelevant and only correct
36 suspend/resume and shutdown ordering is needed, the device link may
37 simply be set up with the ``DL_FLAG_STATELESS`` flag.  In other words,
38 enforcing driver presence on the supplier is optional.
39
40 Another optional feature is runtime PM integration:  By setting the
41 ``DL_FLAG_PM_RUNTIME`` flag on addition of the device link, the PM core
42 is instructed to runtime resume the supplier and keep it active
43 whenever and for as long as the consumer is runtime resumed.
44
45 Usage
46 =====
47
48 The earliest point in time when device links can be added is after
49 :c:func:`device_add()` has been called for the supplier and
50 :c:func:`device_initialize()` has been called for the consumer.
51
52 It is legal to add them later, but care must be taken that the system
53 remains in a consistent state:  E.g. a device link cannot be added in
54 the midst of a suspend/resume transition, so either commencement of
55 such a transition needs to be prevented with :c:func:`lock_system_sleep()`,
56 or the device link needs to be added from a function which is guaranteed
57 not to run in parallel to a suspend/resume transition, such as from a
58 device ``->probe`` callback or a boot-time PCI quirk.
59
60 Another example for an inconsistent state would be a device link that
61 represents a driver presence dependency, yet is added from the consumer's
62 ``->probe`` callback while the supplier hasn't started to probe yet:  Had the
63 driver core known about the device link earlier, it wouldn't have probed the
64 consumer in the first place.  The onus is thus on the consumer to check
65 presence of the supplier after adding the link, and defer probing on
66 non-presence.  [Note that it is valid to create a link from the consumer's
67 ``->probe`` callback while the supplier is still probing, but the consumer must
68 know that the supplier is functional already at the link creation time (that is
69 the case, for instance, if the consumer has just acquired some resources that
70 would not have been available had the supplier not been functional then).]
71
72 If a device link with ``DL_FLAG_STATELESS`` set (i.e. a stateless device link)
73 is added in the ``->probe`` callback of the supplier or consumer driver, it is
74 typically deleted in its ``->remove`` callback for symmetry.  That way, if the
75 driver is compiled as a module, the device link is added on module load and
76 orderly deleted on unload.  The same restrictions that apply to device link
77 addition (e.g. exclusion of a parallel suspend/resume transition) apply equally
78 to deletion.  Device links managed by the driver core are deleted automatically
79 by it.
80
81 Several flags may be specified on device link addition, two of which
82 have already been mentioned above:  ``DL_FLAG_STATELESS`` to express that no
83 driver presence dependency is needed (but only correct suspend/resume and
84 shutdown ordering) and ``DL_FLAG_PM_RUNTIME`` to express that runtime PM
85 integration is desired.
86
87 Two other flags are specifically targeted at use cases where the device
88 link is added from the consumer's ``->probe`` callback:  ``DL_FLAG_RPM_ACTIVE``
89 can be specified to runtime resume the supplier upon addition of the
90 device link.  ``DL_FLAG_AUTOREMOVE_CONSUMER`` causes the device link to be
91 automatically purged when the consumer fails to probe or later unbinds.
92
93 Similarly, when the device link is added from supplier's ``->probe`` callback,
94 ``DL_FLAG_AUTOREMOVE_SUPPLIER`` causes the device link to be automatically
95 purged when the supplier fails to probe or later unbinds.
96
97 If neither ``DL_FLAG_AUTOREMOVE_CONSUMER`` nor ``DL_FLAG_AUTOREMOVE_SUPPLIER``
98 is set, ``DL_FLAG_AUTOPROBE_CONSUMER`` can be used to request the driver core
99 to probe for a driver for the consumer driver on the link automatically after
100 a driver has been bound to the supplier device.
101
102 Note, however, that any combinations of ``DL_FLAG_AUTOREMOVE_CONSUMER``,
103 ``DL_FLAG_AUTOREMOVE_SUPPLIER`` or ``DL_FLAG_AUTOPROBE_CONSUMER`` with
104 ``DL_FLAG_STATELESS`` are invalid and cannot be used.
105
106 Limitations
107 ===========
108
109 Driver authors should be aware that a driver presence dependency for managed
110 device links (i.e. when ``DL_FLAG_STATELESS`` is not specified on link addition)
111 may cause probing of the consumer to be deferred indefinitely.  This can become
112 a problem if the consumer is required to probe before a certain initcall level
113 is reached.  Worse, if the supplier driver is blacklisted or missing, the
114 consumer will never be probed.
115
116 Moreover, managed device links cannot be deleted directly.  They are deleted
117 by the driver core when they are not necessary any more in accordance with the
118 ``DL_FLAG_AUTOREMOVE_CONSUMER`` and ``DL_FLAG_AUTOREMOVE_SUPPLIER`` flags.
119 However, stateless device links (i.e. device links with ``DL_FLAG_STATELESS``
120 set) are expected to be removed by whoever called :c:func:`device_link_add()`
121 to add them with the help of either :c:func:`device_link_del()` or
122 :c:func:`device_link_remove()`.
123
124 Sometimes drivers depend on optional resources.  They are able to operate
125 in a degraded mode (reduced feature set or performance) when those resources
126 are not present.  An example is an SPI controller that can use a DMA engine
127 or work in PIO mode.  The controller can determine presence of the optional
128 resources at probe time but on non-presence there is no way to know whether
129 they will become available in the near future (due to a supplier driver
130 probing) or never.  Consequently it cannot be determined whether to defer
131 probing or not.  It would be possible to notify drivers when optional
132 resources become available after probing, but it would come at a high cost
133 for drivers as switching between modes of operation at runtime based on the
134 availability of such resources would be much more complex than a mechanism
135 based on probe deferral.  In any case optional resources are beyond the
136 scope of device links.
137
138 Examples
139 ========
140
141 * An MMU device exists alongside a busmaster device, both are in the same
142   power domain.  The MMU implements DMA address translation for the busmaster
143   device and shall be runtime resumed and kept active whenever and as long
144   as the busmaster device is active.  The busmaster device's driver shall
145   not bind before the MMU is bound.  To achieve this, a device link with
146   runtime PM integration is added from the busmaster device (consumer)
147   to the MMU device (supplier).  The effect with regards to runtime PM
148   is the same as if the MMU was the parent of the master device.
149
150   The fact that both devices share the same power domain would normally
151   suggest usage of a |struct dev_pm_domain| or |struct generic_pm_domain|,
152   however these are not independent devices that happen to share a power
153   switch, but rather the MMU device serves the busmaster device and is
154   useless without it.  A device link creates a synthetic hierarchical
155   relationship between the devices and is thus more apt.
156
157 * A Thunderbolt host controller comprises a number of PCIe hotplug ports
158   and an NHI device to manage the PCIe switch.  On resume from system sleep,
159   the NHI device needs to re-establish PCI tunnels to attached devices
160   before the hotplug ports can resume.  If the hotplug ports were children
161   of the NHI, this resume order would automatically be enforced by the
162   PM core, but unfortunately they're aunts.  The solution is to add
163   device links from the hotplug ports (consumers) to the NHI device
164   (supplier).  A driver presence dependency is not necessary for this
165   use case.
166
167 * Discrete GPUs in hybrid graphics laptops often feature an HDA controller
168   for HDMI/DP audio.  In the device hierarchy the HDA controller is a sibling
169   of the VGA device, yet both share the same power domain and the HDA
170   controller is only ever needed when an HDMI/DP display is attached to the
171   VGA device.  A device link from the HDA controller (consumer) to the
172   VGA device (supplier) aptly represents this relationship.
173
174 * ACPI allows definition of a device start order by way of _DEP objects.
175   A classical example is when ACPI power management methods on one device
176   are implemented in terms of I\ :sup:`2`\ C accesses and require a specific
177   I\ :sup:`2`\ C controller to be present and functional for the power
178   management of the device in question to work.
179
180 * In some SoCs a functional dependency exists from display, video codec and
181   video processing IP cores on transparent memory access IP cores that handle
182   burst access and compression/decompression.
183
184 Alternatives
185 ============
186
187 * A |struct dev_pm_domain| can be used to override the bus,
188   class or device type callbacks.  It is intended for devices sharing
189   a single on/off switch, however it does not guarantee a specific
190   suspend/resume ordering, this needs to be implemented separately.
191   It also does not by itself track the runtime PM status of the involved
192   devices and turn off the power switch only when all of them are runtime
193   suspended.  Furthermore it cannot be used to enforce a specific shutdown
194   ordering or a driver presence dependency.
195
196 * A |struct generic_pm_domain| is a lot more heavyweight than a
197   device link and does not allow for shutdown ordering or driver presence
198   dependencies.  It also cannot be used on ACPI systems.
199
200 Implementation
201 ==============
202
203 The device hierarchy, which -- as the name implies -- is a tree,
204 becomes a directed acyclic graph once device links are added.
205
206 Ordering of these devices during suspend/resume is determined by the
207 dpm_list.  During shutdown it is determined by the devices_kset.  With
208 no device links present, the two lists are a flattened, one-dimensional
209 representations of the device tree such that a device is placed behind
210 all its ancestors.  That is achieved by traversing the ACPI namespace
211 or OpenFirmware device tree top-down and appending devices to the lists
212 as they are discovered.
213
214 Once device links are added, the lists need to satisfy the additional
215 constraint that a device is placed behind all its suppliers, recursively.
216 To ensure this, upon addition of the device link the consumer and the
217 entire sub-graph below it (all children and consumers of the consumer)
218 are moved to the end of the list.  (Call to :c:func:`device_reorder_to_tail()`
219 from :c:func:`device_link_add()`.)
220
221 To prevent introduction of dependency loops into the graph, it is
222 verified upon device link addition that the supplier is not dependent
223 on the consumer or any children or consumers of the consumer.
224 (Call to :c:func:`device_is_dependent()` from :c:func:`device_link_add()`.)
225 If that constraint is violated, :c:func:`device_link_add()` will return
226 ``NULL`` and a ``WARNING`` will be logged.
227
228 Notably this also prevents the addition of a device link from a parent
229 device to a child.  However the converse is allowed, i.e. a device link
230 from a child to a parent.  Since the driver core already guarantees
231 correct suspend/resume and shutdown ordering between parent and child,
232 such a device link only makes sense if a driver presence dependency is
233 needed on top of that.  In this case driver authors should weigh
234 carefully if a device link is at all the right tool for the purpose.
235 A more suitable approach might be to simply use deferred probing or
236 add a device flag causing the parent driver to be probed before the
237 child one.
238
239 State machine
240 =============
241
242 .. kernel-doc:: include/linux/device.h
243    :functions: device_link_state
244
245 ::
246
247                  .=============================.
248                  |                             |
249                  v                             |
250  DORMANT <=> AVAILABLE <=> CONSUMER_PROBE => ACTIVE
251     ^                                          |
252     |                                          |
253     '============ SUPPLIER_UNBIND <============'
254
255 * The initial state of a device link is automatically determined by
256   :c:func:`device_link_add()` based on the driver presence on the supplier
257   and consumer.  If the link is created before any devices are probed, it
258   is set to ``DL_STATE_DORMANT``.
259
260 * When a supplier device is bound to a driver, links to its consumers
261   progress to ``DL_STATE_AVAILABLE``.
262   (Call to :c:func:`device_links_driver_bound()` from
263   :c:func:`driver_bound()`.)
264
265 * Before a consumer device is probed, presence of supplier drivers is
266   verified by checking that links to suppliers are in ``DL_STATE_AVAILABLE``
267   state.  The state of the links is updated to ``DL_STATE_CONSUMER_PROBE``.
268   (Call to :c:func:`device_links_check_suppliers()` from
269   :c:func:`really_probe()`.)
270   This prevents the supplier from unbinding.
271   (Call to :c:func:`wait_for_device_probe()` from
272   :c:func:`device_links_unbind_consumers()`.)
273
274 * If the probe fails, links to suppliers revert back to ``DL_STATE_AVAILABLE``.
275   (Call to :c:func:`device_links_no_driver()` from :c:func:`really_probe()`.)
276
277 * If the probe succeeds, links to suppliers progress to ``DL_STATE_ACTIVE``.
278   (Call to :c:func:`device_links_driver_bound()` from :c:func:`driver_bound()`.)
279
280 * When the consumer's driver is later on removed, links to suppliers revert
281   back to ``DL_STATE_AVAILABLE``.
282   (Call to :c:func:`__device_links_no_driver()` from
283   :c:func:`device_links_driver_cleanup()`, which in turn is called from
284   :c:func:`__device_release_driver()`.)
285
286 * Before a supplier's driver is removed, links to consumers that are not
287   bound to a driver are updated to ``DL_STATE_SUPPLIER_UNBIND``.
288   (Call to :c:func:`device_links_busy()` from
289   :c:func:`__device_release_driver()`.)
290   This prevents the consumers from binding.
291   (Call to :c:func:`device_links_check_suppliers()` from
292   :c:func:`really_probe()`.)
293   Consumers that are bound are freed from their driver; consumers that are
294   probing are waited for until they are done.
295   (Call to :c:func:`device_links_unbind_consumers()` from
296   :c:func:`__device_release_driver()`.)
297   Once all links to consumers are in ``DL_STATE_SUPPLIER_UNBIND`` state,
298   the supplier driver is released and the links revert to ``DL_STATE_DORMANT``.
299   (Call to :c:func:`device_links_driver_cleanup()` from
300   :c:func:`__device_release_driver()`.)
301
302 API
303 ===
304
305 .. kernel-doc:: drivers/base/core.c
306    :functions: device_link_add device_link_del device_link_remove