Line data Source code
1 : // SPDX-License-Identifier: GPL-2.0
2 : /*
3 : * device.h - generic, centralized driver model
4 : *
5 : * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
6 : * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
7 : * Copyright (c) 2008-2009 Novell Inc.
8 : *
9 : * See Documentation/driver-api/driver-model/ for more information.
10 : */
11 :
12 : #ifndef _DEVICE_H_
13 : #define _DEVICE_H_
14 :
15 : #include <linux/dev_printk.h>
16 : #include <linux/energy_model.h>
17 : #include <linux/ioport.h>
18 : #include <linux/kobject.h>
19 : #include <linux/klist.h>
20 : #include <linux/list.h>
21 : #include <linux/lockdep.h>
22 : #include <linux/compiler.h>
23 : #include <linux/types.h>
24 : #include <linux/mutex.h>
25 : #include <linux/pm.h>
26 : #include <linux/atomic.h>
27 : #include <linux/uidgid.h>
28 : #include <linux/gfp.h>
29 : #include <linux/overflow.h>
30 : #include <linux/device/bus.h>
31 : #include <linux/device/class.h>
32 : #include <linux/device/driver.h>
33 : #include <asm/device.h>
34 :
35 : struct device;
36 : struct device_private;
37 : struct device_driver;
38 : struct driver_private;
39 : struct module;
40 : struct class;
41 : struct subsys_private;
42 : struct device_node;
43 : struct fwnode_handle;
44 : struct iommu_ops;
45 : struct iommu_group;
46 : struct dev_pin_info;
47 : struct dev_iommu;
48 : struct msi_device_data;
49 :
50 : /**
51 : * struct subsys_interface - interfaces to device functions
52 : * @name: name of the device function
53 : * @subsys: subsystem of the devices to attach to
54 : * @node: the list of functions registered at the subsystem
55 : * @add_dev: device hookup to device function handler
56 : * @remove_dev: device hookup to device function handler
57 : *
58 : * Simple interfaces attached to a subsystem. Multiple interfaces can
59 : * attach to a subsystem and its devices. Unlike drivers, they do not
60 : * exclusively claim or control devices. Interfaces usually represent
61 : * a specific functionality of a subsystem/class of devices.
62 : */
63 : struct subsys_interface {
64 : const char *name;
65 : struct bus_type *subsys;
66 : struct list_head node;
67 : int (*add_dev)(struct device *dev, struct subsys_interface *sif);
68 : void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
69 : };
70 :
71 : int subsys_interface_register(struct subsys_interface *sif);
72 : void subsys_interface_unregister(struct subsys_interface *sif);
73 :
74 : int subsys_system_register(struct bus_type *subsys,
75 : const struct attribute_group **groups);
76 : int subsys_virtual_register(struct bus_type *subsys,
77 : const struct attribute_group **groups);
78 :
79 : /*
80 : * The type of device, "struct device" is embedded in. A class
81 : * or bus can contain devices of different types
82 : * like "partitions" and "disks", "mouse" and "event".
83 : * This identifies the device type and carries type-specific
84 : * information, equivalent to the kobj_type of a kobject.
85 : * If "name" is specified, the uevent will contain it in
86 : * the DEVTYPE variable.
87 : */
88 : struct device_type {
89 : const char *name;
90 : const struct attribute_group **groups;
91 : int (*uevent)(const struct device *dev, struct kobj_uevent_env *env);
92 : char *(*devnode)(const struct device *dev, umode_t *mode,
93 : kuid_t *uid, kgid_t *gid);
94 : void (*release)(struct device *dev);
95 :
96 : const struct dev_pm_ops *pm;
97 : };
98 :
99 : /* interface for exporting device attributes */
100 : struct device_attribute {
101 : struct attribute attr;
102 : ssize_t (*show)(struct device *dev, struct device_attribute *attr,
103 : char *buf);
104 : ssize_t (*store)(struct device *dev, struct device_attribute *attr,
105 : const char *buf, size_t count);
106 : };
107 :
108 : struct dev_ext_attribute {
109 : struct device_attribute attr;
110 : void *var;
111 : };
112 :
113 : ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
114 : char *buf);
115 : ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
116 : const char *buf, size_t count);
117 : ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
118 : char *buf);
119 : ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
120 : const char *buf, size_t count);
121 : ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
122 : char *buf);
123 : ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
124 : const char *buf, size_t count);
125 :
126 : #define DEVICE_ATTR(_name, _mode, _show, _store) \
127 : struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
128 : #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
129 : struct device_attribute dev_attr_##_name = \
130 : __ATTR_PREALLOC(_name, _mode, _show, _store)
131 : #define DEVICE_ATTR_RW(_name) \
132 : struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
133 : #define DEVICE_ATTR_ADMIN_RW(_name) \
134 : struct device_attribute dev_attr_##_name = __ATTR_RW_MODE(_name, 0600)
135 : #define DEVICE_ATTR_RO(_name) \
136 : struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
137 : #define DEVICE_ATTR_ADMIN_RO(_name) \
138 : struct device_attribute dev_attr_##_name = __ATTR_RO_MODE(_name, 0400)
139 : #define DEVICE_ATTR_WO(_name) \
140 : struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
141 : #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
142 : struct dev_ext_attribute dev_attr_##_name = \
143 : { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
144 : #define DEVICE_INT_ATTR(_name, _mode, _var) \
145 : struct dev_ext_attribute dev_attr_##_name = \
146 : { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
147 : #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
148 : struct dev_ext_attribute dev_attr_##_name = \
149 : { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
150 : #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
151 : struct device_attribute dev_attr_##_name = \
152 : __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
153 :
154 : int device_create_file(struct device *device,
155 : const struct device_attribute *entry);
156 : void device_remove_file(struct device *dev,
157 : const struct device_attribute *attr);
158 : bool device_remove_file_self(struct device *dev,
159 : const struct device_attribute *attr);
160 : int __must_check device_create_bin_file(struct device *dev,
161 : const struct bin_attribute *attr);
162 : void device_remove_bin_file(struct device *dev,
163 : const struct bin_attribute *attr);
164 :
165 : /* device resource management */
166 : typedef void (*dr_release_t)(struct device *dev, void *res);
167 : typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
168 :
169 : void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
170 : int nid, const char *name) __malloc;
171 : #define devres_alloc(release, size, gfp) \
172 : __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
173 : #define devres_alloc_node(release, size, gfp, nid) \
174 : __devres_alloc_node(release, size, gfp, nid, #release)
175 :
176 : void devres_for_each_res(struct device *dev, dr_release_t release,
177 : dr_match_t match, void *match_data,
178 : void (*fn)(struct device *, void *, void *),
179 : void *data);
180 : void devres_free(void *res);
181 : void devres_add(struct device *dev, void *res);
182 : void *devres_find(struct device *dev, dr_release_t release,
183 : dr_match_t match, void *match_data);
184 : void *devres_get(struct device *dev, void *new_res,
185 : dr_match_t match, void *match_data);
186 : void *devres_remove(struct device *dev, dr_release_t release,
187 : dr_match_t match, void *match_data);
188 : int devres_destroy(struct device *dev, dr_release_t release,
189 : dr_match_t match, void *match_data);
190 : int devres_release(struct device *dev, dr_release_t release,
191 : dr_match_t match, void *match_data);
192 :
193 : /* devres group */
194 : void * __must_check devres_open_group(struct device *dev, void *id, gfp_t gfp);
195 : void devres_close_group(struct device *dev, void *id);
196 : void devres_remove_group(struct device *dev, void *id);
197 : int devres_release_group(struct device *dev, void *id);
198 :
199 : /* managed devm_k.alloc/kfree for device drivers */
200 : void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __alloc_size(2);
201 : void *devm_krealloc(struct device *dev, void *ptr, size_t size,
202 : gfp_t gfp) __must_check __realloc_size(3);
203 : __printf(3, 0) char *devm_kvasprintf(struct device *dev, gfp_t gfp,
204 : const char *fmt, va_list ap) __malloc;
205 : __printf(3, 4) char *devm_kasprintf(struct device *dev, gfp_t gfp,
206 : const char *fmt, ...) __malloc;
207 : static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
208 : {
209 0 : return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
210 : }
211 : static inline void *devm_kmalloc_array(struct device *dev,
212 : size_t n, size_t size, gfp_t flags)
213 : {
214 : size_t bytes;
215 :
216 : if (unlikely(check_mul_overflow(n, size, &bytes)))
217 : return NULL;
218 :
219 : return devm_kmalloc(dev, bytes, flags);
220 : }
221 : static inline void *devm_kcalloc(struct device *dev,
222 : size_t n, size_t size, gfp_t flags)
223 : {
224 : return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
225 : }
226 : void devm_kfree(struct device *dev, const void *p);
227 : char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
228 : const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp);
229 : void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp)
230 : __realloc_size(3);
231 :
232 : unsigned long devm_get_free_pages(struct device *dev,
233 : gfp_t gfp_mask, unsigned int order);
234 : void devm_free_pages(struct device *dev, unsigned long addr);
235 :
236 : void __iomem *devm_ioremap_resource(struct device *dev,
237 : const struct resource *res);
238 : void __iomem *devm_ioremap_resource_wc(struct device *dev,
239 : const struct resource *res);
240 :
241 : void __iomem *devm_of_iomap(struct device *dev,
242 : struct device_node *node, int index,
243 : resource_size_t *size);
244 :
245 : /* allows to add/remove a custom action to devres stack */
246 : int devm_add_action(struct device *dev, void (*action)(void *), void *data);
247 : void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
248 : void devm_release_action(struct device *dev, void (*action)(void *), void *data);
249 :
250 : static inline int devm_add_action_or_reset(struct device *dev,
251 : void (*action)(void *), void *data)
252 : {
253 : int ret;
254 :
255 17 : ret = devm_add_action(dev, action, data);
256 17 : if (ret)
257 0 : action(data);
258 :
259 : return ret;
260 : }
261 :
262 : /**
263 : * devm_alloc_percpu - Resource-managed alloc_percpu
264 : * @dev: Device to allocate per-cpu memory for
265 : * @type: Type to allocate per-cpu memory for
266 : *
267 : * Managed alloc_percpu. Per-cpu memory allocated with this function is
268 : * automatically freed on driver detach.
269 : *
270 : * RETURNS:
271 : * Pointer to allocated memory on success, NULL on failure.
272 : */
273 : #define devm_alloc_percpu(dev, type) \
274 : ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
275 : __alignof__(type)))
276 :
277 : void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
278 : size_t align);
279 : void devm_free_percpu(struct device *dev, void __percpu *pdata);
280 :
281 : struct device_dma_parameters {
282 : /*
283 : * a low level driver may set these to teach IOMMU code about
284 : * sg limitations.
285 : */
286 : unsigned int max_segment_size;
287 : unsigned int min_align_mask;
288 : unsigned long segment_boundary_mask;
289 : };
290 :
291 : /**
292 : * enum device_link_state - Device link states.
293 : * @DL_STATE_NONE: The presence of the drivers is not being tracked.
294 : * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
295 : * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
296 : * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
297 : * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
298 : * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
299 : */
300 : enum device_link_state {
301 : DL_STATE_NONE = -1,
302 : DL_STATE_DORMANT = 0,
303 : DL_STATE_AVAILABLE,
304 : DL_STATE_CONSUMER_PROBE,
305 : DL_STATE_ACTIVE,
306 : DL_STATE_SUPPLIER_UNBIND,
307 : };
308 :
309 : /*
310 : * Device link flags.
311 : *
312 : * STATELESS: The core will not remove this link automatically.
313 : * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
314 : * PM_RUNTIME: If set, the runtime PM framework will use this link.
315 : * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
316 : * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
317 : * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
318 : * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
319 : * SYNC_STATE_ONLY: Link only affects sync_state() behavior.
320 : * INFERRED: Inferred from data (eg: firmware) and not from driver actions.
321 : */
322 : #define DL_FLAG_STATELESS BIT(0)
323 : #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)
324 : #define DL_FLAG_PM_RUNTIME BIT(2)
325 : #define DL_FLAG_RPM_ACTIVE BIT(3)
326 : #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)
327 : #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)
328 : #define DL_FLAG_MANAGED BIT(6)
329 : #define DL_FLAG_SYNC_STATE_ONLY BIT(7)
330 : #define DL_FLAG_INFERRED BIT(8)
331 : #define DL_FLAG_CYCLE BIT(9)
332 :
333 : /**
334 : * enum dl_dev_state - Device driver presence tracking information.
335 : * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
336 : * @DL_DEV_PROBING: A driver is probing.
337 : * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
338 : * @DL_DEV_UNBINDING: The driver is unbinding from the device.
339 : */
340 : enum dl_dev_state {
341 : DL_DEV_NO_DRIVER = 0,
342 : DL_DEV_PROBING,
343 : DL_DEV_DRIVER_BOUND,
344 : DL_DEV_UNBINDING,
345 : };
346 :
347 : /**
348 : * enum device_removable - Whether the device is removable. The criteria for a
349 : * device to be classified as removable is determined by its subsystem or bus.
350 : * @DEVICE_REMOVABLE_NOT_SUPPORTED: This attribute is not supported for this
351 : * device (default).
352 : * @DEVICE_REMOVABLE_UNKNOWN: Device location is Unknown.
353 : * @DEVICE_FIXED: Device is not removable by the user.
354 : * @DEVICE_REMOVABLE: Device is removable by the user.
355 : */
356 : enum device_removable {
357 : DEVICE_REMOVABLE_NOT_SUPPORTED = 0, /* must be 0 */
358 : DEVICE_REMOVABLE_UNKNOWN,
359 : DEVICE_FIXED,
360 : DEVICE_REMOVABLE,
361 : };
362 :
363 : /**
364 : * struct dev_links_info - Device data related to device links.
365 : * @suppliers: List of links to supplier devices.
366 : * @consumers: List of links to consumer devices.
367 : * @defer_sync: Hook to global list of devices that have deferred sync_state.
368 : * @status: Driver status information.
369 : */
370 : struct dev_links_info {
371 : struct list_head suppliers;
372 : struct list_head consumers;
373 : struct list_head defer_sync;
374 : enum dl_dev_state status;
375 : };
376 :
377 : /**
378 : * struct dev_msi_info - Device data related to MSI
379 : * @domain: The MSI interrupt domain associated to the device
380 : * @data: Pointer to MSI device data
381 : */
382 : struct dev_msi_info {
383 : #ifdef CONFIG_GENERIC_MSI_IRQ
384 : struct irq_domain *domain;
385 : struct msi_device_data *data;
386 : #endif
387 : };
388 :
389 : /**
390 : * enum device_physical_location_panel - Describes which panel surface of the
391 : * system's housing the device connection point resides on.
392 : * @DEVICE_PANEL_TOP: Device connection point is on the top panel.
393 : * @DEVICE_PANEL_BOTTOM: Device connection point is on the bottom panel.
394 : * @DEVICE_PANEL_LEFT: Device connection point is on the left panel.
395 : * @DEVICE_PANEL_RIGHT: Device connection point is on the right panel.
396 : * @DEVICE_PANEL_FRONT: Device connection point is on the front panel.
397 : * @DEVICE_PANEL_BACK: Device connection point is on the back panel.
398 : * @DEVICE_PANEL_UNKNOWN: The panel with device connection point is unknown.
399 : */
400 : enum device_physical_location_panel {
401 : DEVICE_PANEL_TOP,
402 : DEVICE_PANEL_BOTTOM,
403 : DEVICE_PANEL_LEFT,
404 : DEVICE_PANEL_RIGHT,
405 : DEVICE_PANEL_FRONT,
406 : DEVICE_PANEL_BACK,
407 : DEVICE_PANEL_UNKNOWN,
408 : };
409 :
410 : /**
411 : * enum device_physical_location_vertical_position - Describes vertical
412 : * position of the device connection point on the panel surface.
413 : * @DEVICE_VERT_POS_UPPER: Device connection point is at upper part of panel.
414 : * @DEVICE_VERT_POS_CENTER: Device connection point is at center part of panel.
415 : * @DEVICE_VERT_POS_LOWER: Device connection point is at lower part of panel.
416 : */
417 : enum device_physical_location_vertical_position {
418 : DEVICE_VERT_POS_UPPER,
419 : DEVICE_VERT_POS_CENTER,
420 : DEVICE_VERT_POS_LOWER,
421 : };
422 :
423 : /**
424 : * enum device_physical_location_horizontal_position - Describes horizontal
425 : * position of the device connection point on the panel surface.
426 : * @DEVICE_HORI_POS_LEFT: Device connection point is at left part of panel.
427 : * @DEVICE_HORI_POS_CENTER: Device connection point is at center part of panel.
428 : * @DEVICE_HORI_POS_RIGHT: Device connection point is at right part of panel.
429 : */
430 : enum device_physical_location_horizontal_position {
431 : DEVICE_HORI_POS_LEFT,
432 : DEVICE_HORI_POS_CENTER,
433 : DEVICE_HORI_POS_RIGHT,
434 : };
435 :
436 : /**
437 : * struct device_physical_location - Device data related to physical location
438 : * of the device connection point.
439 : * @panel: Panel surface of the system's housing that the device connection
440 : * point resides on.
441 : * @vertical_position: Vertical position of the device connection point within
442 : * the panel.
443 : * @horizontal_position: Horizontal position of the device connection point
444 : * within the panel.
445 : * @dock: Set if the device connection point resides in a docking station or
446 : * port replicator.
447 : * @lid: Set if this device connection point resides on the lid of laptop
448 : * system.
449 : */
450 : struct device_physical_location {
451 : enum device_physical_location_panel panel;
452 : enum device_physical_location_vertical_position vertical_position;
453 : enum device_physical_location_horizontal_position horizontal_position;
454 : bool dock;
455 : bool lid;
456 : };
457 :
458 : /**
459 : * struct device - The basic device structure
460 : * @parent: The device's "parent" device, the device to which it is attached.
461 : * In most cases, a parent device is some sort of bus or host
462 : * controller. If parent is NULL, the device, is a top-level device,
463 : * which is not usually what you want.
464 : * @p: Holds the private data of the driver core portions of the device.
465 : * See the comment of the struct device_private for detail.
466 : * @kobj: A top-level, abstract class from which other classes are derived.
467 : * @init_name: Initial name of the device.
468 : * @type: The type of device.
469 : * This identifies the device type and carries type-specific
470 : * information.
471 : * @mutex: Mutex to synchronize calls to its driver.
472 : * @bus: Type of bus device is on.
473 : * @driver: Which driver has allocated this
474 : * @platform_data: Platform data specific to the device.
475 : * Example: For devices on custom boards, as typical of embedded
476 : * and SOC based hardware, Linux often uses platform_data to point
477 : * to board-specific structures describing devices and how they
478 : * are wired. That can include what ports are available, chip
479 : * variants, which GPIO pins act in what additional roles, and so
480 : * on. This shrinks the "Board Support Packages" (BSPs) and
481 : * minimizes board-specific #ifdefs in drivers.
482 : * @driver_data: Private pointer for driver specific info.
483 : * @links: Links to suppliers and consumers of this device.
484 : * @power: For device power management.
485 : * See Documentation/driver-api/pm/devices.rst for details.
486 : * @pm_domain: Provide callbacks that are executed during system suspend,
487 : * hibernation, system resume and during runtime PM transitions
488 : * along with subsystem-level and driver-level callbacks.
489 : * @em_pd: device's energy model performance domain
490 : * @pins: For device pin management.
491 : * See Documentation/driver-api/pin-control.rst for details.
492 : * @msi: MSI related data
493 : * @numa_node: NUMA node this device is close to.
494 : * @dma_ops: DMA mapping operations for this device.
495 : * @dma_mask: Dma mask (if dma'ble device).
496 : * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
497 : * hardware supports 64-bit addresses for consistent allocations
498 : * such descriptors.
499 : * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller
500 : * DMA limit than the device itself supports.
501 : * @dma_range_map: map for DMA memory ranges relative to that of RAM
502 : * @dma_parms: A low level driver may set these to teach IOMMU code about
503 : * segment limitations.
504 : * @dma_pools: Dma pools (if dma'ble device).
505 : * @dma_mem: Internal for coherent mem override.
506 : * @cma_area: Contiguous memory area for dma allocations
507 : * @dma_io_tlb_mem: Pointer to the swiotlb pool used. Not for driver use.
508 : * @archdata: For arch-specific additions.
509 : * @of_node: Associated device tree node.
510 : * @fwnode: Associated device node supplied by platform firmware.
511 : * @devt: For creating the sysfs "dev".
512 : * @id: device instance
513 : * @devres_lock: Spinlock to protect the resource of the device.
514 : * @devres_head: The resources list of the device.
515 : * @knode_class: The node used to add the device to the class list.
516 : * @class: The class of the device.
517 : * @groups: Optional attribute groups.
518 : * @release: Callback to free the device after all references have
519 : * gone away. This should be set by the allocator of the
520 : * device (i.e. the bus driver that discovered the device).
521 : * @iommu_group: IOMMU group the device belongs to.
522 : * @iommu: Per device generic IOMMU runtime data
523 : * @physical_location: Describes physical location of the device connection
524 : * point in the system housing.
525 : * @removable: Whether the device can be removed from the system. This
526 : * should be set by the subsystem / bus driver that discovered
527 : * the device.
528 : *
529 : * @offline_disabled: If set, the device is permanently online.
530 : * @offline: Set after successful invocation of bus type's .offline().
531 : * @of_node_reused: Set if the device-tree node is shared with an ancestor
532 : * device.
533 : * @state_synced: The hardware state of this device has been synced to match
534 : * the software state of this device by calling the driver/bus
535 : * sync_state() callback.
536 : * @can_match: The device has matched with a driver at least once or it is in
537 : * a bus (like AMBA) which can't check for matching drivers until
538 : * other devices probe successfully.
539 : * @dma_coherent: this particular device is dma coherent, even if the
540 : * architecture supports non-coherent devices.
541 : * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the
542 : * streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
543 : * and optionall (if the coherent mask is large enough) also
544 : * for dma allocations. This flag is managed by the dma ops
545 : * instance from ->dma_supported.
546 : *
547 : * At the lowest level, every device in a Linux system is represented by an
548 : * instance of struct device. The device structure contains the information
549 : * that the device model core needs to model the system. Most subsystems,
550 : * however, track additional information about the devices they host. As a
551 : * result, it is rare for devices to be represented by bare device structures;
552 : * instead, that structure, like kobject structures, is usually embedded within
553 : * a higher-level representation of the device.
554 : */
555 : struct device {
556 : struct kobject kobj;
557 : struct device *parent;
558 :
559 : struct device_private *p;
560 :
561 : const char *init_name; /* initial name of the device */
562 : const struct device_type *type;
563 :
564 : struct bus_type *bus; /* type of bus device is on */
565 : struct device_driver *driver; /* which driver has allocated this
566 : device */
567 : void *platform_data; /* Platform specific data, device
568 : core doesn't touch it */
569 : void *driver_data; /* Driver data, set and get with
570 : dev_set_drvdata/dev_get_drvdata */
571 : struct mutex mutex; /* mutex to synchronize calls to
572 : * its driver.
573 : */
574 :
575 : struct dev_links_info links;
576 : struct dev_pm_info power;
577 : struct dev_pm_domain *pm_domain;
578 :
579 : #ifdef CONFIG_ENERGY_MODEL
580 : struct em_perf_domain *em_pd;
581 : #endif
582 :
583 : #ifdef CONFIG_PINCTRL
584 : struct dev_pin_info *pins;
585 : #endif
586 : struct dev_msi_info msi;
587 : #ifdef CONFIG_DMA_OPS
588 : const struct dma_map_ops *dma_ops;
589 : #endif
590 : u64 *dma_mask; /* dma mask (if dma'able device) */
591 : u64 coherent_dma_mask;/* Like dma_mask, but for
592 : alloc_coherent mappings as
593 : not all hardware supports
594 : 64 bit addresses for consistent
595 : allocations such descriptors. */
596 : u64 bus_dma_limit; /* upstream dma constraint */
597 : const struct bus_dma_region *dma_range_map;
598 :
599 : struct device_dma_parameters *dma_parms;
600 :
601 : struct list_head dma_pools; /* dma pools (if dma'ble) */
602 :
603 : #ifdef CONFIG_DMA_DECLARE_COHERENT
604 : struct dma_coherent_mem *dma_mem; /* internal for coherent mem
605 : override */
606 : #endif
607 : #ifdef CONFIG_DMA_CMA
608 : struct cma *cma_area; /* contiguous memory area for dma
609 : allocations */
610 : #endif
611 : #ifdef CONFIG_SWIOTLB
612 : struct io_tlb_mem *dma_io_tlb_mem;
613 : #endif
614 : /* arch specific additions */
615 : struct dev_archdata archdata;
616 :
617 : struct device_node *of_node; /* associated device tree node */
618 : struct fwnode_handle *fwnode; /* firmware device node */
619 :
620 : #ifdef CONFIG_NUMA
621 : int numa_node; /* NUMA node this device is close to */
622 : #endif
623 : dev_t devt; /* dev_t, creates the sysfs "dev" */
624 : u32 id; /* device instance */
625 :
626 : spinlock_t devres_lock;
627 : struct list_head devres_head;
628 :
629 : struct class *class;
630 : const struct attribute_group **groups; /* optional groups */
631 :
632 : void (*release)(struct device *dev);
633 : struct iommu_group *iommu_group;
634 : struct dev_iommu *iommu;
635 :
636 : struct device_physical_location *physical_location;
637 :
638 : enum device_removable removable;
639 :
640 : bool offline_disabled:1;
641 : bool offline:1;
642 : bool of_node_reused:1;
643 : bool state_synced:1;
644 : bool can_match:1;
645 : #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
646 : defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
647 : defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
648 : bool dma_coherent:1;
649 : #endif
650 : #ifdef CONFIG_DMA_OPS_BYPASS
651 : bool dma_ops_bypass : 1;
652 : #endif
653 : };
654 :
655 : /**
656 : * struct device_link - Device link representation.
657 : * @supplier: The device on the supplier end of the link.
658 : * @s_node: Hook to the supplier device's list of links to consumers.
659 : * @consumer: The device on the consumer end of the link.
660 : * @c_node: Hook to the consumer device's list of links to suppliers.
661 : * @link_dev: device used to expose link details in sysfs
662 : * @status: The state of the link (with respect to the presence of drivers).
663 : * @flags: Link flags.
664 : * @rpm_active: Whether or not the consumer device is runtime-PM-active.
665 : * @kref: Count repeated addition of the same link.
666 : * @rm_work: Work structure used for removing the link.
667 : * @supplier_preactivated: Supplier has been made active before consumer probe.
668 : */
669 : struct device_link {
670 : struct device *supplier;
671 : struct list_head s_node;
672 : struct device *consumer;
673 : struct list_head c_node;
674 : struct device link_dev;
675 : enum device_link_state status;
676 : u32 flags;
677 : refcount_t rpm_active;
678 : struct kref kref;
679 : struct work_struct rm_work;
680 : bool supplier_preactivated; /* Owned by consumer probe. */
681 : };
682 :
683 : #define kobj_to_dev(__kobj) container_of_const(__kobj, struct device, kobj)
684 :
685 : /**
686 : * device_iommu_mapped - Returns true when the device DMA is translated
687 : * by an IOMMU
688 : * @dev: Device to perform the check on
689 : */
690 : static inline bool device_iommu_mapped(struct device *dev)
691 : {
692 : return (dev->iommu_group != NULL);
693 : }
694 :
695 : /* Get the wakeup routines, which depend on struct device */
696 : #include <linux/pm_wakeup.h>
697 :
698 : static inline const char *dev_name(const struct device *dev)
699 : {
700 : /* Use the init name until the kobject becomes available */
701 2744 : if (dev->init_name)
702 : return dev->init_name;
703 :
704 2744 : return kobject_name(&dev->kobj);
705 : }
706 :
707 : /**
708 : * dev_bus_name - Return a device's bus/class name, if at all possible
709 : * @dev: struct device to get the bus/class name of
710 : *
711 : * Will return the name of the bus/class the device is attached to. If it is
712 : * not attached to a bus/class, an empty string will be returned.
713 : */
714 : static inline const char *dev_bus_name(const struct device *dev)
715 : {
716 0 : return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");
717 : }
718 :
719 : __printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);
720 :
721 : #ifdef CONFIG_NUMA
722 : static inline int dev_to_node(struct device *dev)
723 : {
724 : return dev->numa_node;
725 : }
726 : static inline void set_dev_node(struct device *dev, int node)
727 : {
728 : dev->numa_node = node;
729 : }
730 : #else
731 : static inline int dev_to_node(struct device *dev)
732 : {
733 : return NUMA_NO_NODE;
734 : }
735 : static inline void set_dev_node(struct device *dev, int node)
736 : {
737 : }
738 : #endif
739 :
740 : static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
741 : {
742 : #ifdef CONFIG_GENERIC_MSI_IRQ
743 : return dev->msi.domain;
744 : #else
745 : return NULL;
746 : #endif
747 : }
748 :
749 : static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
750 : {
751 : #ifdef CONFIG_GENERIC_MSI_IRQ
752 0 : dev->msi.domain = d;
753 : #endif
754 : }
755 :
756 : static inline void *dev_get_drvdata(const struct device *dev)
757 : {
758 : return dev->driver_data;
759 : }
760 :
761 : static inline void dev_set_drvdata(struct device *dev, void *data)
762 : {
763 561 : dev->driver_data = data;
764 : }
765 :
766 : static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
767 : {
768 0 : return dev ? dev->power.subsys_data : NULL;
769 : }
770 :
771 : static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
772 : {
773 0 : return dev->kobj.uevent_suppress;
774 : }
775 :
776 : static inline void dev_set_uevent_suppress(struct device *dev, int val)
777 : {
778 1028 : dev->kobj.uevent_suppress = val;
779 : }
780 :
781 : static inline int device_is_registered(struct device *dev)
782 : {
783 19 : return dev->kobj.state_in_sysfs;
784 : }
785 :
786 : static inline void device_enable_async_suspend(struct device *dev)
787 : {
788 0 : if (!dev->power.is_prepared)
789 0 : dev->power.async_suspend = true;
790 : }
791 :
792 : static inline void device_disable_async_suspend(struct device *dev)
793 : {
794 0 : if (!dev->power.is_prepared)
795 0 : dev->power.async_suspend = false;
796 : }
797 :
798 : static inline bool device_async_suspend_enabled(struct device *dev)
799 : {
800 : return !!dev->power.async_suspend;
801 : }
802 :
803 : static inline bool device_pm_not_required(struct device *dev)
804 : {
805 1144 : return dev->power.no_pm;
806 : }
807 :
808 : static inline void device_set_pm_not_required(struct device *dev)
809 : {
810 0 : dev->power.no_pm = true;
811 : }
812 :
813 : static inline void dev_pm_syscore_device(struct device *dev, bool val)
814 : {
815 : #ifdef CONFIG_PM_SLEEP
816 : dev->power.syscore = val;
817 : #endif
818 : }
819 :
820 : static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
821 : {
822 17 : dev->power.driver_flags = flags;
823 : }
824 :
825 : static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
826 : {
827 0 : return !!(dev->power.driver_flags & flags);
828 : }
829 :
830 : static inline void device_lock(struct device *dev)
831 : {
832 39 : mutex_lock(&dev->mutex);
833 : }
834 :
835 : static inline int device_lock_interruptible(struct device *dev)
836 : {
837 : return mutex_lock_interruptible(&dev->mutex);
838 : }
839 :
840 : static inline int device_trylock(struct device *dev)
841 : {
842 0 : return mutex_trylock(&dev->mutex);
843 : }
844 :
845 : static inline void device_unlock(struct device *dev)
846 : {
847 592 : mutex_unlock(&dev->mutex);
848 : }
849 :
850 : static inline void device_lock_assert(struct device *dev)
851 : {
852 : lockdep_assert_held(&dev->mutex);
853 : }
854 :
855 : static inline struct device_node *dev_of_node(struct device *dev)
856 : {
857 : if (!IS_ENABLED(CONFIG_OF) || !dev)
858 : return NULL;
859 : return dev->of_node;
860 : }
861 :
862 : static inline bool dev_has_sync_state(struct device *dev)
863 : {
864 34 : if (!dev)
865 : return false;
866 34 : if (dev->driver && dev->driver->sync_state)
867 : return true;
868 34 : if (dev->bus && dev->bus->sync_state)
869 : return true;
870 : return false;
871 : }
872 :
873 : static inline void dev_set_removable(struct device *dev,
874 : enum device_removable removable)
875 : {
876 0 : dev->removable = removable;
877 : }
878 :
879 : static inline bool dev_is_removable(struct device *dev)
880 : {
881 : return dev->removable == DEVICE_REMOVABLE;
882 : }
883 :
884 : static inline bool dev_removable_is_valid(struct device *dev)
885 : {
886 : return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED;
887 : }
888 :
889 : /*
890 : * High level routines for use by the bus drivers
891 : */
892 : int __must_check device_register(struct device *dev);
893 : void device_unregister(struct device *dev);
894 : void device_initialize(struct device *dev);
895 : int __must_check device_add(struct device *dev);
896 : void device_del(struct device *dev);
897 : int device_for_each_child(struct device *dev, void *data,
898 : int (*fn)(struct device *dev, void *data));
899 : int device_for_each_child_reverse(struct device *dev, void *data,
900 : int (*fn)(struct device *dev, void *data));
901 : struct device *device_find_child(struct device *dev, void *data,
902 : int (*match)(struct device *dev, void *data));
903 : struct device *device_find_child_by_name(struct device *parent,
904 : const char *name);
905 : struct device *device_find_any_child(struct device *parent);
906 :
907 : int device_rename(struct device *dev, const char *new_name);
908 : int device_move(struct device *dev, struct device *new_parent,
909 : enum dpm_order dpm_order);
910 : int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
911 : int device_is_dependent(struct device *dev, void *target);
912 :
913 : static inline bool device_supports_offline(struct device *dev)
914 : {
915 554 : return dev->bus && dev->bus->offline && dev->bus->online;
916 : }
917 :
918 : #define __device_lock_set_class(dev, name, key) \
919 : do { \
920 : struct device *__d2 __maybe_unused = dev; \
921 : lock_set_class(&__d2->mutex.dep_map, name, key, 0, _THIS_IP_); \
922 : } while (0)
923 :
924 : /**
925 : * device_lock_set_class - Specify a temporary lock class while a device
926 : * is attached to a driver
927 : * @dev: device to modify
928 : * @key: lock class key data
929 : *
930 : * This must be called with the device_lock() already held, for example
931 : * from driver ->probe(). Take care to only override the default
932 : * lockdep_no_validate class.
933 : */
934 : #ifdef CONFIG_LOCKDEP
935 : #define device_lock_set_class(dev, key) \
936 : do { \
937 : struct device *__d = dev; \
938 : dev_WARN_ONCE(__d, !lockdep_match_class(&__d->mutex, \
939 : &__lockdep_no_validate__), \
940 : "overriding existing custom lock class\n"); \
941 : __device_lock_set_class(__d, #key, key); \
942 : } while (0)
943 : #else
944 : #define device_lock_set_class(dev, key) __device_lock_set_class(dev, #key, key)
945 : #endif
946 :
947 : /**
948 : * device_lock_reset_class - Return a device to the default lockdep novalidate state
949 : * @dev: device to modify
950 : *
951 : * This must be called with the device_lock() already held, for example
952 : * from driver ->remove().
953 : */
954 : #define device_lock_reset_class(dev) \
955 : do { \
956 : struct device *__d __maybe_unused = dev; \
957 : lock_set_novalidate_class(&__d->mutex.dep_map, "&dev->mutex", \
958 : _THIS_IP_); \
959 : } while (0)
960 :
961 : void lock_device_hotplug(void);
962 : void unlock_device_hotplug(void);
963 : int lock_device_hotplug_sysfs(void);
964 : int device_offline(struct device *dev);
965 : int device_online(struct device *dev);
966 : void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
967 : void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
968 : void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
969 : void device_set_node(struct device *dev, struct fwnode_handle *fwnode);
970 :
971 : static inline int dev_num_vf(struct device *dev)
972 : {
973 : if (dev->bus && dev->bus->num_vf)
974 : return dev->bus->num_vf(dev);
975 : return 0;
976 : }
977 :
978 : /*
979 : * Root device objects for grouping under /sys/devices
980 : */
981 : struct device *__root_device_register(const char *name, struct module *owner);
982 :
983 : /* This is a macro to avoid include problems with THIS_MODULE */
984 : #define root_device_register(name) \
985 : __root_device_register(name, THIS_MODULE)
986 :
987 : void root_device_unregister(struct device *root);
988 :
989 : static inline void *dev_get_platdata(const struct device *dev)
990 : {
991 : return dev->platform_data;
992 : }
993 :
994 : /*
995 : * Manual binding of a device to driver. See drivers/base/bus.c
996 : * for information on use.
997 : */
998 : int __must_check device_driver_attach(struct device_driver *drv,
999 : struct device *dev);
1000 : int __must_check device_bind_driver(struct device *dev);
1001 : void device_release_driver(struct device *dev);
1002 : int __must_check device_attach(struct device *dev);
1003 : int __must_check driver_attach(struct device_driver *drv);
1004 : void device_initial_probe(struct device *dev);
1005 : int __must_check device_reprobe(struct device *dev);
1006 :
1007 : bool device_is_bound(struct device *dev);
1008 :
1009 : /*
1010 : * Easy functions for dynamically creating devices on the fly
1011 : */
1012 : __printf(5, 6) struct device *
1013 : device_create(struct class *cls, struct device *parent, dev_t devt,
1014 : void *drvdata, const char *fmt, ...);
1015 : __printf(6, 7) struct device *
1016 : device_create_with_groups(struct class *cls, struct device *parent, dev_t devt,
1017 : void *drvdata, const struct attribute_group **groups,
1018 : const char *fmt, ...);
1019 : void device_destroy(struct class *cls, dev_t devt);
1020 :
1021 : int __must_check device_add_groups(struct device *dev,
1022 : const struct attribute_group **groups);
1023 : void device_remove_groups(struct device *dev,
1024 : const struct attribute_group **groups);
1025 :
1026 : static inline int __must_check device_add_group(struct device *dev,
1027 : const struct attribute_group *grp)
1028 : {
1029 0 : const struct attribute_group *groups[] = { grp, NULL };
1030 :
1031 0 : return device_add_groups(dev, groups);
1032 : }
1033 :
1034 : static inline void device_remove_group(struct device *dev,
1035 : const struct attribute_group *grp)
1036 : {
1037 0 : const struct attribute_group *groups[] = { grp, NULL };
1038 :
1039 0 : return device_remove_groups(dev, groups);
1040 : }
1041 :
1042 : int __must_check devm_device_add_groups(struct device *dev,
1043 : const struct attribute_group **groups);
1044 : int __must_check devm_device_add_group(struct device *dev,
1045 : const struct attribute_group *grp);
1046 :
1047 : /*
1048 : * Platform "fixup" functions - allow the platform to have their say
1049 : * about devices and actions that the general device layer doesn't
1050 : * know about.
1051 : */
1052 : /* Notify platform of device discovery */
1053 : extern int (*platform_notify)(struct device *dev);
1054 :
1055 : extern int (*platform_notify_remove)(struct device *dev);
1056 :
1057 :
1058 : /*
1059 : * get_device - atomically increment the reference count for the device.
1060 : *
1061 : */
1062 : struct device *get_device(struct device *dev);
1063 : void put_device(struct device *dev);
1064 : bool kill_device(struct device *dev);
1065 :
1066 : #ifdef CONFIG_DEVTMPFS
1067 : int devtmpfs_mount(void);
1068 : #else
1069 : static inline int devtmpfs_mount(void) { return 0; }
1070 : #endif
1071 :
1072 : /* drivers/base/power/shutdown.c */
1073 : void device_shutdown(void);
1074 :
1075 : /* debugging and troubleshooting/diagnostic helpers. */
1076 : const char *dev_driver_string(const struct device *dev);
1077 :
1078 : /* Device links interface. */
1079 : struct device_link *device_link_add(struct device *consumer,
1080 : struct device *supplier, u32 flags);
1081 : void device_link_del(struct device_link *link);
1082 : void device_link_remove(void *consumer, struct device *supplier);
1083 : void device_links_supplier_sync_state_pause(void);
1084 : void device_links_supplier_sync_state_resume(void);
1085 :
1086 : extern __printf(3, 4)
1087 : int dev_err_probe(const struct device *dev, int err, const char *fmt, ...);
1088 :
1089 : /* Create alias, so I can be autoloaded. */
1090 : #define MODULE_ALIAS_CHARDEV(major,minor) \
1091 : MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1092 : #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1093 : MODULE_ALIAS("char-major-" __stringify(major) "-*")
1094 :
1095 : #ifdef CONFIG_SYSFS_DEPRECATED
1096 : extern long sysfs_deprecated;
1097 : #else
1098 : #define sysfs_deprecated 0
1099 : #endif
1100 :
1101 : #endif /* _DEVICE_H_ */
|
