LCOV - code coverage report
Current view: top level - include/linux - device.h (source / functions) Hit Total Coverage
Test: landlock.info Lines: 50 70 71.4 %
Date: 2021-04-22 12:43:58 Functions: 2 3 66.7 %

          Line data    Source code
       1             : // SPDX-License-Identifier: GPL-2.0
       2             : /*
       3             :  * device.h - generic, centralized driver model
       4             :  *
       5             :  * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
       6             :  * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
       7             :  * Copyright (c) 2008-2009 Novell Inc.
       8             :  *
       9             :  * See Documentation/driver-api/driver-model/ for more information.
      10             :  */
      11             : 
      12             : #ifndef _DEVICE_H_
      13             : #define _DEVICE_H_
      14             : 
      15             : #include <linux/dev_printk.h>
      16             : #include <linux/energy_model.h>
      17             : #include <linux/ioport.h>
      18             : #include <linux/kobject.h>
      19             : #include <linux/klist.h>
      20             : #include <linux/list.h>
      21             : #include <linux/lockdep.h>
      22             : #include <linux/compiler.h>
      23             : #include <linux/types.h>
      24             : #include <linux/mutex.h>
      25             : #include <linux/pm.h>
      26             : #include <linux/atomic.h>
      27             : #include <linux/uidgid.h>
      28             : #include <linux/gfp.h>
      29             : #include <linux/overflow.h>
      30             : #include <linux/device/bus.h>
      31             : #include <linux/device/class.h>
      32             : #include <linux/device/driver.h>
      33             : #include <asm/device.h>
      34             : 
      35             : struct device;
      36             : struct device_private;
      37             : struct device_driver;
      38             : struct driver_private;
      39             : struct module;
      40             : struct class;
      41             : struct subsys_private;
      42             : struct device_node;
      43             : struct fwnode_handle;
      44             : struct iommu_ops;
      45             : struct iommu_group;
      46             : struct dev_pin_info;
      47             : struct dev_iommu;
      48             : 
      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           5 : static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
     179             : {
     180           5 :         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             : void *devm_krealloc(struct device *dev, void *ptr, size_t size,
     210             :                     gfp_t gfp) __must_check;
     211             : __printf(3, 0) char *devm_kvasprintf(struct device *dev, gfp_t gfp,
     212             :                                      const char *fmt, va_list ap) __malloc;
     213             : __printf(3, 4) char *devm_kasprintf(struct device *dev, gfp_t gfp,
     214             :                                     const char *fmt, ...) __malloc;
     215           2 : static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
     216             : {
     217           2 :         return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
     218             : }
     219           0 : static inline void *devm_kmalloc_array(struct device *dev,
     220             :                                        size_t n, size_t size, gfp_t flags)
     221             : {
     222           0 :         size_t bytes;
     223             : 
     224           0 :         if (unlikely(check_mul_overflow(n, size, &bytes)))
     225             :                 return NULL;
     226             : 
     227           0 :         return devm_kmalloc(dev, bytes, flags);
     228             : }
     229           0 : static inline void *devm_kcalloc(struct device *dev,
     230             :                                  size_t n, size_t size, gfp_t flags)
     231             : {
     232           0 :         return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
     233             : }
     234             : void devm_kfree(struct device *dev, const void *p);
     235             : char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
     236             : const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp);
     237             : void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp);
     238             : 
     239             : unsigned long devm_get_free_pages(struct device *dev,
     240             :                                   gfp_t gfp_mask, unsigned int order);
     241             : void devm_free_pages(struct device *dev, unsigned long addr);
     242             : 
     243             : void __iomem *devm_ioremap_resource(struct device *dev,
     244             :                                     const struct resource *res);
     245             : void __iomem *devm_ioremap_resource_wc(struct device *dev,
     246             :                                        const struct resource *res);
     247             : 
     248             : void __iomem *devm_of_iomap(struct device *dev,
     249             :                             struct device_node *node, int index,
     250             :                             resource_size_t *size);
     251             : 
     252             : /* allows to add/remove a custom action to devres stack */
     253             : int devm_add_action(struct device *dev, void (*action)(void *), void *data);
     254             : void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
     255             : void devm_release_action(struct device *dev, void (*action)(void *), void *data);
     256             : 
     257           1 : static inline int devm_add_action_or_reset(struct device *dev,
     258             :                                            void (*action)(void *), void *data)
     259             : {
     260           1 :         int ret;
     261             : 
     262           1 :         ret = devm_add_action(dev, action, data);
     263           1 :         if (ret)
     264           0 :                 action(data);
     265             : 
     266           1 :         return ret;
     267             : }
     268             : 
     269             : /**
     270             :  * devm_alloc_percpu - Resource-managed alloc_percpu
     271             :  * @dev: Device to allocate per-cpu memory for
     272             :  * @type: Type to allocate per-cpu memory for
     273             :  *
     274             :  * Managed alloc_percpu. Per-cpu memory allocated with this function is
     275             :  * automatically freed on driver detach.
     276             :  *
     277             :  * RETURNS:
     278             :  * Pointer to allocated memory on success, NULL on failure.
     279             :  */
     280             : #define devm_alloc_percpu(dev, type)      \
     281             :         ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
     282             :                                                       __alignof__(type)))
     283             : 
     284             : void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
     285             :                                    size_t align);
     286             : void devm_free_percpu(struct device *dev, void __percpu *pdata);
     287             : 
     288             : struct device_dma_parameters {
     289             :         /*
     290             :          * a low level driver may set these to teach IOMMU code about
     291             :          * sg limitations.
     292             :          */
     293             :         unsigned int max_segment_size;
     294             :         unsigned int min_align_mask;
     295             :         unsigned long segment_boundary_mask;
     296             : };
     297             : 
     298             : /**
     299             :  * enum device_link_state - Device link states.
     300             :  * @DL_STATE_NONE: The presence of the drivers is not being tracked.
     301             :  * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
     302             :  * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
     303             :  * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
     304             :  * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
     305             :  * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
     306             :  */
     307             : enum device_link_state {
     308             :         DL_STATE_NONE = -1,
     309             :         DL_STATE_DORMANT = 0,
     310             :         DL_STATE_AVAILABLE,
     311             :         DL_STATE_CONSUMER_PROBE,
     312             :         DL_STATE_ACTIVE,
     313             :         DL_STATE_SUPPLIER_UNBIND,
     314             : };
     315             : 
     316             : /*
     317             :  * Device link flags.
     318             :  *
     319             :  * STATELESS: The core will not remove this link automatically.
     320             :  * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
     321             :  * PM_RUNTIME: If set, the runtime PM framework will use this link.
     322             :  * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
     323             :  * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
     324             :  * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
     325             :  * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
     326             :  * SYNC_STATE_ONLY: Link only affects sync_state() behavior.
     327             :  * INFERRED: Inferred from data (eg: firmware) and not from driver actions.
     328             :  */
     329             : #define DL_FLAG_STATELESS               BIT(0)
     330             : #define DL_FLAG_AUTOREMOVE_CONSUMER     BIT(1)
     331             : #define DL_FLAG_PM_RUNTIME              BIT(2)
     332             : #define DL_FLAG_RPM_ACTIVE              BIT(3)
     333             : #define DL_FLAG_AUTOREMOVE_SUPPLIER     BIT(4)
     334             : #define DL_FLAG_AUTOPROBE_CONSUMER      BIT(5)
     335             : #define DL_FLAG_MANAGED                 BIT(6)
     336             : #define DL_FLAG_SYNC_STATE_ONLY         BIT(7)
     337             : #define DL_FLAG_INFERRED                BIT(8)
     338             : 
     339             : /**
     340             :  * enum dl_dev_state - Device driver presence tracking information.
     341             :  * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
     342             :  * @DL_DEV_PROBING: A driver is probing.
     343             :  * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
     344             :  * @DL_DEV_UNBINDING: The driver is unbinding from the device.
     345             :  */
     346             : enum dl_dev_state {
     347             :         DL_DEV_NO_DRIVER = 0,
     348             :         DL_DEV_PROBING,
     349             :         DL_DEV_DRIVER_BOUND,
     350             :         DL_DEV_UNBINDING,
     351             : };
     352             : 
     353             : /**
     354             :  * struct dev_links_info - Device data related to device links.
     355             :  * @suppliers: List of links to supplier devices.
     356             :  * @consumers: List of links to consumer devices.
     357             :  * @defer_sync: Hook to global list of devices that have deferred sync_state.
     358             :  * @status: Driver status information.
     359             :  */
     360             : struct dev_links_info {
     361             :         struct list_head suppliers;
     362             :         struct list_head consumers;
     363             :         struct list_head defer_sync;
     364             :         enum dl_dev_state status;
     365             : };
     366             : 
     367             : /**
     368             :  * struct device - The basic device structure
     369             :  * @parent:     The device's "parent" device, the device to which it is attached.
     370             :  *              In most cases, a parent device is some sort of bus or host
     371             :  *              controller. If parent is NULL, the device, is a top-level device,
     372             :  *              which is not usually what you want.
     373             :  * @p:          Holds the private data of the driver core portions of the device.
     374             :  *              See the comment of the struct device_private for detail.
     375             :  * @kobj:       A top-level, abstract class from which other classes are derived.
     376             :  * @init_name:  Initial name of the device.
     377             :  * @type:       The type of device.
     378             :  *              This identifies the device type and carries type-specific
     379             :  *              information.
     380             :  * @mutex:      Mutex to synchronize calls to its driver.
     381             :  * @lockdep_mutex: An optional debug lock that a subsystem can use as a
     382             :  *              peer lock to gain localized lockdep coverage of the device_lock.
     383             :  * @bus:        Type of bus device is on.
     384             :  * @driver:     Which driver has allocated this
     385             :  * @platform_data: Platform data specific to the device.
     386             :  *              Example: For devices on custom boards, as typical of embedded
     387             :  *              and SOC based hardware, Linux often uses platform_data to point
     388             :  *              to board-specific structures describing devices and how they
     389             :  *              are wired.  That can include what ports are available, chip
     390             :  *              variants, which GPIO pins act in what additional roles, and so
     391             :  *              on.  This shrinks the "Board Support Packages" (BSPs) and
     392             :  *              minimizes board-specific #ifdefs in drivers.
     393             :  * @driver_data: Private pointer for driver specific info.
     394             :  * @links:      Links to suppliers and consumers of this device.
     395             :  * @power:      For device power management.
     396             :  *              See Documentation/driver-api/pm/devices.rst for details.
     397             :  * @pm_domain:  Provide callbacks that are executed during system suspend,
     398             :  *              hibernation, system resume and during runtime PM transitions
     399             :  *              along with subsystem-level and driver-level callbacks.
     400             :  * @em_pd:      device's energy model performance domain
     401             :  * @pins:       For device pin management.
     402             :  *              See Documentation/driver-api/pinctl.rst for details.
     403             :  * @msi_list:   Hosts MSI descriptors
     404             :  * @msi_domain: The generic MSI domain this device is using.
     405             :  * @numa_node:  NUMA node this device is close to.
     406             :  * @dma_ops:    DMA mapping operations for this device.
     407             :  * @dma_mask:   Dma mask (if dma'ble device).
     408             :  * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
     409             :  *              hardware supports 64-bit addresses for consistent allocations
     410             :  *              such descriptors.
     411             :  * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller
     412             :  *              DMA limit than the device itself supports.
     413             :  * @dma_range_map: map for DMA memory ranges relative to that of RAM
     414             :  * @dma_parms:  A low level driver may set these to teach IOMMU code about
     415             :  *              segment limitations.
     416             :  * @dma_pools:  Dma pools (if dma'ble device).
     417             :  * @dma_mem:    Internal for coherent mem override.
     418             :  * @cma_area:   Contiguous memory area for dma allocations
     419             :  * @archdata:   For arch-specific additions.
     420             :  * @of_node:    Associated device tree node.
     421             :  * @fwnode:     Associated device node supplied by platform firmware.
     422             :  * @devt:       For creating the sysfs "dev".
     423             :  * @id:         device instance
     424             :  * @devres_lock: Spinlock to protect the resource of the device.
     425             :  * @devres_head: The resources list of the device.
     426             :  * @knode_class: The node used to add the device to the class list.
     427             :  * @class:      The class of the device.
     428             :  * @groups:     Optional attribute groups.
     429             :  * @release:    Callback to free the device after all references have
     430             :  *              gone away. This should be set by the allocator of the
     431             :  *              device (i.e. the bus driver that discovered the device).
     432             :  * @iommu_group: IOMMU group the device belongs to.
     433             :  * @iommu:      Per device generic IOMMU runtime data
     434             :  *
     435             :  * @offline_disabled: If set, the device is permanently online.
     436             :  * @offline:    Set after successful invocation of bus type's .offline().
     437             :  * @of_node_reused: Set if the device-tree node is shared with an ancestor
     438             :  *              device.
     439             :  * @state_synced: The hardware state of this device has been synced to match
     440             :  *                the software state of this device by calling the driver/bus
     441             :  *                sync_state() callback.
     442             :  * @dma_coherent: this particular device is dma coherent, even if the
     443             :  *              architecture supports non-coherent devices.
     444             :  * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the
     445             :  *              streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
     446             :  *              and optionall (if the coherent mask is large enough) also
     447             :  *              for dma allocations.  This flag is managed by the dma ops
     448             :  *              instance from ->dma_supported.
     449             :  *
     450             :  * At the lowest level, every device in a Linux system is represented by an
     451             :  * instance of struct device. The device structure contains the information
     452             :  * that the device model core needs to model the system. Most subsystems,
     453             :  * however, track additional information about the devices they host. As a
     454             :  * result, it is rare for devices to be represented by bare device structures;
     455             :  * instead, that structure, like kobject structures, is usually embedded within
     456             :  * a higher-level representation of the device.
     457             :  */
     458             : struct device {
     459             :         struct kobject kobj;
     460             :         struct device           *parent;
     461             : 
     462             :         struct device_private   *p;
     463             : 
     464             :         const char              *init_name; /* initial name of the device */
     465             :         const struct device_type *type;
     466             : 
     467             :         struct bus_type *bus;           /* type of bus device is on */
     468             :         struct device_driver *driver;   /* which driver has allocated this
     469             :                                            device */
     470             :         void            *platform_data; /* Platform specific data, device
     471             :                                            core doesn't touch it */
     472             :         void            *driver_data;   /* Driver data, set and get with
     473             :                                            dev_set_drvdata/dev_get_drvdata */
     474             : #ifdef CONFIG_PROVE_LOCKING
     475             :         struct mutex            lockdep_mutex;
     476             : #endif
     477             :         struct mutex            mutex;  /* mutex to synchronize calls to
     478             :                                          * its driver.
     479             :                                          */
     480             : 
     481             :         struct dev_links_info   links;
     482             :         struct dev_pm_info      power;
     483             :         struct dev_pm_domain    *pm_domain;
     484             : 
     485             : #ifdef CONFIG_ENERGY_MODEL
     486             :         struct em_perf_domain   *em_pd;
     487             : #endif
     488             : 
     489             : #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
     490             :         struct irq_domain       *msi_domain;
     491             : #endif
     492             : #ifdef CONFIG_PINCTRL
     493             :         struct dev_pin_info     *pins;
     494             : #endif
     495             : #ifdef CONFIG_GENERIC_MSI_IRQ
     496             :         struct list_head        msi_list;
     497             : #endif
     498             : #ifdef CONFIG_DMA_OPS
     499             :         const struct dma_map_ops *dma_ops;
     500             : #endif
     501             :         u64             *dma_mask;      /* dma mask (if dma'able device) */
     502             :         u64             coherent_dma_mask;/* Like dma_mask, but for
     503             :                                              alloc_coherent mappings as
     504             :                                              not all hardware supports
     505             :                                              64 bit addresses for consistent
     506             :                                              allocations such descriptors. */
     507             :         u64             bus_dma_limit;  /* upstream dma constraint */
     508             :         const struct bus_dma_region *dma_range_map;
     509             : 
     510             :         struct device_dma_parameters *dma_parms;
     511             : 
     512             :         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
     513             : 
     514             : #ifdef CONFIG_DMA_DECLARE_COHERENT
     515             :         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
     516             :                                              override */
     517             : #endif
     518             : #ifdef CONFIG_DMA_CMA
     519             :         struct cma *cma_area;           /* contiguous memory area for dma
     520             :                                            allocations */
     521             : #endif
     522             :         /* arch specific additions */
     523             :         struct dev_archdata     archdata;
     524             : 
     525             :         struct device_node      *of_node; /* associated device tree node */
     526             :         struct fwnode_handle    *fwnode; /* firmware device node */
     527             : 
     528             : #ifdef CONFIG_NUMA
     529             :         int             numa_node;      /* NUMA node this device is close to */
     530             : #endif
     531             :         dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
     532             :         u32                     id;     /* device instance */
     533             : 
     534             :         spinlock_t              devres_lock;
     535             :         struct list_head        devres_head;
     536             : 
     537             :         struct class            *class;
     538             :         const struct attribute_group **groups;  /* optional groups */
     539             : 
     540             :         void    (*release)(struct device *dev);
     541             :         struct iommu_group      *iommu_group;
     542             :         struct dev_iommu        *iommu;
     543             : 
     544             :         bool                    offline_disabled:1;
     545             :         bool                    offline:1;
     546             :         bool                    of_node_reused:1;
     547             :         bool                    state_synced:1;
     548             : #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
     549             :     defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
     550             :     defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
     551             :         bool                    dma_coherent:1;
     552             : #endif
     553             : #ifdef CONFIG_DMA_OPS_BYPASS
     554             :         bool                    dma_ops_bypass : 1;
     555             : #endif
     556             : };
     557             : 
     558             : /**
     559             :  * struct device_link - Device link representation.
     560             :  * @supplier: The device on the supplier end of the link.
     561             :  * @s_node: Hook to the supplier device's list of links to consumers.
     562             :  * @consumer: The device on the consumer end of the link.
     563             :  * @c_node: Hook to the consumer device's list of links to suppliers.
     564             :  * @link_dev: device used to expose link details in sysfs
     565             :  * @status: The state of the link (with respect to the presence of drivers).
     566             :  * @flags: Link flags.
     567             :  * @rpm_active: Whether or not the consumer device is runtime-PM-active.
     568             :  * @kref: Count repeated addition of the same link.
     569             :  * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
     570             :  * @supplier_preactivated: Supplier has been made active before consumer probe.
     571             :  */
     572             : struct device_link {
     573             :         struct device *supplier;
     574             :         struct list_head s_node;
     575             :         struct device *consumer;
     576             :         struct list_head c_node;
     577             :         struct device link_dev;
     578             :         enum device_link_state status;
     579             :         u32 flags;
     580             :         refcount_t rpm_active;
     581             :         struct kref kref;
     582             : #ifdef CONFIG_SRCU
     583             :         struct rcu_head rcu_head;
     584             : #endif
     585             :         bool supplier_preactivated; /* Owned by consumer probe. */
     586             : };
     587             : 
     588        3895 : static inline struct device *kobj_to_dev(struct kobject *kobj)
     589             : {
     590        3895 :         return container_of(kobj, struct device, kobj);
     591             : }
     592             : 
     593             : /**
     594             :  * device_iommu_mapped - Returns true when the device DMA is translated
     595             :  *                       by an IOMMU
     596             :  * @dev: Device to perform the check on
     597             :  */
     598             : static inline bool device_iommu_mapped(struct device *dev)
     599             : {
     600             :         return (dev->iommu_group != NULL);
     601             : }
     602             : 
     603             : /* Get the wakeup routines, which depend on struct device */
     604             : #include <linux/pm_wakeup.h>
     605             : 
     606        1247 : static inline const char *dev_name(const struct device *dev)
     607             : {
     608             :         /* Use the init name until the kobject becomes available */
     609        1247 :         if (dev->init_name)
     610             :                 return dev->init_name;
     611             : 
     612        1247 :         return kobject_name(&dev->kobj);
     613             : }
     614             : 
     615             : /**
     616             :  * dev_bus_name - Return a device's bus/class name, if at all possible
     617             :  * @dev: struct device to get the bus/class name of
     618             :  *
     619             :  * Will return the name of the bus/class the device is attached to.  If it is
     620             :  * not attached to a bus/class, an empty string will be returned.
     621             :  */
     622           1 : static inline const char *dev_bus_name(const struct device *dev)
     623             : {
     624           1 :         return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");
     625             : }
     626             : 
     627             : __printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);
     628             : 
     629             : #ifdef CONFIG_NUMA
     630          77 : static inline int dev_to_node(struct device *dev)
     631             : {
     632          43 :         return dev->numa_node;
     633             : }
     634         210 : static inline void set_dev_node(struct device *dev, int node)
     635             : {
     636         210 :         dev->numa_node = node;
     637          34 : }
     638             : #else
     639             : static inline int dev_to_node(struct device *dev)
     640             : {
     641             :         return NUMA_NO_NODE;
     642             : }
     643             : static inline void set_dev_node(struct device *dev, int node)
     644             : {
     645             : }
     646             : #endif
     647             : 
     648             : static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
     649             : {
     650             : #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
     651             :         return dev->msi_domain;
     652             : #else
     653             :         return NULL;
     654             : #endif
     655             : }
     656             : 
     657             : static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
     658             : {
     659             : #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
     660             :         dev->msi_domain = d;
     661             : #endif
     662             : }
     663             : 
     664         207 : static inline void *dev_get_drvdata(const struct device *dev)
     665             : {
     666         207 :         return dev->driver_data;
     667             : }
     668             : 
     669         140 : static inline void dev_set_drvdata(struct device *dev, void *data)
     670             : {
     671         140 :         dev->driver_data = data;
     672             : }
     673             : 
     674             : static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
     675             : {
     676             :         return dev ? dev->power.subsys_data : NULL;
     677             : }
     678             : 
     679           1 : static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
     680             : {
     681           1 :         return dev->kobj.uevent_suppress;
     682             : }
     683             : 
     684         156 : static inline void dev_set_uevent_suppress(struct device *dev, int val)
     685             : {
     686         156 :         dev->kobj.uevent_suppress = val;
     687           0 : }
     688             : 
     689           6 : static inline int device_is_registered(struct device *dev)
     690             : {
     691           6 :         return dev->kobj.state_in_sysfs;
     692             : }
     693             : 
     694           0 : static inline void device_enable_async_suspend(struct device *dev)
     695             : {
     696           0 :         if (!dev->power.is_prepared)
     697           0 :                 dev->power.async_suspend = true;
     698             : }
     699             : 
     700           0 : static inline void device_disable_async_suspend(struct device *dev)
     701             : {
     702           0 :         if (!dev->power.is_prepared)
     703           0 :                 dev->power.async_suspend = false;
     704             : }
     705             : 
     706             : static inline bool device_async_suspend_enabled(struct device *dev)
     707             : {
     708             :         return !!dev->power.async_suspend;
     709             : }
     710             : 
     711             : static inline bool device_pm_not_required(struct device *dev)
     712             : {
     713             :         return dev->power.no_pm;
     714             : }
     715             : 
     716          20 : static inline void device_set_pm_not_required(struct device *dev)
     717             : {
     718          20 :         dev->power.no_pm = true;
     719             : }
     720             : 
     721             : static inline void dev_pm_syscore_device(struct device *dev, bool val)
     722             : {
     723             : #ifdef CONFIG_PM_SLEEP
     724             :         dev->power.syscore = val;
     725             : #endif
     726             : }
     727             : 
     728           1 : static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
     729             : {
     730           1 :         dev->power.driver_flags = flags;
     731             : }
     732             : 
     733             : static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
     734             : {
     735             :         return !!(dev->power.driver_flags & flags);
     736             : }
     737             : 
     738          30 : static inline void device_lock(struct device *dev)
     739             : {
     740          30 :         mutex_lock(&dev->mutex);
     741           0 : }
     742             : 
     743             : static inline int device_lock_interruptible(struct device *dev)
     744             : {
     745             :         return mutex_lock_interruptible(&dev->mutex);
     746             : }
     747             : 
     748             : static inline int device_trylock(struct device *dev)
     749             : {
     750             :         return mutex_trylock(&dev->mutex);
     751             : }
     752             : 
     753          30 : static inline void device_unlock(struct device *dev)
     754             : {
     755          30 :         mutex_unlock(&dev->mutex);
     756           0 : }
     757             : 
     758             : static inline void device_lock_assert(struct device *dev)
     759             : {
     760             :         lockdep_assert_held(&dev->mutex);
     761             : }
     762             : 
     763         175 : static inline struct device_node *dev_of_node(struct device *dev)
     764             : {
     765         175 :         if (!IS_ENABLED(CONFIG_OF) || !dev)
     766         175 :                 return NULL;
     767             :         return dev->of_node;
     768             : }
     769             : 
     770          10 : static inline bool dev_has_sync_state(struct device *dev)
     771             : {
     772          10 :         if (!dev)
     773             :                 return false;
     774          10 :         if (dev->driver && dev->driver->sync_state)
     775             :                 return true;
     776          10 :         if (dev->bus && dev->bus->sync_state)
     777           0 :                 return true;
     778             :         return false;
     779             : }
     780             : 
     781             : /*
     782             :  * High level routines for use by the bus drivers
     783             :  */
     784             : int __must_check device_register(struct device *dev);
     785             : void device_unregister(struct device *dev);
     786             : void device_initialize(struct device *dev);
     787             : int __must_check device_add(struct device *dev);
     788             : void device_del(struct device *dev);
     789             : int device_for_each_child(struct device *dev, void *data,
     790             :                           int (*fn)(struct device *dev, void *data));
     791             : int device_for_each_child_reverse(struct device *dev, void *data,
     792             :                                   int (*fn)(struct device *dev, void *data));
     793             : struct device *device_find_child(struct device *dev, void *data,
     794             :                                  int (*match)(struct device *dev, void *data));
     795             : struct device *device_find_child_by_name(struct device *parent,
     796             :                                          const char *name);
     797             : int device_rename(struct device *dev, const char *new_name);
     798             : int device_move(struct device *dev, struct device *new_parent,
     799             :                 enum dpm_order dpm_order);
     800             : int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
     801             : const char *device_get_devnode(struct device *dev, umode_t *mode, kuid_t *uid,
     802             :                                kgid_t *gid, const char **tmp);
     803             : int device_is_dependent(struct device *dev, void *target);
     804             : 
     805         175 : static inline bool device_supports_offline(struct device *dev)
     806             : {
     807         346 :         return dev->bus && dev->bus->offline && dev->bus->online;
     808             : }
     809             : 
     810             : void lock_device_hotplug(void);
     811             : void unlock_device_hotplug(void);
     812             : int lock_device_hotplug_sysfs(void);
     813             : int device_offline(struct device *dev);
     814             : int device_online(struct device *dev);
     815             : void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
     816             : void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
     817             : void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
     818             : 
     819           0 : static inline int dev_num_vf(struct device *dev)
     820             : {
     821           0 :         if (dev->bus && dev->bus->num_vf)
     822           0 :                 return dev->bus->num_vf(dev);
     823             :         return 0;
     824             : }
     825             : 
     826             : /*
     827             :  * Root device objects for grouping under /sys/devices
     828             :  */
     829             : struct device *__root_device_register(const char *name, struct module *owner);
     830             : 
     831             : /* This is a macro to avoid include problems with THIS_MODULE */
     832             : #define root_device_register(name) \
     833             :         __root_device_register(name, THIS_MODULE)
     834             : 
     835             : void root_device_unregister(struct device *root);
     836             : 
     837           2 : static inline void *dev_get_platdata(const struct device *dev)
     838             : {
     839           2 :         return dev->platform_data;
     840             : }
     841             : 
     842             : /*
     843             :  * Manual binding of a device to driver. See drivers/base/bus.c
     844             :  * for information on use.
     845             :  */
     846             : int __must_check device_bind_driver(struct device *dev);
     847             : void device_release_driver(struct device *dev);
     848             : int  __must_check device_attach(struct device *dev);
     849             : int __must_check driver_attach(struct device_driver *drv);
     850             : void device_initial_probe(struct device *dev);
     851             : int __must_check device_reprobe(struct device *dev);
     852             : 
     853             : bool device_is_bound(struct device *dev);
     854             : 
     855             : /*
     856             :  * Easy functions for dynamically creating devices on the fly
     857             :  */
     858             : __printf(5, 6) struct device *
     859             : device_create(struct class *cls, struct device *parent, dev_t devt,
     860             :               void *drvdata, const char *fmt, ...);
     861             : __printf(6, 7) struct device *
     862             : device_create_with_groups(struct class *cls, struct device *parent, dev_t devt,
     863             :                           void *drvdata, const struct attribute_group **groups,
     864             :                           const char *fmt, ...);
     865             : void device_destroy(struct class *cls, dev_t devt);
     866             : 
     867             : int __must_check device_add_groups(struct device *dev,
     868             :                                    const struct attribute_group **groups);
     869             : void device_remove_groups(struct device *dev,
     870             :                           const struct attribute_group **groups);
     871             : 
     872             : static inline int __must_check device_add_group(struct device *dev,
     873             :                                         const struct attribute_group *grp)
     874             : {
     875             :         const struct attribute_group *groups[] = { grp, NULL };
     876             : 
     877             :         return device_add_groups(dev, groups);
     878             : }
     879             : 
     880             : static inline void device_remove_group(struct device *dev,
     881             :                                        const struct attribute_group *grp)
     882             : {
     883             :         const struct attribute_group *groups[] = { grp, NULL };
     884             : 
     885             :         return device_remove_groups(dev, groups);
     886             : }
     887             : 
     888             : int __must_check devm_device_add_groups(struct device *dev,
     889             :                                         const struct attribute_group **groups);
     890             : void devm_device_remove_groups(struct device *dev,
     891             :                                const struct attribute_group **groups);
     892             : int __must_check devm_device_add_group(struct device *dev,
     893             :                                        const struct attribute_group *grp);
     894             : void devm_device_remove_group(struct device *dev,
     895             :                               const struct attribute_group *grp);
     896             : 
     897             : /*
     898             :  * Platform "fixup" functions - allow the platform to have their say
     899             :  * about devices and actions that the general device layer doesn't
     900             :  * know about.
     901             :  */
     902             : /* Notify platform of device discovery */
     903             : extern int (*platform_notify)(struct device *dev);
     904             : 
     905             : extern int (*platform_notify_remove)(struct device *dev);
     906             : 
     907             : 
     908             : /*
     909             :  * get_device - atomically increment the reference count for the device.
     910             :  *
     911             :  */
     912             : struct device *get_device(struct device *dev);
     913             : void put_device(struct device *dev);
     914             : bool kill_device(struct device *dev);
     915             : 
     916             : #ifdef CONFIG_DEVTMPFS
     917             : int devtmpfs_mount(void);
     918             : #else
     919             : static inline int devtmpfs_mount(void) { return 0; }
     920             : #endif
     921             : 
     922             : /* drivers/base/power/shutdown.c */
     923             : void device_shutdown(void);
     924             : 
     925             : /* debugging and troubleshooting/diagnostic helpers. */
     926             : const char *dev_driver_string(const struct device *dev);
     927             : 
     928             : /* Device links interface. */
     929             : struct device_link *device_link_add(struct device *consumer,
     930             :                                     struct device *supplier, u32 flags);
     931             : void device_link_del(struct device_link *link);
     932             : void device_link_remove(void *consumer, struct device *supplier);
     933             : void device_links_supplier_sync_state_pause(void);
     934             : void device_links_supplier_sync_state_resume(void);
     935             : 
     936             : extern __printf(3, 4)
     937             : int dev_err_probe(const struct device *dev, int err, const char *fmt, ...);
     938             : 
     939             : /* Create alias, so I can be autoloaded. */
     940             : #define MODULE_ALIAS_CHARDEV(major,minor) \
     941             :         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
     942             : #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
     943             :         MODULE_ALIAS("char-major-" __stringify(major) "-*")
     944             : 
     945             : #ifdef CONFIG_SYSFS_DEPRECATED
     946             : extern long sysfs_deprecated;
     947             : #else
     948             : #define sysfs_deprecated 0
     949             : #endif
     950             : 
     951             : #endif /* _DEVICE_H_ */

Generated by: LCOV version 1.14