Something went wrong. Try again.
(I'm so sorry!) Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
C
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400// SPDX-License-Identifier: GPL-2.0/* * device.h - generic, centralized driver model * * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> * Copyright (c) 2008-2009 Novell Inc. * * See Documentation/driver-api/driver-model/ for more information. */
#ifndef _DEVICE_H_#define _DEVICE_H_
#include <linux/dev_printk.h>#include <linux/energy_model.h>#include <linux/ioport.h>#include <linux/kobject.h>#include <linux/klist.h>#include <linux/list.h>#include <linux/lockdep.h>#include <linux/compiler.h>#include <linux/types.h>#include <linux/mutex.h>#include <linux/pm.h>#include <linux/atomic.h>#include <linux/uidgid.h>#include <linux/gfp.h>#include <linux/device/bus.h>#include <linux/device/class.h>#include <linux/device/devres.h>#include <linux/device/driver.h>#include <linux/cleanup.h>#include <asm/device.h>
struct device;struct device_private;struct device_driver;struct driver_private;struct module;struct subsys_private;struct device_node;struct fwnode_handle;struct iommu_group;struct dev_pin_info;struct dev_iommu;struct msi_device_data;
/** * struct subsys_interface - interfaces to device functions * @name: name of the device function * @subsys: subsystem of the devices to attach to * @node: the list of functions registered at the subsystem * @add_dev: device hookup to device function handler * @remove_dev: device hookup to device function handler * * Simple interfaces attached to a subsystem. Multiple interfaces can * attach to a subsystem and its devices. Unlike drivers, they do not * exclusively claim or control devices. Interfaces usually represent * a specific functionality of a subsystem/class of devices. */struct subsys_interface { const char *name; const struct bus_type *subsys; struct list_head node; int (*add_dev)(struct device *dev, struct subsys_interface *sif); void (*remove_dev)(struct device *dev, struct subsys_interface *sif);};
int subsys_interface_register(struct subsys_interface *sif);void subsys_interface_unregister(struct subsys_interface *sif);
int subsys_system_register(const struct bus_type *subsys, const struct attribute_group **groups);int subsys_virtual_register(const struct bus_type *subsys, const struct attribute_group **groups);
/* * The type of device, "struct device" is embedded in. A class * or bus can contain devices of different types * like "partitions" and "disks", "mouse" and "event". * This identifies the device type and carries type-specific * information, equivalent to the kobj_type of a kobject. * If "name" is specified, the uevent will contain it in * the DEVTYPE variable. */struct device_type { const char *name; const struct attribute_group **groups; int (*uevent)(const struct device *dev, struct kobj_uevent_env *env); char *(*devnode)(const struct device *dev, umode_t *mode, kuid_t *uid, kgid_t *gid); void (*release)(struct device *dev);
const struct dev_pm_ops *pm;};
/** * struct device_attribute - Interface for exporting device attributes. * @attr: sysfs attribute definition. * @show: Show handler. * @show_const: Show handler (read-only). * @store: Store handler. * @store_const: Store handler (read-only). */struct device_attribute { struct attribute attr; __SYSFS_FUNCTION_ALTERNATIVE( ssize_t (*show)(struct device *dev, struct device_attribute *attr, char *buf); ssize_t (*show_const)(struct device *dev, const struct device_attribute *attr, char *buf); ); __SYSFS_FUNCTION_ALTERNATIVE( ssize_t (*store)(struct device *dev, struct device_attribute *attr, const char *buf, size_t count); ssize_t (*store_const)(struct device *dev, const struct device_attribute *attr, const char *buf, size_t count); );};
/** * struct dev_ext_attribute - Exported device attribute with extra context. * @attr: Exported device attribute. * @var: Pointer to context. */struct dev_ext_attribute { struct device_attribute attr; void *var;};
ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr, char *buf);ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr, const char *buf, size_t count);ssize_t device_show_int(struct device *dev, struct device_attribute *attr, char *buf);ssize_t device_store_int(struct device *dev, struct device_attribute *attr, const char *buf, size_t count);ssize_t device_show_bool(struct device *dev, struct device_attribute *attr, char *buf);ssize_t device_store_bool(struct device *dev, struct device_attribute *attr, const char *buf, size_t count);ssize_t device_show_string(struct device *dev, struct device_attribute *attr, char *buf);
typedef ssize_t __device_show_handler_const(struct device *dev, const struct device_attribute *attr, char *buf);typedef ssize_t __device_store_handler_const(struct device *dev, const struct device_attribute *attr, const char *buf, size_t count);
#ifdef CONFIG_CFI
#define __DEVICE_ATTR_SHOW_STORE(_show, _store) \ .show = _Generic(_show, \ __device_show_handler_const * : NULL, \ default : _show \ ), \ .show_const = _Generic(_show, \ __device_show_handler_const * : _show, \ default : NULL \ ), \ .store = _Generic(_store, \ __device_store_handler_const * : NULL, \ default : _store \ ), \ .store_const = _Generic(_store, \ __device_store_handler_const * : _store, \ default : NULL \ ),
#else
#define __DEVICE_ATTR_SHOW_STORE(_show, _store) \ .show = _Generic(_show, \ __device_show_handler_const * : (void *)_show, \ default : _show \ ), \ .store = _Generic(_store, \ __device_store_handler_const * : (void *)_store, \ default : _store \ ), \
#endif
#define __DEVICE_ATTR(_name, _mode, _show, _store) { \ .attr = {.name = __stringify(_name), \ .mode = VERIFY_OCTAL_PERMISSIONS(_mode) }, \ __DEVICE_ATTR_SHOW_STORE(_show, _store) \}
#define __DEVICE_ATTR_RO_MODE(_name, _mode) \ __DEVICE_ATTR(_name, _mode, _name##_show, NULL)
#define __DEVICE_ATTR_RO(_name) \ __DEVICE_ATTR_RO_MODE(_name, 0444)
#define __DEVICE_ATTR_WO(_name) \ __DEVICE_ATTR(_name, 0200, NULL, _name##_store)
#define __DEVICE_ATTR_RW_MODE(_name, _mode) \ __DEVICE_ATTR(_name, _mode, _name##_show, _name##_store)
#define __DEVICE_ATTR_RW(_name) \ __DEVICE_ATTR_RW_MODE(_name, 0644)
#ifdef CONFIG_DEBUG_LOCK_ALLOC#define __DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \ .attr = {.name = __stringify(_name), .mode = _mode, \ .ignore_lockdep = true }, \ __DEVICE_ATTR_SHOW_STORE(_show, _store) \}#else#define __DEVICE_ATTR_IGNORE_LOCKDEP __DEVICE_ATTR#endif
/** * DEVICE_ATTR - Define a device attribute. * @_name: Attribute name. * @_mode: File mode. * @_show: Show handler. Optional, but mandatory if attribute is readable. * @_store: Store handler. Optional, but mandatory if attribute is writable. * * Convenience macro for defining a struct device_attribute. * * For example, ``DEVICE_ATTR(foo, 0644, foo_show, foo_store);`` expands to: * * .. code-block:: c * * struct device_attribute dev_attr_foo = { * .attr = { .name = "foo", .mode = 0644 }, * .show = foo_show, * .store = foo_store, * }; */#define DEVICE_ATTR(_name, _mode, _show, _store) \ struct device_attribute dev_attr_##_name = __DEVICE_ATTR(_name, _mode, _show, _store)
/** * DEVICE_ATTR_RW - Define a read-write device attribute. * @_name: Attribute name. * * Like DEVICE_ATTR(), but @_mode is 0644, @_show is <_name>_show, * and @_store is <_name>_store. */#define DEVICE_ATTR_RW(_name) \ struct device_attribute dev_attr_##_name = __DEVICE_ATTR_RW(_name)
/** * DEVICE_ATTR_ADMIN_RW - Define an admin-only read-write device attribute. * @_name: Attribute name. * * Like DEVICE_ATTR_RW(), but @_mode is 0600. */#define DEVICE_ATTR_ADMIN_RW(_name) \ struct device_attribute dev_attr_##_name = __DEVICE_ATTR_RW_MODE(_name, 0600)
/** * DEVICE_ATTR_RW_NAMED - Define a read-write device attribute with a sysfs name * that differs from the function name. * @_name: Attribute function preface * @_attrname: Attribute name as it wil be exposed in the sysfs. * * Like DEVICE_ATTR_RW(), but allows for reusing names under separate paths in * the same driver. */#define DEVICE_ATTR_RW_NAMED(_name, _attrname) \ struct device_attribute dev_attr_##_name = { \ .attr = { .name = _attrname, .mode = 0644 }, \ __DEVICE_ATTR_SHOW_STORE(_name##_show, _name##_store) \ }
/** * DEVICE_ATTR_RO - Define a readable device attribute. * @_name: Attribute name. * * Like DEVICE_ATTR(), but @_mode is 0444 and @_show is <_name>_show. */#define DEVICE_ATTR_RO(_name) \ struct device_attribute dev_attr_##_name = __DEVICE_ATTR_RO(_name)
/** * DEVICE_ATTR_ADMIN_RO - Define an admin-only readable device attribute. * @_name: Attribute name. * * Like DEVICE_ATTR_RO(), but @_mode is 0400. */#define DEVICE_ATTR_ADMIN_RO(_name) \ struct device_attribute dev_attr_##_name = __DEVICE_ATTR_RO_MODE(_name, 0400)
/** * DEVICE_ATTR_RO_NAMED - Define a read-only device attribute with a sysfs name * that differs from the function name. * @_name: Attribute function preface * @_attrname: Attribute name as it wil be exposed in the sysfs. * * Like DEVICE_ATTR_RO(), but allows for reusing names under separate paths in * the same driver. */#define DEVICE_ATTR_RO_NAMED(_name, _attrname) \ struct device_attribute dev_attr_##_name = { \ .attr = { .name = _attrname, .mode = 0444 }, \ __DEVICE_ATTR_SHOW_STORE(_name##_show, NULL) \ }
/** * DEVICE_ATTR_WO - Define an admin-only writable device attribute. * @_name: Attribute name. * * Like DEVICE_ATTR(), but @_mode is 0200 and @_store is <_name>_store. */#define DEVICE_ATTR_WO(_name) \ struct device_attribute dev_attr_##_name = __DEVICE_ATTR_WO(_name)
/** * DEVICE_ATTR_WO_NAMED - Define a read-only device attribute with a sysfs name * that differs from the function name. * @_name: Attribute function preface * @_attrname: Attribute name as it wil be exposed in the sysfs. * * Like DEVICE_ATTR_WO(), but allows for reusing names under separate paths in * the same driver. */#define DEVICE_ATTR_WO_NAMED(_name, _attrname) \ struct device_attribute dev_attr_##_name = { \ .attr = { .name = _attrname, .mode = 0200 }, \ __DEVICE_ATTR_SHOW_STORE(NULL, _name##_store) \ }
/** * DEVICE_ULONG_ATTR - Define a device attribute backed by an unsigned long. * @_name: Attribute name. * @_mode: File mode. * @_var: Identifier of unsigned long. * * Like DEVICE_ATTR(), but @_show and @_store are automatically provided * such that reads and writes to the attribute from userspace affect @_var. */#define DEVICE_ULONG_ATTR(_name, _mode, _var) \ struct dev_ext_attribute dev_attr_##_name = \ { __DEVICE_ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
/** * DEVICE_INT_ATTR - Define a device attribute backed by an int. * @_name: Attribute name. * @_mode: File mode. * @_var: Identifier of int. * * Like DEVICE_ULONG_ATTR(), but @_var is an int. */#define DEVICE_INT_ATTR(_name, _mode, _var) \ struct dev_ext_attribute dev_attr_##_name = \ { __DEVICE_ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
/** * DEVICE_BOOL_ATTR - Define a device attribute backed by a bool. * @_name: Attribute name. * @_mode: File mode. * @_var: Identifier of bool. * * Like DEVICE_ULONG_ATTR(), but @_var is a bool. */#define DEVICE_BOOL_ATTR(_name, _mode, _var) \ struct dev_ext_attribute dev_attr_##_name = \ { __DEVICE_ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
/** * DEVICE_STRING_ATTR_RO - Define a device attribute backed by a r/o string. * @_name: Attribute name. * @_mode: File mode. * @_var: Identifier of string. * * Like DEVICE_ULONG_ATTR(), but @_var is a string. Because the length of the * string allocation is unknown, the attribute must be read-only. */#define DEVICE_STRING_ATTR_RO(_name, _mode, _var) \ struct dev_ext_attribute dev_attr_##_name = \ { __DEVICE_ATTR(_name, (_mode) & ~0222, device_show_string, NULL), (_var) }
#define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \ struct device_attribute dev_attr_##_name = \ __DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
int device_create_file(struct device *device, const struct device_attribute *entry);void device_remove_file(struct device *dev, const struct device_attribute *attr);bool device_remove_file_self(struct device *dev, const struct device_attribute *attr);int __must_check device_create_bin_file(struct device *dev, const struct bin_attribute *attr);void device_remove_bin_file(struct device *dev, const struct bin_attribute *attr);
struct device_dma_parameters { /* * a low level driver may set these to teach IOMMU code about * sg limitations. */ unsigned int max_segment_size; unsigned int min_align_mask; unsigned long segment_boundary_mask;};
/** * enum device_link_state - Device link states. * @DL_STATE_NONE: The presence of the drivers is not being tracked. * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present. * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not. * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present). * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present. * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding. */enum device_link_state { DL_STATE_NONE = -1, DL_STATE_DORMANT = 0, DL_STATE_AVAILABLE, DL_STATE_CONSUMER_PROBE, DL_STATE_ACTIVE, DL_STATE_SUPPLIER_UNBIND,};
/* * Device link flags. * * STATELESS: The core will not remove this link automatically. * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind. * PM_RUNTIME: If set, the runtime PM framework will use this link. * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation. * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind. * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds. * MANAGED: The core tracks presence of supplier/consumer drivers (internal). * SYNC_STATE_ONLY: Link only affects sync_state() behavior. * INFERRED: Inferred from data (eg: firmware) and not from driver actions. */#define DL_FLAG_STATELESS BIT(0)#define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)#define DL_FLAG_PM_RUNTIME BIT(2)#define DL_FLAG_RPM_ACTIVE BIT(3)#define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)#define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)#define DL_FLAG_MANAGED BIT(6)#define DL_FLAG_SYNC_STATE_ONLY BIT(7)#define DL_FLAG_INFERRED BIT(8)#define DL_FLAG_CYCLE BIT(9)
/** * enum dl_dev_state - Device driver presence tracking information. * @DL_DEV_NO_DRIVER: There is no driver attached to the device. * @DL_DEV_PROBING: A driver is probing. * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device. * @DL_DEV_UNBINDING: The driver is unbinding from the device. */enum dl_dev_state { DL_DEV_NO_DRIVER = 0, DL_DEV_PROBING, DL_DEV_DRIVER_BOUND, DL_DEV_UNBINDING,};
/** * enum device_removable - Whether the device is removable. The criteria for a * device to be classified as removable is determined by its subsystem or bus. * @DEVICE_REMOVABLE_NOT_SUPPORTED: This attribute is not supported for this * device (default). * @DEVICE_REMOVABLE_UNKNOWN: Device location is Unknown. * @DEVICE_FIXED: Device is not removable by the user. * @DEVICE_REMOVABLE: Device is removable by the user. */enum device_removable { DEVICE_REMOVABLE_NOT_SUPPORTED = 0, /* must be 0 */ DEVICE_REMOVABLE_UNKNOWN, DEVICE_FIXED, DEVICE_REMOVABLE,};
/** * struct dev_links_info - Device data related to device links. * @suppliers: List of links to supplier devices. * @consumers: List of links to consumer devices. * @defer_sync: Hook to global list of devices that have deferred sync_state. * @status: Driver status information. */struct dev_links_info { struct list_head suppliers; struct list_head consumers; struct list_head defer_sync; enum dl_dev_state status;};
/** * struct dev_msi_info - Device data related to MSI * @domain: The MSI interrupt domain associated to the device * @data: Pointer to MSI device data */struct dev_msi_info {#ifdef CONFIG_GENERIC_MSI_IRQ struct irq_domain *domain; struct msi_device_data *data;#endif};
/** * enum device_physical_location_panel - Describes which panel surface of the * system's housing the device connection point resides on. * @DEVICE_PANEL_TOP: Device connection point is on the top panel. * @DEVICE_PANEL_BOTTOM: Device connection point is on the bottom panel. * @DEVICE_PANEL_LEFT: Device connection point is on the left panel. * @DEVICE_PANEL_RIGHT: Device connection point is on the right panel. * @DEVICE_PANEL_FRONT: Device connection point is on the front panel. * @DEVICE_PANEL_BACK: Device connection point is on the back panel. * @DEVICE_PANEL_UNKNOWN: The panel with device connection point is unknown. */enum device_physical_location_panel { DEVICE_PANEL_TOP, DEVICE_PANEL_BOTTOM, DEVICE_PANEL_LEFT, DEVICE_PANEL_RIGHT, DEVICE_PANEL_FRONT, DEVICE_PANEL_BACK, DEVICE_PANEL_UNKNOWN,};
/** * enum device_physical_location_vertical_position - Describes vertical * position of the device connection point on the panel surface. * @DEVICE_VERT_POS_UPPER: Device connection point is at upper part of panel. * @DEVICE_VERT_POS_CENTER: Device connection point is at center part of panel. * @DEVICE_VERT_POS_LOWER: Device connection point is at lower part of panel. */enum device_physical_location_vertical_position { DEVICE_VERT_POS_UPPER, DEVICE_VERT_POS_CENTER, DEVICE_VERT_POS_LOWER,};
/** * enum device_physical_location_horizontal_position - Describes horizontal * position of the device connection point on the panel surface. * @DEVICE_HORI_POS_LEFT: Device connection point is at left part of panel. * @DEVICE_HORI_POS_CENTER: Device connection point is at center part of panel. * @DEVICE_HORI_POS_RIGHT: Device connection point is at right part of panel. */enum device_physical_location_horizontal_position { DEVICE_HORI_POS_LEFT, DEVICE_HORI_POS_CENTER, DEVICE_HORI_POS_RIGHT,};
/** * struct device_physical_location - Device data related to physical location * of the device connection point. * @panel: Panel surface of the system's housing that the device connection * point resides on. * @vertical_position: Vertical position of the device connection point within * the panel. * @horizontal_position: Horizontal position of the device connection point * within the panel. * @dock: Set if the device connection point resides in a docking station or * port replicator. * @lid: Set if this device connection point resides on the lid of laptop * system. */struct device_physical_location { enum device_physical_location_panel panel; enum device_physical_location_vertical_position vertical_position; enum device_physical_location_horizontal_position horizontal_position; bool dock; bool lid;};
/** * enum struct_device_flags - Flags in struct device * * Each flag should have a set of accessor functions created via * __create_dev_flag_accessors() for each access. * * @DEV_FLAG_READY_TO_PROBE: If set then device_add() has finished enough * initialization that probe could be called. * @DEV_FLAG_CAN_MATCH: The device has matched with a driver at least once or it * is in a bus (like AMBA) which can't check for matching drivers * until other devices probe successfully. * @DEV_FLAG_DMA_IOMMU: Device is using default IOMMU implementation for DMA and * doesn't rely on dma_ops structure. * @DEV_FLAG_DMA_SKIP_SYNC: DMA sync operations can be skipped for coherent * buffers. * @DEV_FLAG_DMA_OPS_BYPASS: If set then the dma_ops are bypassed for the * streaming DMA operations (->map_* / ->unmap_* / ->sync_*), and * optional (if the coherent mask is large enough) also for dma * allocations. This flag is managed by the dma ops instance from * ->dma_supported. * @DEV_FLAG_STATE_SYNCED: The hardware state of this device has been synced to * match the software state of this device by calling the * driver/bus sync_state() callback. * @DEV_FLAG_DMA_COHERENT: This particular device is dma coherent, even if the * architecture supports non-coherent devices. * @DEV_FLAG_OF_NODE_REUSED: Set if the device-tree node is shared with an * ancestor device. * @DEV_FLAG_OFFLINE_DISABLED: If set, the device is permanently online. * @DEV_FLAG_OFFLINE: Set after successful invocation of bus type's .offline(). * @DEV_FLAG_COUNT: Number of defined struct_device_flags. */enum struct_device_flags { DEV_FLAG_READY_TO_PROBE = 0, DEV_FLAG_CAN_MATCH = 1, DEV_FLAG_DMA_IOMMU = 2, DEV_FLAG_DMA_SKIP_SYNC = 3, DEV_FLAG_DMA_OPS_BYPASS = 4, DEV_FLAG_STATE_SYNCED = 5, DEV_FLAG_DMA_COHERENT = 6, DEV_FLAG_OF_NODE_REUSED = 7, DEV_FLAG_OFFLINE_DISABLED = 8, DEV_FLAG_OFFLINE = 9,
DEV_FLAG_COUNT};
/** * struct device - The basic device structure * @parent: The device's "parent" device, the device to which it is attached. * In most cases, a parent device is some sort of bus or host * controller. If parent is NULL, the device, is a top-level device, * which is not usually what you want. * @p: Holds the private data of the driver core portions of the device. * See the comment of the struct device_private for detail. * @kobj: A top-level, abstract class from which other classes are derived. * @init_name: Initial name of the device. * @type: The type of device. * This identifies the device type and carries type-specific * information. * @mutex: Mutex to synchronize calls to its driver. * @bus: Type of bus device is on. * @driver: Which driver has allocated this * @platform_data: Platform data specific to the device. * Example: For devices on custom boards, as typical of embedded * and SOC based hardware, Linux often uses platform_data to point * to board-specific structures describing devices and how they * are wired. That can include what ports are available, chip * variants, which GPIO pins act in what additional roles, and so * on. This shrinks the "Board Support Packages" (BSPs) and * minimizes board-specific #ifdefs in drivers. * @driver_data: Private pointer for driver specific info. * @driver_override: Driver name to force a match. Do not touch directly; use * device_set_driver_override() instead. * @links: Links to suppliers and consumers of this device. * @power: For device power management. * See Documentation/driver-api/pm/devices.rst for details. * @pm_domain: Provide callbacks that are executed during system suspend, * hibernation, system resume and during runtime PM transitions * along with subsystem-level and driver-level callbacks. * @em_pd: device's energy model performance domain * @pins: For device pin management. * See Documentation/driver-api/pin-control.rst for details. * @msi: MSI related data * @numa_node: NUMA node this device is close to. * @dma_ops: DMA mapping operations for this device. * @dma_mask: Dma mask (if dma'ble device). * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all * hardware supports 64-bit addresses for consistent allocations * such descriptors. * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller * DMA limit than the device itself supports. * @dma_range_map: map for DMA memory ranges relative to that of RAM * @dma_parms: A low level driver may set these to teach IOMMU code about * segment limitations. * @dma_pools: Dma pools (if dma'ble device). * @dma_mem: Internal for coherent mem override. * @cma_area: Contiguous memory area for dma allocations * @dma_io_tlb_mem: Software IO TLB allocator. Not for driver use. * @dma_io_tlb_pools: List of transient swiotlb memory pools. * @dma_io_tlb_lock: Protects changes to the list of active pools. * @dma_uses_io_tlb: %true if device has used the software IO TLB. * @archdata: For arch-specific additions. * @of_node: Associated device tree node. * @fwnode: Associated device node supplied by platform firmware. * @devt: For creating the sysfs "dev". * @id: device instance * @devres_lock: Spinlock to protect the resource of the device. * @devres_head: The resources list of the device. * @class: The class of the device. * @groups: Optional attribute groups. * @release: Callback to free the device after all references have * gone away. This should be set by the allocator of the * device (i.e. the bus driver that discovered the device). * @iommu_group: IOMMU group the device belongs to. * @iommu: Per device generic IOMMU runtime data * @physical_location: Describes physical location of the device connection * point in the system housing. * @removable: Whether the device can be removed from the system. This * should be set by the subsystem / bus driver that discovered * the device. * @flags: DEV_FLAG_XXX flags. Use atomic bitfield operations to modify. * * At the lowest level, every device in a Linux system is represented by an * instance of struct device. The device structure contains the information * that the device model core needs to model the system. Most subsystems, * however, track additional information about the devices they host. As a * result, it is rare for devices to be represented by bare device structures; * instead, that structure, like kobject structures, is usually embedded within * a higher-level representation of the device. */struct device { struct kobject kobj; struct device *parent;
struct device_private *p;
const char *init_name; /* initial name of the device */ const struct device_type *type;
const struct bus_type *bus; /* type of bus device is on */ struct device_driver *driver; /* which driver has allocated this device */ void *platform_data; /* Platform specific data, device core doesn't touch it */ void *driver_data; /* Driver data, set and get with dev_set_drvdata/dev_get_drvdata */ struct { const char *name; spinlock_t lock; } driver_override; struct mutex mutex; /* mutex to synchronize calls to * its driver. */
struct dev_links_info links; struct dev_pm_info power; struct dev_pm_domain *pm_domain;
#ifdef CONFIG_ENERGY_MODEL struct em_perf_domain *em_pd;#endif
#ifdef CONFIG_PINCTRL struct dev_pin_info *pins;#endif struct dev_msi_info msi;#ifdef CONFIG_ARCH_HAS_DMA_OPS const struct dma_map_ops *dma_ops;#endif u64 *dma_mask; /* dma mask (if dma'able device) */ u64 coherent_dma_mask;/* Like dma_mask, but for alloc_coherent mappings as not all hardware supports 64 bit addresses for consistent allocations such descriptors. */ u64 bus_dma_limit; /* upstream dma constraint */ const struct bus_dma_region *dma_range_map;
struct device_dma_parameters *dma_parms;
struct list_head dma_pools; /* dma pools (if dma'ble) */
#ifdef CONFIG_DMA_DECLARE_COHERENT struct dma_coherent_mem *dma_mem; /* internal for coherent mem override */#endif#ifdef CONFIG_DMA_CMA struct cma *cma_area; /* contiguous memory area for dma allocations */#endif#ifdef CONFIG_SWIOTLB struct io_tlb_mem *dma_io_tlb_mem;#endif#ifdef CONFIG_SWIOTLB_DYNAMIC struct list_head dma_io_tlb_pools; spinlock_t dma_io_tlb_lock; bool dma_uses_io_tlb;#endif /* arch specific additions */ struct dev_archdata archdata;
struct device_node *of_node; /* associated device tree node */ struct fwnode_handle *fwnode; /* firmware device node */
#ifdef CONFIG_NUMA int numa_node; /* NUMA node this device is close to */#endif dev_t devt; /* dev_t, creates the sysfs "dev" */ u32 id; /* device instance */
spinlock_t devres_lock; struct list_head devres_head;
const struct class *class; const struct attribute_group **groups; /* optional groups */
void (*release)(struct device *dev); struct iommu_group *iommu_group; struct dev_iommu *iommu;
struct device_physical_location *physical_location;
enum device_removable removable;
DECLARE_BITMAP(flags, DEV_FLAG_COUNT);};
#define __create_dev_flag_accessors(accessor_name, flag_name) \static inline bool dev_##accessor_name(const struct device *dev) \{ \ return test_bit(flag_name, dev->flags); \} \static inline void dev_set_##accessor_name(struct device *dev) \{ \ set_bit(flag_name, dev->flags); \} \static inline void dev_clear_##accessor_name(struct device *dev) \{ \ clear_bit(flag_name, dev->flags); \} \static inline void dev_assign_##accessor_name(struct device *dev, bool value) \{ \ assign_bit(flag_name, dev->flags, value); \} \static inline bool dev_test_and_set_##accessor_name(struct device *dev) \{ \ return test_and_set_bit(flag_name, dev->flags); \}
__create_dev_flag_accessors(ready_to_probe, DEV_FLAG_READY_TO_PROBE);__create_dev_flag_accessors(can_match, DEV_FLAG_CAN_MATCH);__create_dev_flag_accessors(dma_iommu, DEV_FLAG_DMA_IOMMU);__create_dev_flag_accessors(dma_skip_sync, DEV_FLAG_DMA_SKIP_SYNC);__create_dev_flag_accessors(dma_ops_bypass, DEV_FLAG_DMA_OPS_BYPASS);__create_dev_flag_accessors(state_synced, DEV_FLAG_STATE_SYNCED);__create_dev_flag_accessors(dma_coherent, DEV_FLAG_DMA_COHERENT);__create_dev_flag_accessors(of_node_reused, DEV_FLAG_OF_NODE_REUSED);__create_dev_flag_accessors(offline_disabled, DEV_FLAG_OFFLINE_DISABLED);__create_dev_flag_accessors(offline, DEV_FLAG_OFFLINE);
#undef __create_dev_flag_accessors
/** * struct device_link - Device link representation. * @supplier: The device on the supplier end of the link. * @s_node: Hook to the supplier device's list of links to consumers. * @consumer: The device on the consumer end of the link. * @c_node: Hook to the consumer device's list of links to suppliers. * @link_dev: device used to expose link details in sysfs * @status: The state of the link (with respect to the presence of drivers). * @flags: Link flags. * @rpm_active: Whether or not the consumer device is runtime-PM-active. * @kref: Count repeated addition of the same link. * @rm_work: Work structure used for removing the link. * @supplier_preactivated: Supplier has been made active before consumer probe. */struct device_link { struct device *supplier; struct list_head s_node; struct device *consumer; struct list_head c_node; struct device link_dev; enum device_link_state status; u32 flags; refcount_t rpm_active; struct kref kref; struct work_struct rm_work; bool supplier_preactivated; /* Owned by consumer probe. */};
#define kobj_to_dev(__kobj) container_of_const(__kobj, struct device, kobj)
int __device_set_driver_override(struct device *dev, const char *s, size_t len);
/** * device_set_driver_override() - Helper to set or clear driver override. * @dev: Device to change * @s: NUL-terminated string, new driver name to force a match, pass empty * string to clear it ("" or "\n", where the latter is only for sysfs * interface). * * Helper to set or clear driver override of a device. * * Returns: 0 on success or a negative error code on failure. */static inline int device_set_driver_override(struct device *dev, const char *s){ return __device_set_driver_override(dev, s, s ? strlen(s) : 0);}
/** * device_has_driver_override() - Check if a driver override has been set. * @dev: device to check * * Returns true if a driver override has been set for this device. */static inline bool device_has_driver_override(struct device *dev){ guard(spinlock)(&dev->driver_override.lock); return !!dev->driver_override.name;}
/** * device_match_driver_override() - Match a driver against the device's driver_override. * @dev: device to check * @drv: driver to match against * * Returns > 0 if a driver override is set and matches the given driver, 0 if a * driver override is set but does not match, or < 0 if a driver override is not * set at all. */static inline int device_match_driver_override(struct device *dev, const struct device_driver *drv){ guard(spinlock)(&dev->driver_override.lock); if (dev->driver_override.name) return !strcmp(dev->driver_override.name, drv->name); return -1;}
/** * device_iommu_mapped - Returns true when the device DMA is translated * by an IOMMU * @dev: Device to perform the check on */static inline bool device_iommu_mapped(struct device *dev){ return (dev->iommu_group != NULL);}
/* Get the wakeup routines, which depend on struct device */#include <linux/pm_wakeup.h>
/** * dev_name - Return a device's name. * @dev: Device with name to get. * Return: The kobject name of the device, or its initial name if unavailable. */static inline const char *dev_name(const struct device *dev){ /* Use the init name until the kobject becomes available */ if (dev->init_name) return dev->init_name;
return kobject_name(&dev->kobj);}
/** * dev_bus_name - Return a device's bus/class name, if at all possible * @dev: struct device to get the bus/class name of * * Will return the name of the bus/class the device is attached to. If it is * not attached to a bus/class, an empty string will be returned. */static inline const char *dev_bus_name(const struct device *dev){ return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");}
__printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);
#ifdef CONFIG_NUMAstatic inline int dev_to_node(struct device *dev){ return dev->numa_node;}static inline void set_dev_node(struct device *dev, int node){ dev->numa_node = node;}#elsestatic inline int dev_to_node(struct device *dev){ return NUMA_NO_NODE;}static inline void set_dev_node(struct device *dev, int node){}#endif
static inline struct irq_domain *dev_get_msi_domain(const struct device *dev){#ifdef CONFIG_GENERIC_MSI_IRQ return dev->msi.domain;#else return NULL;#endif}
static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d){#ifdef CONFIG_GENERIC_MSI_IRQ dev->msi.domain = d;#endif}
static inline void *dev_get_drvdata(const struct device *dev){ return dev->driver_data;}
static inline void dev_set_drvdata(struct device *dev, void *data){ dev->driver_data = data;}
static inline struct pm_subsys_data *dev_to_psd(struct device *dev){ return dev ? dev->power.subsys_data : NULL;}
static inline unsigned int dev_get_uevent_suppress(const struct device *dev){ return dev->kobj.uevent_suppress;}
static inline void dev_set_uevent_suppress(struct device *dev, int val){ dev->kobj.uevent_suppress = val;}
static inline int device_is_registered(struct device *dev){ return dev->kobj.state_in_sysfs;}
static inline void device_enable_async_suspend(struct device *dev){ if (!dev->power.is_prepared) dev->power.async_suspend = true;}
static inline void device_disable_async_suspend(struct device *dev){ if (!dev->power.is_prepared) dev->power.async_suspend = false;}
static inline bool device_async_suspend_enabled(struct device *dev){ return !!dev->power.async_suspend;}
static inline bool device_pm_not_required(struct device *dev){ return dev->power.no_pm;}
static inline void device_set_pm_not_required(struct device *dev){ dev->power.no_pm = true;#ifdef CONFIG_PM dev->power.no_callbacks = true;#endif}
static inline void dev_pm_syscore_device(struct device *dev, bool val){#ifdef CONFIG_PM_SLEEP dev->power.syscore = val;#endif}
static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags){ dev->power.driver_flags = flags;}
static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags){ return !!(dev->power.driver_flags & flags);}
static inline bool dev_pm_smart_suspend(struct device *dev){#ifdef CONFIG_PM_SLEEP return dev->power.smart_suspend;#else return false;#endif}
/* * dev_pm_set_strict_midlayer - Update the device's power.strict_midlayer flag * @dev: Target device. * @val: New flag value. * * When set, power.strict_midlayer means that the middle layer power management * code (typically, a bus type or a PM domain) does not expect its runtime PM * suspend callback to be invoked at all during system-wide PM transitions and * it does not expect its runtime PM resume callback to be invoked at any point * when runtime PM is disabled for the device during system-wide PM transitions. */static inline void dev_pm_set_strict_midlayer(struct device *dev, bool val){#ifdef CONFIG_PM_SLEEP dev->power.strict_midlayer = val;#endif}
static inline bool dev_pm_strict_midlayer_is_set(struct device *dev){#ifdef CONFIG_PM_SLEEP return dev->power.strict_midlayer;#else return false;#endif}
static inline void device_lock(struct device *dev){ mutex_lock(&dev->mutex);}
static inline int device_lock_interruptible(struct device *dev){ return mutex_lock_interruptible(&dev->mutex);}
static inline int device_trylock(struct device *dev){ return mutex_trylock(&dev->mutex);}
static inline void device_unlock(struct device *dev){ mutex_unlock(&dev->mutex);}
DEFINE_GUARD(device, struct device *, device_lock(_T), device_unlock(_T))DEFINE_GUARD_COND(device, _intr, device_lock_interruptible(_T), _RET == 0)
static inline void device_lock_assert(struct device *dev){ lockdep_assert_held(&dev->mutex);}
static inline int dev_set_drv_sync_state(struct device *dev, void (*fn)(struct device *dev)){ if (!dev || !dev->driver) return 0; if (dev->driver->sync_state && dev->driver->sync_state != fn) return -EBUSY; if (!dev->driver->sync_state) dev->driver->sync_state = fn; return 0;}
static inline void dev_set_removable(struct device *dev, enum device_removable removable){ dev->removable = removable;}
static inline bool dev_is_removable(struct device *dev){ return dev->removable == DEVICE_REMOVABLE;}
static inline bool dev_removable_is_valid(struct device *dev){ return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED;}
/* * High level routines for use by the bus drivers */int __must_check device_register(struct device *dev);void device_unregister(struct device *dev);void device_initialize(struct device *dev);int __must_check device_add(struct device *dev);void device_del(struct device *dev);
DEFINE_FREE(device_del, struct device *, if (_T) device_del(_T))
int device_for_each_child(struct device *parent, void *data, device_iter_t fn);int device_for_each_child_reverse(struct device *parent, void *data, device_iter_t fn);int device_for_each_child_reverse_from(struct device *parent, struct device *from, void *data, device_iter_t fn);struct device *device_find_child(struct device *parent, const void *data, device_match_t match);/** * device_find_child_by_name - device iterator for locating a child device. * @parent: parent struct device * @name: name of the child device * * This is similar to the device_find_child() function above, but it * returns a reference to a device that has the name @name. * * NOTE: you will need to drop the reference with put_device() after use. */static inline struct device *device_find_child_by_name(struct device *parent, const char *name){ return device_find_child(parent, name, device_match_name);}
/** * device_find_any_child - device iterator for locating a child device, if any. * @parent: parent struct device * * This is similar to the device_find_child() function above, but it * returns a reference to a child device, if any. * * NOTE: you will need to drop the reference with put_device() after use. */static inline struct device *device_find_any_child(struct device *parent){ return device_find_child(parent, NULL, device_match_any);}
int device_rename(struct device *dev, const char *new_name);int device_move(struct device *dev, struct device *new_parent, enum dpm_order dpm_order);int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
static inline bool device_supports_offline(struct device *dev){ return dev->bus && dev->bus->offline && dev->bus->online;}
#define __device_lock_set_class(dev, name, key) \do { \ struct device *__d2 __maybe_unused = dev; \ lock_set_class(&__d2->mutex.dep_map, name, key, 0, _THIS_IP_); \} while (0)
/** * device_lock_set_class - Specify a temporary lock class while a device * is attached to a driver * @dev: device to modify * @key: lock class key data * * This must be called with the device_lock() already held, for example * from driver ->probe(). Take care to only override the default * lockdep_no_validate class. */#ifdef CONFIG_LOCKDEP#define device_lock_set_class(dev, key) \do { \ struct device *__d = dev; \ dev_WARN_ONCE(__d, !lockdep_match_class(&__d->mutex, \ &__lockdep_no_validate__), \ "overriding existing custom lock class\n"); \ __device_lock_set_class(__d, #key, key); \} while (0)#else#define device_lock_set_class(dev, key) __device_lock_set_class(dev, #key, key)#endif
/** * device_lock_reset_class - Return a device to the default lockdep novalidate state * @dev: device to modify * * This must be called with the device_lock() already held, for example * from driver ->remove(). */#define device_lock_reset_class(dev) \do { \ struct device *__d __maybe_unused = dev; \ lock_set_novalidate_class(&__d->mutex.dep_map, "&dev->mutex", \ _THIS_IP_); \} while (0)
void lock_device_hotplug(void);void unlock_device_hotplug(void);int lock_device_hotplug_sysfs(void);int device_offline(struct device *dev);int device_online(struct device *dev);
void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);void device_set_node(struct device *dev, struct fwnode_handle *fwnode);int device_add_of_node(struct device *dev, struct device_node *of_node);void device_remove_of_node(struct device *dev);void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);struct device *get_dev_from_fwnode(struct fwnode_handle *fwnode);
static inline struct device_node *dev_of_node(struct device *dev){ if (!IS_ENABLED(CONFIG_OF) || !dev) return NULL; return dev->of_node;}
static inline int dev_num_vf(struct device *dev){ if (dev->bus && dev->bus->num_vf) return dev->bus->num_vf(dev); return 0;}
/* * Root device objects for grouping under /sys/devices */struct device *__root_device_register(const char *name, struct module *owner);
/* This is a macro to avoid include problems with THIS_MODULE */#define root_device_register(name) \ __root_device_register(name, THIS_MODULE)
void root_device_unregister(struct device *root);
static inline void *dev_get_platdata(const struct device *dev){ return dev->platform_data;}
/* * Manual binding of a device to driver. See drivers/base/bus.c * for information on use. */int __must_check device_driver_attach(const struct device_driver *drv, struct device *dev);int __must_check device_bind_driver(struct device *dev);void device_release_driver(struct device *dev);int __must_check device_attach(struct device *dev);int __must_check driver_attach(const struct device_driver *drv);void device_initial_probe(struct device *dev);int __must_check device_reprobe(struct device *dev);
bool device_is_bound(struct device *dev);
/* * Easy functions for dynamically creating devices on the fly */__printf(5, 6) struct device *device_create(const struct class *cls, struct device *parent, dev_t devt, void *drvdata, const char *fmt, ...);__printf(6, 7) struct device *device_create_with_groups(const struct class *cls, struct device *parent, dev_t devt, void *drvdata, const struct attribute_group **groups, const char *fmt, ...);void device_destroy(const struct class *cls, dev_t devt);
int __must_check device_add_groups(struct device *dev, const struct attribute_group *const *groups);void device_remove_groups(struct device *dev, const struct attribute_group *const *groups);
static inline int __must_check device_add_group(struct device *dev, const struct attribute_group *grp){ const struct attribute_group *groups[] = { grp, NULL };
return device_add_groups(dev, groups);}
static inline void device_remove_group(struct device *dev, const struct attribute_group *grp){ const struct attribute_group *groups[] = { grp, NULL };
device_remove_groups(dev, groups);}
int __must_check devm_device_add_group(struct device *dev, const struct attribute_group *grp);
/* * get_device - atomically increment the reference count for the device. * */struct device *get_device(struct device *dev);void put_device(struct device *dev);
DEFINE_FREE(put_device, struct device *, if (_T) put_device(_T))
bool kill_device(struct device *dev);
#ifdef CONFIG_DEVTMPFSint devtmpfs_mount(void);#elsestatic inline int devtmpfs_mount(void) { return 0; }#endif
/* drivers/base/power/shutdown.c */void device_shutdown(void);
/* debugging and troubleshooting/diagnostic helpers. */const char *dev_driver_string(const struct device *dev);
/* Device links interface. */struct device_link *device_link_add(struct device *consumer, struct device *supplier, u32 flags);void device_link_del(struct device_link *link);void device_link_remove(void *consumer, struct device *supplier);void device_links_supplier_sync_state_pause(void);void device_links_supplier_sync_state_resume(void);void device_link_wait_removal(void);
static inline bool device_link_test(const struct device_link *link, u32 flags){ return !!(link->flags & flags);}
/* Create alias, so I can be autoloaded. */#define MODULE_ALIAS_CHARDEV(major,minor) \ MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))#define MODULE_ALIAS_CHARDEV_MAJOR(major) \ MODULE_ALIAS("char-major-" __stringify(major) "-*")
#endif /* _DEVICE_H_ */