Loading...
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
35struct device;
36struct device_private;
37struct device_driver;
38struct driver_private;
39struct module;
40struct class;
41struct subsys_private;
42struct device_node;
43struct fwnode_handle;
44struct iommu_ops;
45struct iommu_group;
46struct dev_pin_info;
47struct dev_iommu;
48
49/**
50 * struct subsys_interface - interfaces to device functions
51 * @name: name of the device function
52 * @subsys: subsytem of the devices to attach to
53 * @node: the list of functions registered at the subsystem
54 * @add_dev: device hookup to device function handler
55 * @remove_dev: device hookup to device function handler
56 *
57 * Simple interfaces attached to a subsystem. Multiple interfaces can
58 * attach to a subsystem and its devices. Unlike drivers, they do not
59 * exclusively claim or control devices. Interfaces usually represent
60 * a specific functionality of a subsystem/class of devices.
61 */
62struct subsys_interface {
63 const char *name;
64 struct bus_type *subsys;
65 struct list_head node;
66 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
67 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
68};
69
70int subsys_interface_register(struct subsys_interface *sif);
71void subsys_interface_unregister(struct subsys_interface *sif);
72
73int subsys_system_register(struct bus_type *subsys,
74 const struct attribute_group **groups);
75int subsys_virtual_register(struct bus_type *subsys,
76 const struct attribute_group **groups);
77
78/*
79 * The type of device, "struct device" is embedded in. A class
80 * or bus can contain devices of different types
81 * like "partitions" and "disks", "mouse" and "event".
82 * This identifies the device type and carries type-specific
83 * information, equivalent to the kobj_type of a kobject.
84 * If "name" is specified, the uevent will contain it in
85 * the DEVTYPE variable.
86 */
87struct device_type {
88 const char *name;
89 const struct attribute_group **groups;
90 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
91 char *(*devnode)(struct device *dev, umode_t *mode,
92 kuid_t *uid, kgid_t *gid);
93 void (*release)(struct device *dev);
94
95 const struct dev_pm_ops *pm;
96};
97
98/* interface for exporting device attributes */
99struct device_attribute {
100 struct attribute attr;
101 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
102 char *buf);
103 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
104 const char *buf, size_t count);
105};
106
107struct dev_ext_attribute {
108 struct device_attribute attr;
109 void *var;
110};
111
112ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
113 char *buf);
114ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
115 const char *buf, size_t count);
116ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
117 char *buf);
118ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
119 const char *buf, size_t count);
120ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
121 char *buf);
122ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
123 const char *buf, size_t count);
124
125#define DEVICE_ATTR(_name, _mode, _show, _store) \
126 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
127#define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
128 struct device_attribute dev_attr_##_name = \
129 __ATTR_PREALLOC(_name, _mode, _show, _store)
130#define DEVICE_ATTR_RW(_name) \
131 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
132#define DEVICE_ATTR_ADMIN_RW(_name) \
133 struct device_attribute dev_attr_##_name = __ATTR_RW_MODE(_name, 0600)
134#define DEVICE_ATTR_RO(_name) \
135 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
136#define DEVICE_ATTR_ADMIN_RO(_name) \
137 struct device_attribute dev_attr_##_name = __ATTR_RO_MODE(_name, 0400)
138#define DEVICE_ATTR_WO(_name) \
139 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
140#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
141 struct dev_ext_attribute dev_attr_##_name = \
142 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
143#define DEVICE_INT_ATTR(_name, _mode, _var) \
144 struct dev_ext_attribute dev_attr_##_name = \
145 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
146#define DEVICE_BOOL_ATTR(_name, _mode, _var) \
147 struct dev_ext_attribute dev_attr_##_name = \
148 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
149#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
150 struct device_attribute dev_attr_##_name = \
151 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
152
153int device_create_file(struct device *device,
154 const struct device_attribute *entry);
155void device_remove_file(struct device *dev,
156 const struct device_attribute *attr);
157bool device_remove_file_self(struct device *dev,
158 const struct device_attribute *attr);
159int __must_check device_create_bin_file(struct device *dev,
160 const struct bin_attribute *attr);
161void device_remove_bin_file(struct device *dev,
162 const struct bin_attribute *attr);
163
164/* device resource management */
165typedef void (*dr_release_t)(struct device *dev, void *res);
166typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
167
168#ifdef CONFIG_DEBUG_DEVRES
169void *__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#else
176void *devres_alloc_node(dr_release_t release, size_t size,
177 gfp_t gfp, int nid) __malloc;
178static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
179{
180 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
181}
182#endif
183
184void devres_for_each_res(struct device *dev, dr_release_t release,
185 dr_match_t match, void *match_data,
186 void (*fn)(struct device *, void *, void *),
187 void *data);
188void devres_free(void *res);
189void devres_add(struct device *dev, void *res);
190void *devres_find(struct device *dev, dr_release_t release,
191 dr_match_t match, void *match_data);
192void *devres_get(struct device *dev, void *new_res,
193 dr_match_t match, void *match_data);
194void *devres_remove(struct device *dev, dr_release_t release,
195 dr_match_t match, void *match_data);
196int devres_destroy(struct device *dev, dr_release_t release,
197 dr_match_t match, void *match_data);
198int devres_release(struct device *dev, dr_release_t release,
199 dr_match_t match, void *match_data);
200
201/* devres group */
202void * __must_check devres_open_group(struct device *dev, void *id, gfp_t gfp);
203void devres_close_group(struct device *dev, void *id);
204void devres_remove_group(struct device *dev, void *id);
205int devres_release_group(struct device *dev, void *id);
206
207/* managed devm_k.alloc/kfree for device drivers */
208void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
209__printf(3, 0) char *devm_kvasprintf(struct device *dev, gfp_t gfp,
210 const char *fmt, va_list ap) __malloc;
211__printf(3, 4) char *devm_kasprintf(struct device *dev, gfp_t gfp,
212 const char *fmt, ...) __malloc;
213static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
214{
215 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
216}
217static inline void *devm_kmalloc_array(struct device *dev,
218 size_t n, size_t size, gfp_t flags)
219{
220 size_t bytes;
221
222 if (unlikely(check_mul_overflow(n, size, &bytes)))
223 return NULL;
224
225 return devm_kmalloc(dev, bytes, flags);
226}
227static inline void *devm_kcalloc(struct device *dev,
228 size_t n, size_t size, gfp_t flags)
229{
230 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
231}
232void devm_kfree(struct device *dev, const void *p);
233char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
234const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp);
235void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp);
236
237unsigned long devm_get_free_pages(struct device *dev,
238 gfp_t gfp_mask, unsigned int order);
239void devm_free_pages(struct device *dev, unsigned long addr);
240
241void __iomem *devm_ioremap_resource(struct device *dev,
242 const struct resource *res);
243void __iomem *devm_ioremap_resource_wc(struct device *dev,
244 const struct resource *res);
245
246void __iomem *devm_of_iomap(struct device *dev,
247 struct device_node *node, int index,
248 resource_size_t *size);
249
250/* allows to add/remove a custom action to devres stack */
251int devm_add_action(struct device *dev, void (*action)(void *), void *data);
252void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
253void devm_release_action(struct device *dev, void (*action)(void *), void *data);
254
255static inline int devm_add_action_or_reset(struct device *dev,
256 void (*action)(void *), void *data)
257{
258 int ret;
259
260 ret = devm_add_action(dev, action, data);
261 if (ret)
262 action(data);
263
264 return ret;
265}
266
267/**
268 * devm_alloc_percpu - Resource-managed alloc_percpu
269 * @dev: Device to allocate per-cpu memory for
270 * @type: Type to allocate per-cpu memory for
271 *
272 * Managed alloc_percpu. Per-cpu memory allocated with this function is
273 * automatically freed on driver detach.
274 *
275 * RETURNS:
276 * Pointer to allocated memory on success, NULL on failure.
277 */
278#define devm_alloc_percpu(dev, type) \
279 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
280 __alignof__(type)))
281
282void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
283 size_t align);
284void devm_free_percpu(struct device *dev, void __percpu *pdata);
285
286struct device_dma_parameters {
287 /*
288 * a low level driver may set these to teach IOMMU code about
289 * sg limitations.
290 */
291 unsigned int max_segment_size;
292 unsigned long segment_boundary_mask;
293};
294
295/**
296 * struct device_connection - Device Connection Descriptor
297 * @fwnode: The device node of the connected device
298 * @endpoint: The names of the two devices connected together
299 * @id: Unique identifier for the connection
300 * @list: List head, private, for internal use only
301 *
302 * NOTE: @fwnode is not used together with @endpoint. @fwnode is used when
303 * platform firmware defines the connection. When the connection is registered
304 * with device_connection_add() @endpoint is used instead.
305 */
306struct device_connection {
307 struct fwnode_handle *fwnode;
308 const char *endpoint[2];
309 const char *id;
310 struct list_head list;
311};
312
313typedef void *(*devcon_match_fn_t)(struct device_connection *con, int ep,
314 void *data);
315
316void *fwnode_connection_find_match(struct fwnode_handle *fwnode,
317 const char *con_id, void *data,
318 devcon_match_fn_t match);
319void *device_connection_find_match(struct device *dev, const char *con_id,
320 void *data, devcon_match_fn_t match);
321
322struct device *device_connection_find(struct device *dev, const char *con_id);
323
324void device_connection_add(struct device_connection *con);
325void device_connection_remove(struct device_connection *con);
326
327/**
328 * device_connections_add - Add multiple device connections at once
329 * @cons: Zero terminated array of device connection descriptors
330 */
331static inline void device_connections_add(struct device_connection *cons)
332{
333 struct device_connection *c;
334
335 for (c = cons; c->endpoint[0]; c++)
336 device_connection_add(c);
337}
338
339/**
340 * device_connections_remove - Remove multiple device connections at once
341 * @cons: Zero terminated array of device connection descriptors
342 */
343static inline void device_connections_remove(struct device_connection *cons)
344{
345 struct device_connection *c;
346
347 for (c = cons; c->endpoint[0]; c++)
348 device_connection_remove(c);
349}
350
351/**
352 * enum device_link_state - Device link states.
353 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
354 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
355 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
356 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
357 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
358 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
359 */
360enum device_link_state {
361 DL_STATE_NONE = -1,
362 DL_STATE_DORMANT = 0,
363 DL_STATE_AVAILABLE,
364 DL_STATE_CONSUMER_PROBE,
365 DL_STATE_ACTIVE,
366 DL_STATE_SUPPLIER_UNBIND,
367};
368
369/*
370 * Device link flags.
371 *
372 * STATELESS: The core will not remove this link automatically.
373 * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
374 * PM_RUNTIME: If set, the runtime PM framework will use this link.
375 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
376 * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
377 * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
378 * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
379 * SYNC_STATE_ONLY: Link only affects sync_state() behavior.
380 */
381#define DL_FLAG_STATELESS BIT(0)
382#define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)
383#define DL_FLAG_PM_RUNTIME BIT(2)
384#define DL_FLAG_RPM_ACTIVE BIT(3)
385#define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)
386#define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)
387#define DL_FLAG_MANAGED BIT(6)
388#define DL_FLAG_SYNC_STATE_ONLY BIT(7)
389
390/**
391 * enum dl_dev_state - Device driver presence tracking information.
392 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
393 * @DL_DEV_PROBING: A driver is probing.
394 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
395 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
396 */
397enum dl_dev_state {
398 DL_DEV_NO_DRIVER = 0,
399 DL_DEV_PROBING,
400 DL_DEV_DRIVER_BOUND,
401 DL_DEV_UNBINDING,
402};
403
404/**
405 * struct dev_links_info - Device data related to device links.
406 * @suppliers: List of links to supplier devices.
407 * @consumers: List of links to consumer devices.
408 * @needs_suppliers: Hook to global list of devices waiting for suppliers.
409 * @defer_hook: Hook to global list of devices that have deferred sync_state or
410 * deferred fw_devlink.
411 * @need_for_probe: If needs_suppliers is on a list, this indicates if the
412 * suppliers are needed for probe or not.
413 * @status: Driver status information.
414 */
415struct dev_links_info {
416 struct list_head suppliers;
417 struct list_head consumers;
418 struct list_head needs_suppliers;
419 struct list_head defer_hook;
420 bool need_for_probe;
421 enum dl_dev_state status;
422};
423
424/**
425 * struct device - The basic device structure
426 * @parent: The device's "parent" device, the device to which it is attached.
427 * In most cases, a parent device is some sort of bus or host
428 * controller. If parent is NULL, the device, is a top-level device,
429 * which is not usually what you want.
430 * @p: Holds the private data of the driver core portions of the device.
431 * See the comment of the struct device_private for detail.
432 * @kobj: A top-level, abstract class from which other classes are derived.
433 * @init_name: Initial name of the device.
434 * @type: The type of device.
435 * This identifies the device type and carries type-specific
436 * information.
437 * @mutex: Mutex to synchronize calls to its driver.
438 * @lockdep_mutex: An optional debug lock that a subsystem can use as a
439 * peer lock to gain localized lockdep coverage of the device_lock.
440 * @bus: Type of bus device is on.
441 * @driver: Which driver has allocated this
442 * @platform_data: Platform data specific to the device.
443 * Example: For devices on custom boards, as typical of embedded
444 * and SOC based hardware, Linux often uses platform_data to point
445 * to board-specific structures describing devices and how they
446 * are wired. That can include what ports are available, chip
447 * variants, which GPIO pins act in what additional roles, and so
448 * on. This shrinks the "Board Support Packages" (BSPs) and
449 * minimizes board-specific #ifdefs in drivers.
450 * @driver_data: Private pointer for driver specific info.
451 * @links: Links to suppliers and consumers of this device.
452 * @power: For device power management.
453 * See Documentation/driver-api/pm/devices.rst for details.
454 * @pm_domain: Provide callbacks that are executed during system suspend,
455 * hibernation, system resume and during runtime PM transitions
456 * along with subsystem-level and driver-level callbacks.
457 * @em_pd: device's energy model performance domain
458 * @pins: For device pin management.
459 * See Documentation/driver-api/pinctl.rst for details.
460 * @msi_list: Hosts MSI descriptors
461 * @msi_domain: The generic MSI domain this device is using.
462 * @numa_node: NUMA node this device is close to.
463 * @dma_ops: DMA mapping operations for this device.
464 * @dma_mask: Dma mask (if dma'ble device).
465 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
466 * hardware supports 64-bit addresses for consistent allocations
467 * such descriptors.
468 * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller
469 * DMA limit than the device itself supports.
470 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
471 * @dma_parms: A low level driver may set these to teach IOMMU code about
472 * segment limitations.
473 * @dma_pools: Dma pools (if dma'ble device).
474 * @dma_mem: Internal for coherent mem override.
475 * @cma_area: Contiguous memory area for dma allocations
476 * @archdata: For arch-specific additions.
477 * @of_node: Associated device tree node.
478 * @fwnode: Associated device node supplied by platform firmware.
479 * @devt: For creating the sysfs "dev".
480 * @id: device instance
481 * @devres_lock: Spinlock to protect the resource of the device.
482 * @devres_head: The resources list of the device.
483 * @knode_class: The node used to add the device to the class list.
484 * @class: The class of the device.
485 * @groups: Optional attribute groups.
486 * @release: Callback to free the device after all references have
487 * gone away. This should be set by the allocator of the
488 * device (i.e. the bus driver that discovered the device).
489 * @iommu_group: IOMMU group the device belongs to.
490 * @iommu: Per device generic IOMMU runtime data
491 *
492 * @offline_disabled: If set, the device is permanently online.
493 * @offline: Set after successful invocation of bus type's .offline().
494 * @of_node_reused: Set if the device-tree node is shared with an ancestor
495 * device.
496 * @state_synced: The hardware state of this device has been synced to match
497 * the software state of this device by calling the driver/bus
498 * sync_state() callback.
499 * @dma_coherent: this particular device is dma coherent, even if the
500 * architecture supports non-coherent devices.
501 * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the
502 * streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
503 * and optionall (if the coherent mask is large enough) also
504 * for dma allocations. This flag is managed by the dma ops
505 * instance from ->dma_supported.
506 *
507 * At the lowest level, every device in a Linux system is represented by an
508 * instance of struct device. The device structure contains the information
509 * that the device model core needs to model the system. Most subsystems,
510 * however, track additional information about the devices they host. As a
511 * result, it is rare for devices to be represented by bare device structures;
512 * instead, that structure, like kobject structures, is usually embedded within
513 * a higher-level representation of the device.
514 */
515struct device {
516 struct kobject kobj;
517 struct device *parent;
518
519 struct device_private *p;
520
521 const char *init_name; /* initial name of the device */
522 const struct device_type *type;
523
524 struct bus_type *bus; /* type of bus device is on */
525 struct device_driver *driver; /* which driver has allocated this
526 device */
527 void *platform_data; /* Platform specific data, device
528 core doesn't touch it */
529 void *driver_data; /* Driver data, set and get with
530 dev_set_drvdata/dev_get_drvdata */
531#ifdef CONFIG_PROVE_LOCKING
532 struct mutex lockdep_mutex;
533#endif
534 struct mutex mutex; /* mutex to synchronize calls to
535 * its driver.
536 */
537
538 struct dev_links_info links;
539 struct dev_pm_info power;
540 struct dev_pm_domain *pm_domain;
541
542#ifdef CONFIG_ENERGY_MODEL
543 struct em_perf_domain *em_pd;
544#endif
545
546#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
547 struct irq_domain *msi_domain;
548#endif
549#ifdef CONFIG_PINCTRL
550 struct dev_pin_info *pins;
551#endif
552#ifdef CONFIG_GENERIC_MSI_IRQ
553 struct list_head msi_list;
554#endif
555#ifdef CONFIG_DMA_OPS
556 const struct dma_map_ops *dma_ops;
557#endif
558 u64 *dma_mask; /* dma mask (if dma'able device) */
559 u64 coherent_dma_mask;/* Like dma_mask, but for
560 alloc_coherent mappings as
561 not all hardware supports
562 64 bit addresses for consistent
563 allocations such descriptors. */
564 u64 bus_dma_limit; /* upstream dma constraint */
565 unsigned long dma_pfn_offset;
566
567 struct device_dma_parameters *dma_parms;
568
569 struct list_head dma_pools; /* dma pools (if dma'ble) */
570
571#ifdef CONFIG_DMA_DECLARE_COHERENT
572 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
573 override */
574#endif
575#ifdef CONFIG_DMA_CMA
576 struct cma *cma_area; /* contiguous memory area for dma
577 allocations */
578#endif
579 /* arch specific additions */
580 struct dev_archdata archdata;
581
582 struct device_node *of_node; /* associated device tree node */
583 struct fwnode_handle *fwnode; /* firmware device node */
584
585#ifdef CONFIG_NUMA
586 int numa_node; /* NUMA node this device is close to */
587#endif
588 dev_t devt; /* dev_t, creates the sysfs "dev" */
589 u32 id; /* device instance */
590
591 spinlock_t devres_lock;
592 struct list_head devres_head;
593
594 struct class *class;
595 const struct attribute_group **groups; /* optional groups */
596
597 void (*release)(struct device *dev);
598 struct iommu_group *iommu_group;
599 struct dev_iommu *iommu;
600
601 bool offline_disabled:1;
602 bool offline:1;
603 bool of_node_reused:1;
604 bool state_synced:1;
605#if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
606 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
607 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
608 bool dma_coherent:1;
609#endif
610#ifdef CONFIG_DMA_OPS_BYPASS
611 bool dma_ops_bypass : 1;
612#endif
613};
614
615/**
616 * struct device_link - Device link representation.
617 * @supplier: The device on the supplier end of the link.
618 * @s_node: Hook to the supplier device's list of links to consumers.
619 * @consumer: The device on the consumer end of the link.
620 * @c_node: Hook to the consumer device's list of links to suppliers.
621 * @link_dev: device used to expose link details in sysfs
622 * @status: The state of the link (with respect to the presence of drivers).
623 * @flags: Link flags.
624 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
625 * @kref: Count repeated addition of the same link.
626 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
627 * @supplier_preactivated: Supplier has been made active before consumer probe.
628 */
629struct device_link {
630 struct device *supplier;
631 struct list_head s_node;
632 struct device *consumer;
633 struct list_head c_node;
634 struct device link_dev;
635 enum device_link_state status;
636 u32 flags;
637 refcount_t rpm_active;
638 struct kref kref;
639#ifdef CONFIG_SRCU
640 struct rcu_head rcu_head;
641#endif
642 bool supplier_preactivated; /* Owned by consumer probe. */
643};
644
645static inline struct device *kobj_to_dev(struct kobject *kobj)
646{
647 return container_of(kobj, struct device, kobj);
648}
649
650/**
651 * device_iommu_mapped - Returns true when the device DMA is translated
652 * by an IOMMU
653 * @dev: Device to perform the check on
654 */
655static inline bool device_iommu_mapped(struct device *dev)
656{
657 return (dev->iommu_group != NULL);
658}
659
660/* Get the wakeup routines, which depend on struct device */
661#include <linux/pm_wakeup.h>
662
663static inline const char *dev_name(const struct device *dev)
664{
665 /* Use the init name until the kobject becomes available */
666 if (dev->init_name)
667 return dev->init_name;
668
669 return kobject_name(&dev->kobj);
670}
671
672__printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);
673
674#ifdef CONFIG_NUMA
675static inline int dev_to_node(struct device *dev)
676{
677 return dev->numa_node;
678}
679static inline void set_dev_node(struct device *dev, int node)
680{
681 dev->numa_node = node;
682}
683#else
684static inline int dev_to_node(struct device *dev)
685{
686 return NUMA_NO_NODE;
687}
688static inline void set_dev_node(struct device *dev, int node)
689{
690}
691#endif
692
693static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
694{
695#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
696 return dev->msi_domain;
697#else
698 return NULL;
699#endif
700}
701
702static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
703{
704#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
705 dev->msi_domain = d;
706#endif
707}
708
709static inline void *dev_get_drvdata(const struct device *dev)
710{
711 return dev->driver_data;
712}
713
714static inline void dev_set_drvdata(struct device *dev, void *data)
715{
716 dev->driver_data = data;
717}
718
719static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
720{
721 return dev ? dev->power.subsys_data : NULL;
722}
723
724static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
725{
726 return dev->kobj.uevent_suppress;
727}
728
729static inline void dev_set_uevent_suppress(struct device *dev, int val)
730{
731 dev->kobj.uevent_suppress = val;
732}
733
734static inline int device_is_registered(struct device *dev)
735{
736 return dev->kobj.state_in_sysfs;
737}
738
739static inline void device_enable_async_suspend(struct device *dev)
740{
741 if (!dev->power.is_prepared)
742 dev->power.async_suspend = true;
743}
744
745static inline void device_disable_async_suspend(struct device *dev)
746{
747 if (!dev->power.is_prepared)
748 dev->power.async_suspend = false;
749}
750
751static inline bool device_async_suspend_enabled(struct device *dev)
752{
753 return !!dev->power.async_suspend;
754}
755
756static inline bool device_pm_not_required(struct device *dev)
757{
758 return dev->power.no_pm;
759}
760
761static inline void device_set_pm_not_required(struct device *dev)
762{
763 dev->power.no_pm = true;
764}
765
766static inline void dev_pm_syscore_device(struct device *dev, bool val)
767{
768#ifdef CONFIG_PM_SLEEP
769 dev->power.syscore = val;
770#endif
771}
772
773static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
774{
775 dev->power.driver_flags = flags;
776}
777
778static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
779{
780 return !!(dev->power.driver_flags & flags);
781}
782
783static inline void device_lock(struct device *dev)
784{
785 mutex_lock(&dev->mutex);
786}
787
788static inline int device_lock_interruptible(struct device *dev)
789{
790 return mutex_lock_interruptible(&dev->mutex);
791}
792
793static inline int device_trylock(struct device *dev)
794{
795 return mutex_trylock(&dev->mutex);
796}
797
798static inline void device_unlock(struct device *dev)
799{
800 mutex_unlock(&dev->mutex);
801}
802
803static inline void device_lock_assert(struct device *dev)
804{
805 lockdep_assert_held(&dev->mutex);
806}
807
808static inline struct device_node *dev_of_node(struct device *dev)
809{
810 if (!IS_ENABLED(CONFIG_OF) || !dev)
811 return NULL;
812 return dev->of_node;
813}
814
815static inline bool dev_has_sync_state(struct device *dev)
816{
817 if (!dev)
818 return false;
819 if (dev->driver && dev->driver->sync_state)
820 return true;
821 if (dev->bus && dev->bus->sync_state)
822 return true;
823 return false;
824}
825
826/*
827 * High level routines for use by the bus drivers
828 */
829int __must_check device_register(struct device *dev);
830void device_unregister(struct device *dev);
831void device_initialize(struct device *dev);
832int __must_check device_add(struct device *dev);
833void device_del(struct device *dev);
834int device_for_each_child(struct device *dev, void *data,
835 int (*fn)(struct device *dev, void *data));
836int device_for_each_child_reverse(struct device *dev, void *data,
837 int (*fn)(struct device *dev, void *data));
838struct device *device_find_child(struct device *dev, void *data,
839 int (*match)(struct device *dev, void *data));
840struct device *device_find_child_by_name(struct device *parent,
841 const char *name);
842int device_rename(struct device *dev, const char *new_name);
843int device_move(struct device *dev, struct device *new_parent,
844 enum dpm_order dpm_order);
845int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
846const char *device_get_devnode(struct device *dev, umode_t *mode, kuid_t *uid,
847 kgid_t *gid, const char **tmp);
848int device_is_dependent(struct device *dev, void *target);
849
850static inline bool device_supports_offline(struct device *dev)
851{
852 return dev->bus && dev->bus->offline && dev->bus->online;
853}
854
855void lock_device_hotplug(void);
856void unlock_device_hotplug(void);
857int lock_device_hotplug_sysfs(void);
858int device_offline(struct device *dev);
859int device_online(struct device *dev);
860void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
861void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
862void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
863
864static inline int dev_num_vf(struct device *dev)
865{
866 if (dev->bus && dev->bus->num_vf)
867 return dev->bus->num_vf(dev);
868 return 0;
869}
870
871/*
872 * Root device objects for grouping under /sys/devices
873 */
874struct device *__root_device_register(const char *name, struct module *owner);
875
876/* This is a macro to avoid include problems with THIS_MODULE */
877#define root_device_register(name) \
878 __root_device_register(name, THIS_MODULE)
879
880void root_device_unregister(struct device *root);
881
882static inline void *dev_get_platdata(const struct device *dev)
883{
884 return dev->platform_data;
885}
886
887/*
888 * Manual binding of a device to driver. See drivers/base/bus.c
889 * for information on use.
890 */
891int __must_check device_bind_driver(struct device *dev);
892void device_release_driver(struct device *dev);
893int __must_check device_attach(struct device *dev);
894int __must_check driver_attach(struct device_driver *drv);
895void device_initial_probe(struct device *dev);
896int __must_check device_reprobe(struct device *dev);
897
898bool device_is_bound(struct device *dev);
899
900/*
901 * Easy functions for dynamically creating devices on the fly
902 */
903__printf(5, 6) struct device *
904device_create(struct class *cls, struct device *parent, dev_t devt,
905 void *drvdata, const char *fmt, ...);
906__printf(6, 7) struct device *
907device_create_with_groups(struct class *cls, struct device *parent, dev_t devt,
908 void *drvdata, const struct attribute_group **groups,
909 const char *fmt, ...);
910void device_destroy(struct class *cls, dev_t devt);
911
912int __must_check device_add_groups(struct device *dev,
913 const struct attribute_group **groups);
914void device_remove_groups(struct device *dev,
915 const struct attribute_group **groups);
916
917static inline int __must_check device_add_group(struct device *dev,
918 const struct attribute_group *grp)
919{
920 const struct attribute_group *groups[] = { grp, NULL };
921
922 return device_add_groups(dev, groups);
923}
924
925static inline void device_remove_group(struct device *dev,
926 const struct attribute_group *grp)
927{
928 const struct attribute_group *groups[] = { grp, NULL };
929
930 return device_remove_groups(dev, groups);
931}
932
933int __must_check devm_device_add_groups(struct device *dev,
934 const struct attribute_group **groups);
935void devm_device_remove_groups(struct device *dev,
936 const struct attribute_group **groups);
937int __must_check devm_device_add_group(struct device *dev,
938 const struct attribute_group *grp);
939void devm_device_remove_group(struct device *dev,
940 const struct attribute_group *grp);
941
942/*
943 * Platform "fixup" functions - allow the platform to have their say
944 * about devices and actions that the general device layer doesn't
945 * know about.
946 */
947/* Notify platform of device discovery */
948extern int (*platform_notify)(struct device *dev);
949
950extern int (*platform_notify_remove)(struct device *dev);
951
952
953/*
954 * get_device - atomically increment the reference count for the device.
955 *
956 */
957struct device *get_device(struct device *dev);
958void put_device(struct device *dev);
959bool kill_device(struct device *dev);
960
961#ifdef CONFIG_DEVTMPFS
962int devtmpfs_mount(void);
963#else
964static inline int devtmpfs_mount(void) { return 0; }
965#endif
966
967/* drivers/base/power/shutdown.c */
968void device_shutdown(void);
969
970/* debugging and troubleshooting/diagnostic helpers. */
971const char *dev_driver_string(const struct device *dev);
972
973/* Device links interface. */
974struct device_link *device_link_add(struct device *consumer,
975 struct device *supplier, u32 flags);
976void device_link_del(struct device_link *link);
977void device_link_remove(void *consumer, struct device *supplier);
978void device_links_supplier_sync_state_pause(void);
979void device_links_supplier_sync_state_resume(void);
980
981extern __printf(3, 4)
982int dev_err_probe(const struct device *dev, int err, const char *fmt, ...);
983
984/* Create alias, so I can be autoloaded. */
985#define MODULE_ALIAS_CHARDEV(major,minor) \
986 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
987#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
988 MODULE_ALIAS("char-major-" __stringify(major) "-*")
989
990#ifdef CONFIG_SYSFS_DEPRECATED
991extern long sysfs_deprecated;
992#else
993#define sysfs_deprecated 0
994#endif
995
996#endif /* _DEVICE_H_ */
1/*
2 * device.h - generic, centralized driver model
3 *
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
7 *
8 * This file is released under the GPLv2
9 *
10 * See Documentation/driver-model/ for more information.
11 */
12
13#ifndef _DEVICE_H_
14#define _DEVICE_H_
15
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/ratelimit.h>
27#include <asm/device.h>
28
29struct device;
30struct device_private;
31struct device_driver;
32struct driver_private;
33struct module;
34struct class;
35struct subsys_private;
36struct bus_type;
37struct device_node;
38struct iommu_ops;
39
40struct bus_attribute {
41 struct attribute attr;
42 ssize_t (*show)(struct bus_type *bus, char *buf);
43 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
44};
45
46#define BUS_ATTR(_name, _mode, _show, _store) \
47struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
48
49extern int __must_check bus_create_file(struct bus_type *,
50 struct bus_attribute *);
51extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
52
53/**
54 * struct bus_type - The bus type of the device
55 *
56 * @name: The name of the bus.
57 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
58 * @dev_root: Default device to use as the parent.
59 * @bus_attrs: Default attributes of the bus.
60 * @dev_attrs: Default attributes of the devices on the bus.
61 * @drv_attrs: Default attributes of the device drivers on the bus.
62 * @match: Called, perhaps multiple times, whenever a new device or driver
63 * is added for this bus. It should return a nonzero value if the
64 * given device can be handled by the given driver.
65 * @uevent: Called when a device is added, removed, or a few other things
66 * that generate uevents to add the environment variables.
67 * @probe: Called when a new device or driver add to this bus, and callback
68 * the specific driver's probe to initial the matched device.
69 * @remove: Called when a device removed from this bus.
70 * @shutdown: Called at shut-down time to quiesce the device.
71 * @suspend: Called when a device on this bus wants to go to sleep mode.
72 * @resume: Called to bring a device on this bus out of sleep mode.
73 * @pm: Power management operations of this bus, callback the specific
74 * device driver's pm-ops.
75 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
76 * driver implementations to a bus and allow the driver to do
77 * bus-specific setup
78 * @p: The private data of the driver core, only the driver core can
79 * touch this.
80 *
81 * A bus is a channel between the processor and one or more devices. For the
82 * purposes of the device model, all devices are connected via a bus, even if
83 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
84 * A USB controller is usually a PCI device, for example. The device model
85 * represents the actual connections between buses and the devices they control.
86 * A bus is represented by the bus_type structure. It contains the name, the
87 * default attributes, the bus' methods, PM operations, and the driver core's
88 * private data.
89 */
90struct bus_type {
91 const char *name;
92 const char *dev_name;
93 struct device *dev_root;
94 struct bus_attribute *bus_attrs;
95 struct device_attribute *dev_attrs;
96 struct driver_attribute *drv_attrs;
97
98 int (*match)(struct device *dev, struct device_driver *drv);
99 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
100 int (*probe)(struct device *dev);
101 int (*remove)(struct device *dev);
102 void (*shutdown)(struct device *dev);
103
104 int (*suspend)(struct device *dev, pm_message_t state);
105 int (*resume)(struct device *dev);
106
107 const struct dev_pm_ops *pm;
108
109 struct iommu_ops *iommu_ops;
110
111 struct subsys_private *p;
112};
113
114/* This is a #define to keep the compiler from merging different
115 * instances of the __key variable */
116#define bus_register(subsys) \
117({ \
118 static struct lock_class_key __key; \
119 __bus_register(subsys, &__key); \
120})
121extern int __must_check __bus_register(struct bus_type *bus,
122 struct lock_class_key *key);
123extern void bus_unregister(struct bus_type *bus);
124
125extern int __must_check bus_rescan_devices(struct bus_type *bus);
126
127/* iterator helpers for buses */
128struct subsys_dev_iter {
129 struct klist_iter ki;
130 const struct device_type *type;
131};
132void subsys_dev_iter_init(struct subsys_dev_iter *iter,
133 struct bus_type *subsys,
134 struct device *start,
135 const struct device_type *type);
136struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
137void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
138
139int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
140 int (*fn)(struct device *dev, void *data));
141struct device *bus_find_device(struct bus_type *bus, struct device *start,
142 void *data,
143 int (*match)(struct device *dev, void *data));
144struct device *bus_find_device_by_name(struct bus_type *bus,
145 struct device *start,
146 const char *name);
147struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
148 struct device *hint);
149int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
150 void *data, int (*fn)(struct device_driver *, void *));
151void bus_sort_breadthfirst(struct bus_type *bus,
152 int (*compare)(const struct device *a,
153 const struct device *b));
154/*
155 * Bus notifiers: Get notified of addition/removal of devices
156 * and binding/unbinding of drivers to devices.
157 * In the long run, it should be a replacement for the platform
158 * notify hooks.
159 */
160struct notifier_block;
161
162extern int bus_register_notifier(struct bus_type *bus,
163 struct notifier_block *nb);
164extern int bus_unregister_notifier(struct bus_type *bus,
165 struct notifier_block *nb);
166
167/* All 4 notifers below get called with the target struct device *
168 * as an argument. Note that those functions are likely to be called
169 * with the device lock held in the core, so be careful.
170 */
171#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
172#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
173#define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
174 bound */
175#define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
176#define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
177 unbound */
178#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
179 from the device */
180
181extern struct kset *bus_get_kset(struct bus_type *bus);
182extern struct klist *bus_get_device_klist(struct bus_type *bus);
183
184/**
185 * struct device_driver - The basic device driver structure
186 * @name: Name of the device driver.
187 * @bus: The bus which the device of this driver belongs to.
188 * @owner: The module owner.
189 * @mod_name: Used for built-in modules.
190 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
191 * @of_match_table: The open firmware table.
192 * @probe: Called to query the existence of a specific device,
193 * whether this driver can work with it, and bind the driver
194 * to a specific device.
195 * @remove: Called when the device is removed from the system to
196 * unbind a device from this driver.
197 * @shutdown: Called at shut-down time to quiesce the device.
198 * @suspend: Called to put the device to sleep mode. Usually to a
199 * low power state.
200 * @resume: Called to bring a device from sleep mode.
201 * @groups: Default attributes that get created by the driver core
202 * automatically.
203 * @pm: Power management operations of the device which matched
204 * this driver.
205 * @p: Driver core's private data, no one other than the driver
206 * core can touch this.
207 *
208 * The device driver-model tracks all of the drivers known to the system.
209 * The main reason for this tracking is to enable the driver core to match
210 * up drivers with new devices. Once drivers are known objects within the
211 * system, however, a number of other things become possible. Device drivers
212 * can export information and configuration variables that are independent
213 * of any specific device.
214 */
215struct device_driver {
216 const char *name;
217 struct bus_type *bus;
218
219 struct module *owner;
220 const char *mod_name; /* used for built-in modules */
221
222 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
223
224 const struct of_device_id *of_match_table;
225
226 int (*probe) (struct device *dev);
227 int (*remove) (struct device *dev);
228 void (*shutdown) (struct device *dev);
229 int (*suspend) (struct device *dev, pm_message_t state);
230 int (*resume) (struct device *dev);
231 const struct attribute_group **groups;
232
233 const struct dev_pm_ops *pm;
234
235 struct driver_private *p;
236};
237
238
239extern int __must_check driver_register(struct device_driver *drv);
240extern void driver_unregister(struct device_driver *drv);
241
242extern struct device_driver *driver_find(const char *name,
243 struct bus_type *bus);
244extern int driver_probe_done(void);
245extern void wait_for_device_probe(void);
246
247
248/* sysfs interface for exporting driver attributes */
249
250struct driver_attribute {
251 struct attribute attr;
252 ssize_t (*show)(struct device_driver *driver, char *buf);
253 ssize_t (*store)(struct device_driver *driver, const char *buf,
254 size_t count);
255};
256
257#define DRIVER_ATTR(_name, _mode, _show, _store) \
258struct driver_attribute driver_attr_##_name = \
259 __ATTR(_name, _mode, _show, _store)
260
261extern int __must_check driver_create_file(struct device_driver *driver,
262 const struct driver_attribute *attr);
263extern void driver_remove_file(struct device_driver *driver,
264 const struct driver_attribute *attr);
265
266extern int __must_check driver_for_each_device(struct device_driver *drv,
267 struct device *start,
268 void *data,
269 int (*fn)(struct device *dev,
270 void *));
271struct device *driver_find_device(struct device_driver *drv,
272 struct device *start, void *data,
273 int (*match)(struct device *dev, void *data));
274
275/**
276 * struct subsys_interface - interfaces to device functions
277 * @name: name of the device function
278 * @subsys: subsytem of the devices to attach to
279 * @node: the list of functions registered at the subsystem
280 * @add_dev: device hookup to device function handler
281 * @remove_dev: device hookup to device function handler
282 *
283 * Simple interfaces attached to a subsystem. Multiple interfaces can
284 * attach to a subsystem and its devices. Unlike drivers, they do not
285 * exclusively claim or control devices. Interfaces usually represent
286 * a specific functionality of a subsystem/class of devices.
287 */
288struct subsys_interface {
289 const char *name;
290 struct bus_type *subsys;
291 struct list_head node;
292 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
293 int (*remove_dev)(struct device *dev, struct subsys_interface *sif);
294};
295
296int subsys_interface_register(struct subsys_interface *sif);
297void subsys_interface_unregister(struct subsys_interface *sif);
298
299int subsys_system_register(struct bus_type *subsys,
300 const struct attribute_group **groups);
301
302/**
303 * struct class - device classes
304 * @name: Name of the class.
305 * @owner: The module owner.
306 * @class_attrs: Default attributes of this class.
307 * @dev_attrs: Default attributes of the devices belong to the class.
308 * @dev_bin_attrs: Default binary attributes of the devices belong to the class.
309 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
310 * @dev_uevent: Called when a device is added, removed from this class, or a
311 * few other things that generate uevents to add the environment
312 * variables.
313 * @devnode: Callback to provide the devtmpfs.
314 * @class_release: Called to release this class.
315 * @dev_release: Called to release the device.
316 * @suspend: Used to put the device to sleep mode, usually to a low power
317 * state.
318 * @resume: Used to bring the device from the sleep mode.
319 * @ns_type: Callbacks so sysfs can detemine namespaces.
320 * @namespace: Namespace of the device belongs to this class.
321 * @pm: The default device power management operations of this class.
322 * @p: The private data of the driver core, no one other than the
323 * driver core can touch this.
324 *
325 * A class is a higher-level view of a device that abstracts out low-level
326 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
327 * at the class level, they are all simply disks. Classes allow user space
328 * to work with devices based on what they do, rather than how they are
329 * connected or how they work.
330 */
331struct class {
332 const char *name;
333 struct module *owner;
334
335 struct class_attribute *class_attrs;
336 struct device_attribute *dev_attrs;
337 struct bin_attribute *dev_bin_attrs;
338 struct kobject *dev_kobj;
339
340 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
341 char *(*devnode)(struct device *dev, umode_t *mode);
342
343 void (*class_release)(struct class *class);
344 void (*dev_release)(struct device *dev);
345
346 int (*suspend)(struct device *dev, pm_message_t state);
347 int (*resume)(struct device *dev);
348
349 const struct kobj_ns_type_operations *ns_type;
350 const void *(*namespace)(struct device *dev);
351
352 const struct dev_pm_ops *pm;
353
354 struct subsys_private *p;
355};
356
357struct class_dev_iter {
358 struct klist_iter ki;
359 const struct device_type *type;
360};
361
362extern struct kobject *sysfs_dev_block_kobj;
363extern struct kobject *sysfs_dev_char_kobj;
364extern int __must_check __class_register(struct class *class,
365 struct lock_class_key *key);
366extern void class_unregister(struct class *class);
367
368/* This is a #define to keep the compiler from merging different
369 * instances of the __key variable */
370#define class_register(class) \
371({ \
372 static struct lock_class_key __key; \
373 __class_register(class, &__key); \
374})
375
376struct class_compat;
377struct class_compat *class_compat_register(const char *name);
378void class_compat_unregister(struct class_compat *cls);
379int class_compat_create_link(struct class_compat *cls, struct device *dev,
380 struct device *device_link);
381void class_compat_remove_link(struct class_compat *cls, struct device *dev,
382 struct device *device_link);
383
384extern void class_dev_iter_init(struct class_dev_iter *iter,
385 struct class *class,
386 struct device *start,
387 const struct device_type *type);
388extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
389extern void class_dev_iter_exit(struct class_dev_iter *iter);
390
391extern int class_for_each_device(struct class *class, struct device *start,
392 void *data,
393 int (*fn)(struct device *dev, void *data));
394extern struct device *class_find_device(struct class *class,
395 struct device *start, void *data,
396 int (*match)(struct device *, void *));
397
398struct class_attribute {
399 struct attribute attr;
400 ssize_t (*show)(struct class *class, struct class_attribute *attr,
401 char *buf);
402 ssize_t (*store)(struct class *class, struct class_attribute *attr,
403 const char *buf, size_t count);
404 const void *(*namespace)(struct class *class,
405 const struct class_attribute *attr);
406};
407
408#define CLASS_ATTR(_name, _mode, _show, _store) \
409struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
410
411extern int __must_check class_create_file(struct class *class,
412 const struct class_attribute *attr);
413extern void class_remove_file(struct class *class,
414 const struct class_attribute *attr);
415
416/* Simple class attribute that is just a static string */
417
418struct class_attribute_string {
419 struct class_attribute attr;
420 char *str;
421};
422
423/* Currently read-only only */
424#define _CLASS_ATTR_STRING(_name, _mode, _str) \
425 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
426#define CLASS_ATTR_STRING(_name, _mode, _str) \
427 struct class_attribute_string class_attr_##_name = \
428 _CLASS_ATTR_STRING(_name, _mode, _str)
429
430extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
431 char *buf);
432
433struct class_interface {
434 struct list_head node;
435 struct class *class;
436
437 int (*add_dev) (struct device *, struct class_interface *);
438 void (*remove_dev) (struct device *, struct class_interface *);
439};
440
441extern int __must_check class_interface_register(struct class_interface *);
442extern void class_interface_unregister(struct class_interface *);
443
444extern struct class * __must_check __class_create(struct module *owner,
445 const char *name,
446 struct lock_class_key *key);
447extern void class_destroy(struct class *cls);
448
449/* This is a #define to keep the compiler from merging different
450 * instances of the __key variable */
451#define class_create(owner, name) \
452({ \
453 static struct lock_class_key __key; \
454 __class_create(owner, name, &__key); \
455})
456
457/*
458 * The type of device, "struct device" is embedded in. A class
459 * or bus can contain devices of different types
460 * like "partitions" and "disks", "mouse" and "event".
461 * This identifies the device type and carries type-specific
462 * information, equivalent to the kobj_type of a kobject.
463 * If "name" is specified, the uevent will contain it in
464 * the DEVTYPE variable.
465 */
466struct device_type {
467 const char *name;
468 const struct attribute_group **groups;
469 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
470 char *(*devnode)(struct device *dev, umode_t *mode);
471 void (*release)(struct device *dev);
472
473 const struct dev_pm_ops *pm;
474};
475
476/* interface for exporting device attributes */
477struct device_attribute {
478 struct attribute attr;
479 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
480 char *buf);
481 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
482 const char *buf, size_t count);
483};
484
485struct dev_ext_attribute {
486 struct device_attribute attr;
487 void *var;
488};
489
490ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
491 char *buf);
492ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
493 const char *buf, size_t count);
494ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
495 char *buf);
496ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
497 const char *buf, size_t count);
498
499#define DEVICE_ATTR(_name, _mode, _show, _store) \
500 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
501#define DEVICE_ULONG_ATTR(_name, _mode, _var) \
502 struct dev_ext_attribute dev_attr_##_name = \
503 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
504#define DEVICE_INT_ATTR(_name, _mode, _var) \
505 struct dev_ext_attribute dev_attr_##_name = \
506 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
507#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
508 struct device_attribute dev_attr_##_name = \
509 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
510
511extern int device_create_file(struct device *device,
512 const struct device_attribute *entry);
513extern void device_remove_file(struct device *dev,
514 const struct device_attribute *attr);
515extern int __must_check device_create_bin_file(struct device *dev,
516 const struct bin_attribute *attr);
517extern void device_remove_bin_file(struct device *dev,
518 const struct bin_attribute *attr);
519extern int device_schedule_callback_owner(struct device *dev,
520 void (*func)(struct device *dev), struct module *owner);
521
522/* This is a macro to avoid include problems with THIS_MODULE */
523#define device_schedule_callback(dev, func) \
524 device_schedule_callback_owner(dev, func, THIS_MODULE)
525
526/* device resource management */
527typedef void (*dr_release_t)(struct device *dev, void *res);
528typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
529
530#ifdef CONFIG_DEBUG_DEVRES
531extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
532 const char *name);
533#define devres_alloc(release, size, gfp) \
534 __devres_alloc(release, size, gfp, #release)
535#else
536extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
537#endif
538extern void devres_free(void *res);
539extern void devres_add(struct device *dev, void *res);
540extern void *devres_find(struct device *dev, dr_release_t release,
541 dr_match_t match, void *match_data);
542extern void *devres_get(struct device *dev, void *new_res,
543 dr_match_t match, void *match_data);
544extern void *devres_remove(struct device *dev, dr_release_t release,
545 dr_match_t match, void *match_data);
546extern int devres_destroy(struct device *dev, dr_release_t release,
547 dr_match_t match, void *match_data);
548extern int devres_release(struct device *dev, dr_release_t release,
549 dr_match_t match, void *match_data);
550
551/* devres group */
552extern void * __must_check devres_open_group(struct device *dev, void *id,
553 gfp_t gfp);
554extern void devres_close_group(struct device *dev, void *id);
555extern void devres_remove_group(struct device *dev, void *id);
556extern int devres_release_group(struct device *dev, void *id);
557
558/* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
559extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
560extern void devm_kfree(struct device *dev, void *p);
561
562void __iomem *devm_request_and_ioremap(struct device *dev,
563 struct resource *res);
564
565struct device_dma_parameters {
566 /*
567 * a low level driver may set these to teach IOMMU code about
568 * sg limitations.
569 */
570 unsigned int max_segment_size;
571 unsigned long segment_boundary_mask;
572};
573
574/**
575 * struct device - The basic device structure
576 * @parent: The device's "parent" device, the device to which it is attached.
577 * In most cases, a parent device is some sort of bus or host
578 * controller. If parent is NULL, the device, is a top-level device,
579 * which is not usually what you want.
580 * @p: Holds the private data of the driver core portions of the device.
581 * See the comment of the struct device_private for detail.
582 * @kobj: A top-level, abstract class from which other classes are derived.
583 * @init_name: Initial name of the device.
584 * @type: The type of device.
585 * This identifies the device type and carries type-specific
586 * information.
587 * @mutex: Mutex to synchronize calls to its driver.
588 * @bus: Type of bus device is on.
589 * @driver: Which driver has allocated this
590 * @platform_data: Platform data specific to the device.
591 * Example: For devices on custom boards, as typical of embedded
592 * and SOC based hardware, Linux often uses platform_data to point
593 * to board-specific structures describing devices and how they
594 * are wired. That can include what ports are available, chip
595 * variants, which GPIO pins act in what additional roles, and so
596 * on. This shrinks the "Board Support Packages" (BSPs) and
597 * minimizes board-specific #ifdefs in drivers.
598 * @power: For device power management.
599 * See Documentation/power/devices.txt for details.
600 * @pm_domain: Provide callbacks that are executed during system suspend,
601 * hibernation, system resume and during runtime PM transitions
602 * along with subsystem-level and driver-level callbacks.
603 * @numa_node: NUMA node this device is close to.
604 * @dma_mask: Dma mask (if dma'ble device).
605 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
606 * hardware supports 64-bit addresses for consistent allocations
607 * such descriptors.
608 * @dma_parms: A low level driver may set these to teach IOMMU code about
609 * segment limitations.
610 * @dma_pools: Dma pools (if dma'ble device).
611 * @dma_mem: Internal for coherent mem override.
612 * @archdata: For arch-specific additions.
613 * @of_node: Associated device tree node.
614 * @devt: For creating the sysfs "dev".
615 * @id: device instance
616 * @devres_lock: Spinlock to protect the resource of the device.
617 * @devres_head: The resources list of the device.
618 * @knode_class: The node used to add the device to the class list.
619 * @class: The class of the device.
620 * @groups: Optional attribute groups.
621 * @release: Callback to free the device after all references have
622 * gone away. This should be set by the allocator of the
623 * device (i.e. the bus driver that discovered the device).
624 *
625 * At the lowest level, every device in a Linux system is represented by an
626 * instance of struct device. The device structure contains the information
627 * that the device model core needs to model the system. Most subsystems,
628 * however, track additional information about the devices they host. As a
629 * result, it is rare for devices to be represented by bare device structures;
630 * instead, that structure, like kobject structures, is usually embedded within
631 * a higher-level representation of the device.
632 */
633struct device {
634 struct device *parent;
635
636 struct device_private *p;
637
638 struct kobject kobj;
639 const char *init_name; /* initial name of the device */
640 const struct device_type *type;
641
642 struct mutex mutex; /* mutex to synchronize calls to
643 * its driver.
644 */
645
646 struct bus_type *bus; /* type of bus device is on */
647 struct device_driver *driver; /* which driver has allocated this
648 device */
649 void *platform_data; /* Platform specific data, device
650 core doesn't touch it */
651 struct dev_pm_info power;
652 struct dev_pm_domain *pm_domain;
653
654#ifdef CONFIG_NUMA
655 int numa_node; /* NUMA node this device is close to */
656#endif
657 u64 *dma_mask; /* dma mask (if dma'able device) */
658 u64 coherent_dma_mask;/* Like dma_mask, but for
659 alloc_coherent mappings as
660 not all hardware supports
661 64 bit addresses for consistent
662 allocations such descriptors. */
663
664 struct device_dma_parameters *dma_parms;
665
666 struct list_head dma_pools; /* dma pools (if dma'ble) */
667
668 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
669 override */
670#ifdef CONFIG_CMA
671 struct cma *cma_area; /* contiguous memory area for dma
672 allocations */
673#endif
674 /* arch specific additions */
675 struct dev_archdata archdata;
676
677 struct device_node *of_node; /* associated device tree node */
678
679 dev_t devt; /* dev_t, creates the sysfs "dev" */
680 u32 id; /* device instance */
681
682 spinlock_t devres_lock;
683 struct list_head devres_head;
684
685 struct klist_node knode_class;
686 struct class *class;
687 const struct attribute_group **groups; /* optional groups */
688
689 void (*release)(struct device *dev);
690};
691
692/* Get the wakeup routines, which depend on struct device */
693#include <linux/pm_wakeup.h>
694
695static inline const char *dev_name(const struct device *dev)
696{
697 /* Use the init name until the kobject becomes available */
698 if (dev->init_name)
699 return dev->init_name;
700
701 return kobject_name(&dev->kobj);
702}
703
704extern __printf(2, 3)
705int dev_set_name(struct device *dev, const char *name, ...);
706
707#ifdef CONFIG_NUMA
708static inline int dev_to_node(struct device *dev)
709{
710 return dev->numa_node;
711}
712static inline void set_dev_node(struct device *dev, int node)
713{
714 dev->numa_node = node;
715}
716#else
717static inline int dev_to_node(struct device *dev)
718{
719 return -1;
720}
721static inline void set_dev_node(struct device *dev, int node)
722{
723}
724#endif
725
726static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
727{
728 return dev ? dev->power.subsys_data : NULL;
729}
730
731static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
732{
733 return dev->kobj.uevent_suppress;
734}
735
736static inline void dev_set_uevent_suppress(struct device *dev, int val)
737{
738 dev->kobj.uevent_suppress = val;
739}
740
741static inline int device_is_registered(struct device *dev)
742{
743 return dev->kobj.state_in_sysfs;
744}
745
746static inline void device_enable_async_suspend(struct device *dev)
747{
748 if (!dev->power.is_prepared)
749 dev->power.async_suspend = true;
750}
751
752static inline void device_disable_async_suspend(struct device *dev)
753{
754 if (!dev->power.is_prepared)
755 dev->power.async_suspend = false;
756}
757
758static inline bool device_async_suspend_enabled(struct device *dev)
759{
760 return !!dev->power.async_suspend;
761}
762
763static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
764{
765 dev->power.ignore_children = enable;
766}
767
768static inline void device_lock(struct device *dev)
769{
770 mutex_lock(&dev->mutex);
771}
772
773static inline int device_trylock(struct device *dev)
774{
775 return mutex_trylock(&dev->mutex);
776}
777
778static inline void device_unlock(struct device *dev)
779{
780 mutex_unlock(&dev->mutex);
781}
782
783void driver_init(void);
784
785/*
786 * High level routines for use by the bus drivers
787 */
788extern int __must_check device_register(struct device *dev);
789extern void device_unregister(struct device *dev);
790extern void device_initialize(struct device *dev);
791extern int __must_check device_add(struct device *dev);
792extern void device_del(struct device *dev);
793extern int device_for_each_child(struct device *dev, void *data,
794 int (*fn)(struct device *dev, void *data));
795extern struct device *device_find_child(struct device *dev, void *data,
796 int (*match)(struct device *dev, void *data));
797extern int device_rename(struct device *dev, const char *new_name);
798extern int device_move(struct device *dev, struct device *new_parent,
799 enum dpm_order dpm_order);
800extern const char *device_get_devnode(struct device *dev,
801 umode_t *mode, const char **tmp);
802extern void *dev_get_drvdata(const struct device *dev);
803extern int dev_set_drvdata(struct device *dev, void *data);
804
805/*
806 * Root device objects for grouping under /sys/devices
807 */
808extern struct device *__root_device_register(const char *name,
809 struct module *owner);
810
811/*
812 * This is a macro to avoid include problems with THIS_MODULE,
813 * just as per what is done for device_schedule_callback() above.
814 */
815#define root_device_register(name) \
816 __root_device_register(name, THIS_MODULE)
817
818extern void root_device_unregister(struct device *root);
819
820static inline void *dev_get_platdata(const struct device *dev)
821{
822 return dev->platform_data;
823}
824
825/*
826 * Manual binding of a device to driver. See drivers/base/bus.c
827 * for information on use.
828 */
829extern int __must_check device_bind_driver(struct device *dev);
830extern void device_release_driver(struct device *dev);
831extern int __must_check device_attach(struct device *dev);
832extern int __must_check driver_attach(struct device_driver *drv);
833extern int __must_check device_reprobe(struct device *dev);
834
835/*
836 * Easy functions for dynamically creating devices on the fly
837 */
838extern struct device *device_create_vargs(struct class *cls,
839 struct device *parent,
840 dev_t devt,
841 void *drvdata,
842 const char *fmt,
843 va_list vargs);
844extern __printf(5, 6)
845struct device *device_create(struct class *cls, struct device *parent,
846 dev_t devt, void *drvdata,
847 const char *fmt, ...);
848extern void device_destroy(struct class *cls, dev_t devt);
849
850/*
851 * Platform "fixup" functions - allow the platform to have their say
852 * about devices and actions that the general device layer doesn't
853 * know about.
854 */
855/* Notify platform of device discovery */
856extern int (*platform_notify)(struct device *dev);
857
858extern int (*platform_notify_remove)(struct device *dev);
859
860
861/*
862 * get_device - atomically increment the reference count for the device.
863 *
864 */
865extern struct device *get_device(struct device *dev);
866extern void put_device(struct device *dev);
867
868#ifdef CONFIG_DEVTMPFS
869extern int devtmpfs_create_node(struct device *dev);
870extern int devtmpfs_delete_node(struct device *dev);
871extern int devtmpfs_mount(const char *mntdir);
872#else
873static inline int devtmpfs_create_node(struct device *dev) { return 0; }
874static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
875static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
876#endif
877
878/* drivers/base/power/shutdown.c */
879extern void device_shutdown(void);
880
881/* debugging and troubleshooting/diagnostic helpers. */
882extern const char *dev_driver_string(const struct device *dev);
883
884
885#ifdef CONFIG_PRINTK
886
887extern int __dev_printk(const char *level, const struct device *dev,
888 struct va_format *vaf);
889extern __printf(3, 4)
890int dev_printk(const char *level, const struct device *dev,
891 const char *fmt, ...)
892 ;
893extern __printf(2, 3)
894int dev_emerg(const struct device *dev, const char *fmt, ...);
895extern __printf(2, 3)
896int dev_alert(const struct device *dev, const char *fmt, ...);
897extern __printf(2, 3)
898int dev_crit(const struct device *dev, const char *fmt, ...);
899extern __printf(2, 3)
900int dev_err(const struct device *dev, const char *fmt, ...);
901extern __printf(2, 3)
902int dev_warn(const struct device *dev, const char *fmt, ...);
903extern __printf(2, 3)
904int dev_notice(const struct device *dev, const char *fmt, ...);
905extern __printf(2, 3)
906int _dev_info(const struct device *dev, const char *fmt, ...);
907
908#else
909
910static inline int __dev_printk(const char *level, const struct device *dev,
911 struct va_format *vaf)
912{ return 0; }
913static inline __printf(3, 4)
914int dev_printk(const char *level, const struct device *dev,
915 const char *fmt, ...)
916{ return 0; }
917
918static inline __printf(2, 3)
919int dev_emerg(const struct device *dev, const char *fmt, ...)
920{ return 0; }
921static inline __printf(2, 3)
922int dev_crit(const struct device *dev, const char *fmt, ...)
923{ return 0; }
924static inline __printf(2, 3)
925int dev_alert(const struct device *dev, const char *fmt, ...)
926{ return 0; }
927static inline __printf(2, 3)
928int dev_err(const struct device *dev, const char *fmt, ...)
929{ return 0; }
930static inline __printf(2, 3)
931int dev_warn(const struct device *dev, const char *fmt, ...)
932{ return 0; }
933static inline __printf(2, 3)
934int dev_notice(const struct device *dev, const char *fmt, ...)
935{ return 0; }
936static inline __printf(2, 3)
937int _dev_info(const struct device *dev, const char *fmt, ...)
938{ return 0; }
939
940#endif
941
942#define dev_level_ratelimited(dev_level, dev, fmt, ...) \
943do { \
944 static DEFINE_RATELIMIT_STATE(_rs, \
945 DEFAULT_RATELIMIT_INTERVAL, \
946 DEFAULT_RATELIMIT_BURST); \
947 if (__ratelimit(&_rs)) \
948 dev_level(dev, fmt, ##__VA_ARGS__); \
949} while (0)
950
951#define dev_emerg_ratelimited(dev, fmt, ...) \
952 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
953#define dev_alert_ratelimited(dev, fmt, ...) \
954 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
955#define dev_crit_ratelimited(dev, fmt, ...) \
956 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
957#define dev_err_ratelimited(dev, fmt, ...) \
958 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
959#define dev_warn_ratelimited(dev, fmt, ...) \
960 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
961#define dev_notice_ratelimited(dev, fmt, ...) \
962 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
963#define dev_info_ratelimited(dev, fmt, ...) \
964 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
965#define dev_dbg_ratelimited(dev, fmt, ...) \
966 dev_level_ratelimited(dev_dbg, dev, fmt, ##__VA_ARGS__)
967
968/*
969 * Stupid hackaround for existing uses of non-printk uses dev_info
970 *
971 * Note that the definition of dev_info below is actually _dev_info
972 * and a macro is used to avoid redefining dev_info
973 */
974
975#define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
976
977#if defined(CONFIG_DYNAMIC_DEBUG)
978#define dev_dbg(dev, format, ...) \
979do { \
980 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
981} while (0)
982#elif defined(DEBUG)
983#define dev_dbg(dev, format, arg...) \
984 dev_printk(KERN_DEBUG, dev, format, ##arg)
985#else
986#define dev_dbg(dev, format, arg...) \
987({ \
988 if (0) \
989 dev_printk(KERN_DEBUG, dev, format, ##arg); \
990 0; \
991})
992#endif
993
994#ifdef VERBOSE_DEBUG
995#define dev_vdbg dev_dbg
996#else
997#define dev_vdbg(dev, format, arg...) \
998({ \
999 if (0) \
1000 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1001 0; \
1002})
1003#endif
1004
1005/*
1006 * dev_WARN*() acts like dev_printk(), but with the key difference
1007 * of using a WARN/WARN_ON to get the message out, including the
1008 * file/line information and a backtrace.
1009 */
1010#define dev_WARN(dev, format, arg...) \
1011 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
1012
1013#define dev_WARN_ONCE(dev, condition, format, arg...) \
1014 WARN_ONCE(condition, "Device %s\n" format, \
1015 dev_driver_string(dev), ## arg)
1016
1017/* Create alias, so I can be autoloaded. */
1018#define MODULE_ALIAS_CHARDEV(major,minor) \
1019 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1020#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1021 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1022
1023#ifdef CONFIG_SYSFS_DEPRECATED
1024extern long sysfs_deprecated;
1025#else
1026#define sysfs_deprecated 0
1027#endif
1028
1029/**
1030 * module_driver() - Helper macro for drivers that don't do anything
1031 * special in module init/exit. This eliminates a lot of boilerplate.
1032 * Each module may only use this macro once, and calling it replaces
1033 * module_init() and module_exit().
1034 *
1035 * @__driver: driver name
1036 * @__register: register function for this driver type
1037 * @__unregister: unregister function for this driver type
1038 * @...: Additional arguments to be passed to __register and __unregister.
1039 *
1040 * Use this macro to construct bus specific macros for registering
1041 * drivers, and do not use it on its own.
1042 */
1043#define module_driver(__driver, __register, __unregister, ...) \
1044static int __init __driver##_init(void) \
1045{ \
1046 return __register(&(__driver) , ##__VA_ARGS__); \
1047} \
1048module_init(__driver##_init); \
1049static void __exit __driver##_exit(void) \
1050{ \
1051 __unregister(&(__driver) , ##__VA_ARGS__); \
1052} \
1053module_exit(__driver##_exit);
1054
1055#endif /* _DEVICE_H_ */