projects/linux·blob v5.8 · refs

980 lines · 32.5 KiB

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