~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/device.h

Version: ~ [ linux-5.16-rc3 ] ~ [ linux-5.15.5 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.82 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.162 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.218 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.256 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.291 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.293 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 // SPDX-License-Identifier: GPL-2.0
  2 /*
  3  * device.h - generic, centralized driver model
  4  *
  5  * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
  6  * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
  7  * Copyright (c) 2008-2009 Novell Inc.
  8  *
  9  * See Documentation/driver-api/driver-model/ for more information.
 10  */
 11 
 12 #ifndef _DEVICE_H_
 13 #define _DEVICE_H_
 14 
 15 #include <linux/dev_printk.h>
 16 #include <linux/energy_model.h>
 17 #include <linux/ioport.h>
 18 #include <linux/kobject.h>
 19 #include <linux/klist.h>
 20 #include <linux/list.h>
 21 #include <linux/lockdep.h>
 22 #include <linux/compiler.h>
 23 #include <linux/types.h>
 24 #include <linux/mutex.h>
 25 #include <linux/pm.h>
 26 #include <linux/atomic.h>
 27 #include <linux/uidgid.h>
 28 #include <linux/gfp.h>
 29 #include <linux/overflow.h>
 30 #include <linux/device/bus.h>
 31 #include <linux/device/class.h>
 32 #include <linux/device/driver.h>
 33 #include <asm/device.h>
 34 
 35 struct device;
 36 struct device_private;
 37 struct device_driver;
 38 struct driver_private;
 39 struct module;
 40 struct class;
 41 struct subsys_private;
 42 struct device_node;
 43 struct fwnode_handle;
 44 struct iommu_ops;
 45 struct iommu_group;
 46 struct dev_pin_info;
 47 struct dev_iommu;
 48 
 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  */
 62 struct 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 
 70 int subsys_interface_register(struct subsys_interface *sif);
 71 void subsys_interface_unregister(struct subsys_interface *sif);
 72 
 73 int subsys_system_register(struct bus_type *subsys,
 74                            const struct attribute_group **groups);
 75 int 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  */
 87 struct 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 */
 99 struct 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 
107 struct dev_ext_attribute {
108         struct device_attribute attr;
109         void *var;
110 };
111 
112 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
113                           char *buf);
114 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
115                            const char *buf, size_t count);
116 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
117                         char *buf);
118 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
119                          const char *buf, size_t count);
120 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
121                         char *buf);
122 ssize_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 
153 int device_create_file(struct device *device,
154                        const struct device_attribute *entry);
155 void device_remove_file(struct device *dev,
156                         const struct device_attribute *attr);
157 bool device_remove_file_self(struct device *dev,
158                              const struct device_attribute *attr);
159 int __must_check device_create_bin_file(struct device *dev,
160                                         const struct bin_attribute *attr);
161 void device_remove_bin_file(struct device *dev,
162                             const struct bin_attribute *attr);
163 
164 /* device resource management */
165 typedef void (*dr_release_t)(struct device *dev, void *res);
166 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
167 
168 #ifdef CONFIG_DEBUG_DEVRES
169 void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
170                           int nid, const char *name) __malloc;
171 #define devres_alloc(release, size, gfp) \
172         __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
173 #define devres_alloc_node(release, size, gfp, nid) \
174         __devres_alloc_node(release, size, gfp, nid, #release)
175 #else
176 void *devres_alloc_node(dr_release_t release, size_t size,
177                         gfp_t gfp, int nid) __malloc;
178 static 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 
184 void 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);
188 void devres_free(void *res);
189 void devres_add(struct device *dev, void *res);
190 void *devres_find(struct device *dev, dr_release_t release,
191                   dr_match_t match, void *match_data);
192 void *devres_get(struct device *dev, void *new_res,
193                  dr_match_t match, void *match_data);
194 void *devres_remove(struct device *dev, dr_release_t release,
195                     dr_match_t match, void *match_data);
196 int devres_destroy(struct device *dev, dr_release_t release,
197                    dr_match_t match, void *match_data);
198 int devres_release(struct device *dev, dr_release_t release,
199                    dr_match_t match, void *match_data);
200 
201 /* devres group */
202 void * __must_check devres_open_group(struct device *dev, void *id, gfp_t gfp);
203 void devres_close_group(struct device *dev, void *id);
204 void devres_remove_group(struct device *dev, void *id);
205 int devres_release_group(struct device *dev, void *id);
206 
207 /* managed devm_k.alloc/kfree for device drivers */
208 void *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;
213 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
214 {
215         return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
216 }
217 static 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 }
227 static 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 }
232 void devm_kfree(struct device *dev, const void *p);
233 char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
234 const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp);
235 void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp);
236 
237 unsigned long devm_get_free_pages(struct device *dev,
238                                   gfp_t gfp_mask, unsigned int order);
239 void devm_free_pages(struct device *dev, unsigned long addr);
240 
241 void __iomem *devm_ioremap_resource(struct device *dev,
242                                     const struct resource *res);
243 void __iomem *devm_ioremap_resource_wc(struct device *dev,
244                                        const struct resource *res);
245 
246 void __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 */
251 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
252 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
253 void devm_release_action(struct device *dev, void (*action)(void *), void *data);
254 
255 static 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 
282 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
283                                    size_t align);
284 void devm_free_percpu(struct device *dev, void __percpu *pdata);
285 
286 struct 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  */
306 struct device_connection {
307         struct fwnode_handle    *fwnode;
308         const char              *endpoint[2];
309         const char              *id;
310         struct list_head        list;
311 };
312 
313 typedef void *(*devcon_match_fn_t)(struct device_connection *con, int ep,
314                                    void *data);
315 
316 void *fwnode_connection_find_match(struct fwnode_handle *fwnode,
317                                    const char *con_id, void *data,
318                                    devcon_match_fn_t match);
319 void *device_connection_find_match(struct device *dev, const char *con_id,
320                                    void *data, devcon_match_fn_t match);
321 
322 struct device *device_connection_find(struct device *dev, const char *con_id);
323 
324 void device_connection_add(struct device_connection *con);
325 void 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  */
331 static 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  */
343 static 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  */
360 enum 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  */
397 enum 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  */
415 struct 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  */
515 struct 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  */
629 struct 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 
645 static 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  */
655 static 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 
663 static 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
675 static inline int dev_to_node(struct device *dev)
676 {
677         return dev->numa_node;
678 }
679 static inline void set_dev_node(struct device *dev, int node)
680 {
681         dev->numa_node = node;
682 }
683 #else
684 static inline int dev_to_node(struct device *dev)
685 {
686         return NUMA_NO_NODE;
687 }
688 static inline void set_dev_node(struct device *dev, int node)
689 {
690 }
691 #endif
692 
693 static 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 
702 static 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 
709 static inline void *dev_get_drvdata(const struct device *dev)
710 {
711         return dev->driver_data;
712 }
713 
714 static inline void dev_set_drvdata(struct device *dev, void *data)
715 {
716         dev->driver_data = data;
717 }
718 
719 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
720 {
721         return dev ? dev->power.subsys_data : NULL;
722 }
723 
724 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
725 {
726         return dev->kobj.uevent_suppress;
727 }
728 
729 static inline void dev_set_uevent_suppress(struct device *dev, int val)
730 {
731         dev->kobj.uevent_suppress = val;
732 }
733 
734 static inline int device_is_registered(struct device *dev)
735 {
736         return dev->kobj.state_in_sysfs;
737 }
738 
739 static inline void device_enable_async_suspend(struct device *dev)
740 {
741         if (!dev->power.is_prepared)
742                 dev->power.async_suspend = true;
743 }
744 
745 static inline void device_disable_async_suspend(struct device *dev)
746 {
747         if (!dev->power.is_prepared)
748                 dev->power.async_suspend = false;
749 }
750 
751 static inline bool device_async_suspend_enabled(struct device *dev)
752 {
753         return !!dev->power.async_suspend;
754 }
755 
756 static inline bool device_pm_not_required(struct device *dev)
757 {
758         return dev->power.no_pm;
759 }
760 
761 static inline void device_set_pm_not_required(struct device *dev)
762 {
763         dev->power.no_pm = true;
764 }
765 
766 static 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 
773 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
774 {
775         dev->power.driver_flags = flags;
776 }
777 
778 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
779 {
780         return !!(dev->power.driver_flags & flags);
781 }
782 
783 static inline void device_lock(struct device *dev)
784 {
785         mutex_lock(&dev->mutex);
786 }
787 
788 static inline int device_lock_interruptible(struct device *dev)
789 {
790         return mutex_lock_interruptible(&dev->mutex);
791 }
792 
793 static inline int device_trylock(struct device *dev)
794 {
795         return mutex_trylock(&dev->mutex);
796 }
797 
798 static inline void device_unlock(struct device *dev)
799 {
800         mutex_unlock(&dev->mutex);
801 }
802 
803 static inline void device_lock_assert(struct device *dev)
804 {
805         lockdep_assert_held(&dev->mutex);
806 }
807 
808 static 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 
815 static 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  */
829 int __must_check device_register(struct device *dev);
830 void device_unregister(struct device *dev);
831 void device_initialize(struct device *dev);
832 int __must_check device_add(struct device *dev);
833 void device_del(struct device *dev);
834 int device_for_each_child(struct device *dev, void *data,
835                           int (*fn)(struct device *dev, void *data));
836 int device_for_each_child_reverse(struct device *dev, void *data,
837                                   int (*fn)(struct device *dev, void *data));
838 struct device *device_find_child(struct device *dev, void *data,
839                                  int (*match)(struct device *dev, void *data));
840 struct device *device_find_child_by_name(struct device *parent,
841                                          const char *name);
842 int device_rename(struct device *dev, const char *new_name);
843 int device_move(struct device *dev, struct device *new_parent,
844                 enum dpm_order dpm_order);
845 int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
846 const char *device_get_devnode(struct device *dev, umode_t *mode, kuid_t *uid,
847                                kgid_t *gid, const char **tmp);
848 int device_is_dependent(struct device *dev, void *target);
849 
850 static inline bool device_supports_offline(struct device *dev)
851 {
852         return dev->bus && dev->bus->offline && dev->bus->online;
853 }
854 
855 void lock_device_hotplug(void);
856 void unlock_device_hotplug(void);
857 int lock_device_hotplug_sysfs(void);
858 int device_offline(struct device *dev);
859 int device_online(struct device *dev);
860 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
861 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
862 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
863 
864 static 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  */
874 struct 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 
880 void root_device_unregister(struct device *root);
881 
882 static 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  */
891 int __must_check device_bind_driver(struct device *dev);
892 void device_release_driver(struct device *dev);
893 int  __must_check device_attach(struct device *dev);
894 int __must_check driver_attach(struct device_driver *drv);
895 void device_initial_probe(struct device *dev);
896 int __must_check device_reprobe(struct device *dev);
897 
898 bool 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 *
904 device_create(struct class *cls, struct device *parent, dev_t devt,
905               void *drvdata, const char *fmt, ...);
906 __printf(6, 7) struct device *
907 device_create_with_groups(struct class *cls, struct device *parent, dev_t devt,
908                           void *drvdata, const struct attribute_group **groups,
909                           const char *fmt, ...);
910 void device_destroy(struct class *cls, dev_t devt);
911 
912 int __must_check device_add_groups(struct device *dev,
913                                    const struct attribute_group **groups);
914 void device_remove_groups(struct device *dev,
915                           const struct attribute_group **groups);
916 
917 static 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 
925 static 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 
933 int __must_check devm_device_add_groups(struct device *dev,
934                                         const struct attribute_group **groups);
935 void devm_device_remove_groups(struct device *dev,
936                                const struct attribute_group **groups);
937 int __must_check devm_device_add_group(struct device *dev,
938                                        const struct attribute_group *grp);
939 void 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 */
948 extern int (*platform_notify)(struct device *dev);
949 
950 extern int (*platform_notify_remove)(struct device *dev);
951 
952 
953 /*
954  * get_device - atomically increment the reference count for the device.
955  *
956  */
957 struct device *get_device(struct device *dev);
958 void put_device(struct device *dev);
959 bool kill_device(struct device *dev);
960 
961 #ifdef CONFIG_DEVTMPFS
962 int devtmpfs_mount(void);
963 #else
964 static inline int devtmpfs_mount(void) { return 0; }
965 #endif
966 
967 /* drivers/base/power/shutdown.c */
968 void device_shutdown(void);
969 
970 /* debugging and troubleshooting/diagnostic helpers. */
971 const char *dev_driver_string(const struct device *dev);
972 
973 /* Device links interface. */
974 struct device_link *device_link_add(struct device *consumer,
975                                     struct device *supplier, u32 flags);
976 void device_link_del(struct device_link *link);
977 void device_link_remove(void *consumer, struct device *supplier);
978 void device_links_supplier_sync_state_pause(void);
979 void device_links_supplier_sync_state_resume(void);
980 
981 extern __printf(3, 4)
982 int 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
991 extern long sysfs_deprecated;
992 #else
993 #define sysfs_deprecated 0
994 #endif
995 
996 #endif /* _DEVICE_H_ */
997 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp