device.h 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358
  1. /*
  2. * device.h - generic, centralized driver model
  3. *
  4. * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
  5. * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
  6. * Copyright (c) 2008-2009 Novell Inc.
  7. *
  8. * This file is released under the GPLv2
  9. *
  10. * See Documentation/driver-model/ for more information.
  11. */
  12. #ifndef _DEVICE_H_
  13. #define _DEVICE_H_
  14. #include <linux/ioport.h>
  15. #include <linux/kobject.h>
  16. #include <linux/klist.h>
  17. #include <linux/list.h>
  18. #include <linux/lockdep.h>
  19. #include <linux/compiler.h>
  20. #include <linux/types.h>
  21. #include <linux/mutex.h>
  22. #include <linux/pinctrl/devinfo.h>
  23. #include <linux/pm.h>
  24. #include <linux/atomic.h>
  25. #include <linux/ratelimit.h>
  26. #include <linux/uidgid.h>
  27. #include <linux/gfp.h>
  28. #include <asm/device.h>
  29. struct device;
  30. struct device_private;
  31. struct device_driver;
  32. struct driver_private;
  33. struct module;
  34. struct class;
  35. struct subsys_private;
  36. struct bus_type;
  37. struct device_node;
  38. struct fwnode_handle;
  39. struct iommu_ops;
  40. struct iommu_group;
  41. struct bus_attribute {
  42. struct attribute attr;
  43. ssize_t (*show)(struct bus_type *bus, char *buf);
  44. ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
  45. };
  46. #define BUS_ATTR(_name, _mode, _show, _store) \
  47. struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
  48. #define BUS_ATTR_RW(_name) \
  49. struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
  50. #define BUS_ATTR_RO(_name) \
  51. struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
  52. extern int __must_check bus_create_file(struct bus_type *,
  53. struct bus_attribute *);
  54. extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
  55. /**
  56. * struct bus_type - The bus type of the device
  57. *
  58. * @name: The name of the bus.
  59. * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
  60. * @dev_root: Default device to use as the parent.
  61. * @dev_attrs: Default attributes of the devices on the bus.
  62. * @bus_groups: Default attributes of the bus.
  63. * @dev_groups: Default attributes of the devices on the bus.
  64. * @drv_groups: Default attributes of the device drivers on the bus.
  65. * @match: Called, perhaps multiple times, whenever a new device or driver
  66. * is added for this bus. It should return a nonzero value if the
  67. * given device can be handled by the given driver.
  68. * @uevent: Called when a device is added, removed, or a few other things
  69. * that generate uevents to add the environment variables.
  70. * @probe: Called when a new device or driver add to this bus, and callback
  71. * the specific driver's probe to initial the matched device.
  72. * @remove: Called when a device removed from this bus.
  73. * @shutdown: Called at shut-down time to quiesce the device.
  74. *
  75. * @online: Called to put the device back online (after offlining it).
  76. * @offline: Called to put the device offline for hot-removal. May fail.
  77. *
  78. * @suspend: Called when a device on this bus wants to go to sleep mode.
  79. * @resume: Called to bring a device on this bus out of sleep mode.
  80. * @pm: Power management operations of this bus, callback the specific
  81. * device driver's pm-ops.
  82. * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
  83. * driver implementations to a bus and allow the driver to do
  84. * bus-specific setup
  85. * @p: The private data of the driver core, only the driver core can
  86. * touch this.
  87. * @lock_key: Lock class key for use by the lock validator
  88. *
  89. * A bus is a channel between the processor and one or more devices. For the
  90. * purposes of the device model, all devices are connected via a bus, even if
  91. * it is an internal, virtual, "platform" bus. Buses can plug into each other.
  92. * A USB controller is usually a PCI device, for example. The device model
  93. * represents the actual connections between buses and the devices they control.
  94. * A bus is represented by the bus_type structure. It contains the name, the
  95. * default attributes, the bus' methods, PM operations, and the driver core's
  96. * private data.
  97. */
  98. struct bus_type {
  99. const char *name;
  100. const char *dev_name;
  101. struct device *dev_root;
  102. struct device_attribute *dev_attrs; /* use dev_groups instead */
  103. const struct attribute_group **bus_groups;
  104. const struct attribute_group **dev_groups;
  105. const struct attribute_group **drv_groups;
  106. int (*match)(struct device *dev, struct device_driver *drv);
  107. int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
  108. int (*probe)(struct device *dev);
  109. int (*remove)(struct device *dev);
  110. void (*shutdown)(struct device *dev);
  111. int (*online)(struct device *dev);
  112. int (*offline)(struct device *dev);
  113. int (*suspend)(struct device *dev, pm_message_t state);
  114. int (*resume)(struct device *dev);
  115. const struct dev_pm_ops *pm;
  116. const struct iommu_ops *iommu_ops;
  117. struct subsys_private *p;
  118. struct lock_class_key lock_key;
  119. };
  120. extern int __must_check bus_register(struct bus_type *bus);
  121. extern void bus_unregister(struct bus_type *bus);
  122. extern int __must_check bus_rescan_devices(struct bus_type *bus);
  123. /* iterator helpers for buses */
  124. struct subsys_dev_iter {
  125. struct klist_iter ki;
  126. const struct device_type *type;
  127. };
  128. void subsys_dev_iter_init(struct subsys_dev_iter *iter,
  129. struct bus_type *subsys,
  130. struct device *start,
  131. const struct device_type *type);
  132. struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
  133. void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
  134. int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
  135. int (*fn)(struct device *dev, void *data));
  136. struct device *bus_find_device(struct bus_type *bus, struct device *start,
  137. void *data,
  138. int (*match)(struct device *dev, void *data));
  139. struct device *bus_find_device_by_name(struct bus_type *bus,
  140. struct device *start,
  141. const char *name);
  142. struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
  143. struct device *hint);
  144. int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
  145. void *data, int (*fn)(struct device_driver *, void *));
  146. void bus_sort_breadthfirst(struct bus_type *bus,
  147. int (*compare)(const struct device *a,
  148. const struct device *b));
  149. /*
  150. * Bus notifiers: Get notified of addition/removal of devices
  151. * and binding/unbinding of drivers to devices.
  152. * In the long run, it should be a replacement for the platform
  153. * notify hooks.
  154. */
  155. struct notifier_block;
  156. extern int bus_register_notifier(struct bus_type *bus,
  157. struct notifier_block *nb);
  158. extern int bus_unregister_notifier(struct bus_type *bus,
  159. struct notifier_block *nb);
  160. /* All 4 notifers below get called with the target struct device *
  161. * as an argument. Note that those functions are likely to be called
  162. * with the device lock held in the core, so be careful.
  163. */
  164. #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
  165. #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
  166. #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
  167. #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
  168. bound */
  169. #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
  170. #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
  171. unbound */
  172. #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
  173. from the device */
  174. extern struct kset *bus_get_kset(struct bus_type *bus);
  175. extern struct klist *bus_get_device_klist(struct bus_type *bus);
  176. /**
  177. * enum probe_type - device driver probe type to try
  178. * Device drivers may opt in for special handling of their
  179. * respective probe routines. This tells the core what to
  180. * expect and prefer.
  181. *
  182. * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
  183. * whether probed synchronously or asynchronously.
  184. * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
  185. * probing order is not essential for booting the system may
  186. * opt into executing their probes asynchronously.
  187. * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
  188. * their probe routines to run synchronously with driver and
  189. * device registration (with the exception of -EPROBE_DEFER
  190. * handling - re-probing always ends up being done asynchronously).
  191. *
  192. * Note that the end goal is to switch the kernel to use asynchronous
  193. * probing by default, so annotating drivers with
  194. * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
  195. * to speed up boot process while we are validating the rest of the
  196. * drivers.
  197. */
  198. enum probe_type {
  199. PROBE_DEFAULT_STRATEGY,
  200. PROBE_PREFER_ASYNCHRONOUS,
  201. PROBE_FORCE_SYNCHRONOUS,
  202. };
  203. /**
  204. * struct device_driver - The basic device driver structure
  205. * @name: Name of the device driver.
  206. * @bus: The bus which the device of this driver belongs to.
  207. * @owner: The module owner.
  208. * @mod_name: Used for built-in modules.
  209. * @suppress_bind_attrs: Disables bind/unbind via sysfs.
  210. * @probe_type: Type of the probe (synchronous or asynchronous) to use.
  211. * @of_match_table: The open firmware table.
  212. * @acpi_match_table: The ACPI match table.
  213. * @probe: Called to query the existence of a specific device,
  214. * whether this driver can work with it, and bind the driver
  215. * to a specific device.
  216. * @remove: Called when the device is removed from the system to
  217. * unbind a device from this driver.
  218. * @shutdown: Called at shut-down time to quiesce the device.
  219. * @suspend: Called to put the device to sleep mode. Usually to a
  220. * low power state.
  221. * @resume: Called to bring a device from sleep mode.
  222. * @groups: Default attributes that get created by the driver core
  223. * automatically.
  224. * @pm: Power management operations of the device which matched
  225. * this driver.
  226. * @p: Driver core's private data, no one other than the driver
  227. * core can touch this.
  228. *
  229. * The device driver-model tracks all of the drivers known to the system.
  230. * The main reason for this tracking is to enable the driver core to match
  231. * up drivers with new devices. Once drivers are known objects within the
  232. * system, however, a number of other things become possible. Device drivers
  233. * can export information and configuration variables that are independent
  234. * of any specific device.
  235. */
  236. struct device_driver {
  237. const char *name;
  238. struct bus_type *bus;
  239. struct module *owner;
  240. const char *mod_name; /* used for built-in modules */
  241. bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
  242. enum probe_type probe_type;
  243. const struct of_device_id *of_match_table;
  244. const struct acpi_device_id *acpi_match_table;
  245. int (*probe) (struct device *dev);
  246. int (*remove) (struct device *dev);
  247. void (*shutdown) (struct device *dev);
  248. int (*suspend) (struct device *dev, pm_message_t state);
  249. int (*resume) (struct device *dev);
  250. const struct attribute_group **groups;
  251. const struct dev_pm_ops *pm;
  252. struct driver_private *p;
  253. };
  254. extern int __must_check driver_register(struct device_driver *drv);
  255. extern void driver_unregister(struct device_driver *drv);
  256. extern struct device_driver *driver_find(const char *name,
  257. struct bus_type *bus);
  258. extern int driver_probe_done(void);
  259. extern void wait_for_device_probe(void);
  260. /* sysfs interface for exporting driver attributes */
  261. struct driver_attribute {
  262. struct attribute attr;
  263. ssize_t (*show)(struct device_driver *driver, char *buf);
  264. ssize_t (*store)(struct device_driver *driver, const char *buf,
  265. size_t count);
  266. };
  267. #define DRIVER_ATTR(_name, _mode, _show, _store) \
  268. struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
  269. #define DRIVER_ATTR_RW(_name) \
  270. struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
  271. #define DRIVER_ATTR_RO(_name) \
  272. struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
  273. #define DRIVER_ATTR_WO(_name) \
  274. struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
  275. extern int __must_check driver_create_file(struct device_driver *driver,
  276. const struct driver_attribute *attr);
  277. extern void driver_remove_file(struct device_driver *driver,
  278. const struct driver_attribute *attr);
  279. extern int __must_check driver_for_each_device(struct device_driver *drv,
  280. struct device *start,
  281. void *data,
  282. int (*fn)(struct device *dev,
  283. void *));
  284. struct device *driver_find_device(struct device_driver *drv,
  285. struct device *start, void *data,
  286. int (*match)(struct device *dev, void *data));
  287. /**
  288. * struct subsys_interface - interfaces to device functions
  289. * @name: name of the device function
  290. * @subsys: subsytem of the devices to attach to
  291. * @node: the list of functions registered at the subsystem
  292. * @add_dev: device hookup to device function handler
  293. * @remove_dev: device hookup to device function handler
  294. *
  295. * Simple interfaces attached to a subsystem. Multiple interfaces can
  296. * attach to a subsystem and its devices. Unlike drivers, they do not
  297. * exclusively claim or control devices. Interfaces usually represent
  298. * a specific functionality of a subsystem/class of devices.
  299. */
  300. struct subsys_interface {
  301. const char *name;
  302. struct bus_type *subsys;
  303. struct list_head node;
  304. int (*add_dev)(struct device *dev, struct subsys_interface *sif);
  305. void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
  306. };
  307. int subsys_interface_register(struct subsys_interface *sif);
  308. void subsys_interface_unregister(struct subsys_interface *sif);
  309. int subsys_system_register(struct bus_type *subsys,
  310. const struct attribute_group **groups);
  311. int subsys_virtual_register(struct bus_type *subsys,
  312. const struct attribute_group **groups);
  313. /**
  314. * struct class - device classes
  315. * @name: Name of the class.
  316. * @owner: The module owner.
  317. * @class_attrs: Default attributes of this class.
  318. * @dev_groups: Default attributes of the devices that belong to the class.
  319. * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
  320. * @dev_uevent: Called when a device is added, removed from this class, or a
  321. * few other things that generate uevents to add the environment
  322. * variables.
  323. * @devnode: Callback to provide the devtmpfs.
  324. * @class_release: Called to release this class.
  325. * @dev_release: Called to release the device.
  326. * @suspend: Used to put the device to sleep mode, usually to a low power
  327. * state.
  328. * @resume: Used to bring the device from the sleep mode.
  329. * @ns_type: Callbacks so sysfs can detemine namespaces.
  330. * @namespace: Namespace of the device belongs to this class.
  331. * @pm: The default device power management operations of this class.
  332. * @p: The private data of the driver core, no one other than the
  333. * driver core can touch this.
  334. *
  335. * A class is a higher-level view of a device that abstracts out low-level
  336. * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
  337. * at the class level, they are all simply disks. Classes allow user space
  338. * to work with devices based on what they do, rather than how they are
  339. * connected or how they work.
  340. */
  341. struct class {
  342. const char *name;
  343. struct module *owner;
  344. struct class_attribute *class_attrs;
  345. const struct attribute_group **dev_groups;
  346. struct kobject *dev_kobj;
  347. int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
  348. char *(*devnode)(struct device *dev, umode_t *mode);
  349. void (*class_release)(struct class *class);
  350. void (*dev_release)(struct device *dev);
  351. int (*suspend)(struct device *dev, pm_message_t state);
  352. int (*resume)(struct device *dev);
  353. const struct kobj_ns_type_operations *ns_type;
  354. const void *(*namespace)(struct device *dev);
  355. const struct dev_pm_ops *pm;
  356. struct subsys_private *p;
  357. };
  358. struct class_dev_iter {
  359. struct klist_iter ki;
  360. const struct device_type *type;
  361. };
  362. extern struct kobject *sysfs_dev_block_kobj;
  363. extern struct kobject *sysfs_dev_char_kobj;
  364. extern int __must_check __class_register(struct class *class,
  365. struct lock_class_key *key);
  366. extern void class_unregister(struct class *class);
  367. /* This is a #define to keep the compiler from merging different
  368. * instances of the __key variable */
  369. #define class_register(class) \
  370. ({ \
  371. static struct lock_class_key __key; \
  372. __class_register(class, &__key); \
  373. })
  374. struct class_compat;
  375. struct class_compat *class_compat_register(const char *name);
  376. void class_compat_unregister(struct class_compat *cls);
  377. int class_compat_create_link(struct class_compat *cls, struct device *dev,
  378. struct device *device_link);
  379. void class_compat_remove_link(struct class_compat *cls, struct device *dev,
  380. struct device *device_link);
  381. extern void class_dev_iter_init(struct class_dev_iter *iter,
  382. struct class *class,
  383. struct device *start,
  384. const struct device_type *type);
  385. extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
  386. extern void class_dev_iter_exit(struct class_dev_iter *iter);
  387. extern int class_for_each_device(struct class *class, struct device *start,
  388. void *data,
  389. int (*fn)(struct device *dev, void *data));
  390. extern struct device *class_find_device(struct class *class,
  391. struct device *start, const void *data,
  392. int (*match)(struct device *, const void *));
  393. struct class_attribute {
  394. struct attribute attr;
  395. ssize_t (*show)(struct class *class, struct class_attribute *attr,
  396. char *buf);
  397. ssize_t (*store)(struct class *class, struct class_attribute *attr,
  398. const char *buf, size_t count);
  399. };
  400. #define CLASS_ATTR(_name, _mode, _show, _store) \
  401. struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
  402. #define CLASS_ATTR_RW(_name) \
  403. struct class_attribute class_attr_##_name = __ATTR_RW(_name)
  404. #define CLASS_ATTR_RO(_name) \
  405. struct class_attribute class_attr_##_name = __ATTR_RO(_name)
  406. extern int __must_check class_create_file_ns(struct class *class,
  407. const struct class_attribute *attr,
  408. const void *ns);
  409. extern void class_remove_file_ns(struct class *class,
  410. const struct class_attribute *attr,
  411. const void *ns);
  412. static inline int __must_check class_create_file(struct class *class,
  413. const struct class_attribute *attr)
  414. {
  415. return class_create_file_ns(class, attr, NULL);
  416. }
  417. static inline void class_remove_file(struct class *class,
  418. const struct class_attribute *attr)
  419. {
  420. return class_remove_file_ns(class, attr, NULL);
  421. }
  422. /* Simple class attribute that is just a static string */
  423. struct class_attribute_string {
  424. struct class_attribute attr;
  425. char *str;
  426. };
  427. /* Currently read-only only */
  428. #define _CLASS_ATTR_STRING(_name, _mode, _str) \
  429. { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
  430. #define CLASS_ATTR_STRING(_name, _mode, _str) \
  431. struct class_attribute_string class_attr_##_name = \
  432. _CLASS_ATTR_STRING(_name, _mode, _str)
  433. extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
  434. char *buf);
  435. struct class_interface {
  436. struct list_head node;
  437. struct class *class;
  438. int (*add_dev) (struct device *, struct class_interface *);
  439. void (*remove_dev) (struct device *, struct class_interface *);
  440. };
  441. extern int __must_check class_interface_register(struct class_interface *);
  442. extern void class_interface_unregister(struct class_interface *);
  443. extern struct class * __must_check __class_create(struct module *owner,
  444. const char *name,
  445. struct lock_class_key *key);
  446. extern void class_destroy(struct class *cls);
  447. /* This is a #define to keep the compiler from merging different
  448. * instances of the __key variable */
  449. #define class_create(owner, name) \
  450. ({ \
  451. static struct lock_class_key __key; \
  452. __class_create(owner, name, &__key); \
  453. })
  454. /*
  455. * The type of device, "struct device" is embedded in. A class
  456. * or bus can contain devices of different types
  457. * like "partitions" and "disks", "mouse" and "event".
  458. * This identifies the device type and carries type-specific
  459. * information, equivalent to the kobj_type of a kobject.
  460. * If "name" is specified, the uevent will contain it in
  461. * the DEVTYPE variable.
  462. */
  463. struct device_type {
  464. const char *name;
  465. const struct attribute_group **groups;
  466. int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
  467. char *(*devnode)(struct device *dev, umode_t *mode,
  468. kuid_t *uid, kgid_t *gid);
  469. void (*release)(struct device *dev);
  470. const struct dev_pm_ops *pm;
  471. };
  472. /* interface for exporting device attributes */
  473. struct device_attribute {
  474. struct attribute attr;
  475. ssize_t (*show)(struct device *dev, struct device_attribute *attr,
  476. char *buf);
  477. ssize_t (*store)(struct device *dev, struct device_attribute *attr,
  478. const char *buf, size_t count);
  479. };
  480. struct dev_ext_attribute {
  481. struct device_attribute attr;
  482. void *var;
  483. };
  484. ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
  485. char *buf);
  486. ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
  487. const char *buf, size_t count);
  488. ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
  489. char *buf);
  490. ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
  491. const char *buf, size_t count);
  492. ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
  493. char *buf);
  494. ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
  495. const char *buf, size_t count);
  496. #define DEVICE_ATTR(_name, _mode, _show, _store) \
  497. struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
  498. #define DEVICE_ATTR_RW(_name) \
  499. struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
  500. #define DEVICE_ATTR_RO(_name) \
  501. struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
  502. #define DEVICE_ATTR_WO(_name) \
  503. struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
  504. #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
  505. struct dev_ext_attribute dev_attr_##_name = \
  506. { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
  507. #define DEVICE_INT_ATTR(_name, _mode, _var) \
  508. struct dev_ext_attribute dev_attr_##_name = \
  509. { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
  510. #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
  511. struct dev_ext_attribute dev_attr_##_name = \
  512. { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
  513. #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
  514. struct device_attribute dev_attr_##_name = \
  515. __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
  516. extern int device_create_file(struct device *device,
  517. const struct device_attribute *entry);
  518. extern void device_remove_file(struct device *dev,
  519. const struct device_attribute *attr);
  520. extern bool device_remove_file_self(struct device *dev,
  521. const struct device_attribute *attr);
  522. extern int __must_check device_create_bin_file(struct device *dev,
  523. const struct bin_attribute *attr);
  524. extern void device_remove_bin_file(struct device *dev,
  525. const struct bin_attribute *attr);
  526. /* device resource management */
  527. typedef void (*dr_release_t)(struct device *dev, void *res);
  528. typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
  529. #ifdef CONFIG_DEBUG_DEVRES
  530. extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
  531. int nid, const char *name);
  532. #define devres_alloc(release, size, gfp) \
  533. __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
  534. #define devres_alloc_node(release, size, gfp, nid) \
  535. __devres_alloc_node(release, size, gfp, nid, #release)
  536. #else
  537. extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
  538. int nid);
  539. static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
  540. {
  541. return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
  542. }
  543. #endif
  544. extern void devres_for_each_res(struct device *dev, dr_release_t release,
  545. dr_match_t match, void *match_data,
  546. void (*fn)(struct device *, void *, void *),
  547. void *data);
  548. extern void devres_free(void *res);
  549. extern void devres_add(struct device *dev, void *res);
  550. extern void *devres_find(struct device *dev, dr_release_t release,
  551. dr_match_t match, void *match_data);
  552. extern void *devres_get(struct device *dev, void *new_res,
  553. dr_match_t match, void *match_data);
  554. extern void *devres_remove(struct device *dev, dr_release_t release,
  555. dr_match_t match, void *match_data);
  556. extern int devres_destroy(struct device *dev, dr_release_t release,
  557. dr_match_t match, void *match_data);
  558. extern int devres_release(struct device *dev, dr_release_t release,
  559. dr_match_t match, void *match_data);
  560. /* devres group */
  561. extern void * __must_check devres_open_group(struct device *dev, void *id,
  562. gfp_t gfp);
  563. extern void devres_close_group(struct device *dev, void *id);
  564. extern void devres_remove_group(struct device *dev, void *id);
  565. extern int devres_release_group(struct device *dev, void *id);
  566. /* managed devm_k.alloc/kfree for device drivers */
  567. extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp);
  568. extern __printf(3, 0)
  569. char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
  570. va_list ap);
  571. extern __printf(3, 4)
  572. char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...);
  573. static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
  574. {
  575. return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
  576. }
  577. static inline void *devm_kmalloc_array(struct device *dev,
  578. size_t n, size_t size, gfp_t flags)
  579. {
  580. if (size != 0 && n > SIZE_MAX / size)
  581. return NULL;
  582. return devm_kmalloc(dev, n * size, flags);
  583. }
  584. static inline void *devm_kcalloc(struct device *dev,
  585. size_t n, size_t size, gfp_t flags)
  586. {
  587. return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
  588. }
  589. extern void devm_kfree(struct device *dev, void *p);
  590. extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp);
  591. extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
  592. gfp_t gfp);
  593. extern unsigned long devm_get_free_pages(struct device *dev,
  594. gfp_t gfp_mask, unsigned int order);
  595. extern void devm_free_pages(struct device *dev, unsigned long addr);
  596. void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
  597. /* allows to add/remove a custom action to devres stack */
  598. int devm_add_action(struct device *dev, void (*action)(void *), void *data);
  599. void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
  600. struct device_dma_parameters {
  601. /*
  602. * a low level driver may set these to teach IOMMU code about
  603. * sg limitations.
  604. */
  605. unsigned int max_segment_size;
  606. unsigned long segment_boundary_mask;
  607. };
  608. /**
  609. * struct device - The basic device structure
  610. * @parent: The device's "parent" device, the device to which it is attached.
  611. * In most cases, a parent device is some sort of bus or host
  612. * controller. If parent is NULL, the device, is a top-level device,
  613. * which is not usually what you want.
  614. * @p: Holds the private data of the driver core portions of the device.
  615. * See the comment of the struct device_private for detail.
  616. * @kobj: A top-level, abstract class from which other classes are derived.
  617. * @init_name: Initial name of the device.
  618. * @type: The type of device.
  619. * This identifies the device type and carries type-specific
  620. * information.
  621. * @mutex: Mutex to synchronize calls to its driver.
  622. * @bus: Type of bus device is on.
  623. * @driver: Which driver has allocated this
  624. * @platform_data: Platform data specific to the device.
  625. * Example: For devices on custom boards, as typical of embedded
  626. * and SOC based hardware, Linux often uses platform_data to point
  627. * to board-specific structures describing devices and how they
  628. * are wired. That can include what ports are available, chip
  629. * variants, which GPIO pins act in what additional roles, and so
  630. * on. This shrinks the "Board Support Packages" (BSPs) and
  631. * minimizes board-specific #ifdefs in drivers.
  632. * @driver_data: Private pointer for driver specific info.
  633. * @power: For device power management.
  634. * See Documentation/power/devices.txt for details.
  635. * @pm_domain: Provide callbacks that are executed during system suspend,
  636. * hibernation, system resume and during runtime PM transitions
  637. * along with subsystem-level and driver-level callbacks.
  638. * @pins: For device pin management.
  639. * See Documentation/pinctrl.txt for details.
  640. * @msi_list: Hosts MSI descriptors
  641. * @msi_domain: The generic MSI domain this device is using.
  642. * @numa_node: NUMA node this device is close to.
  643. * @dma_mask: Dma mask (if dma'ble device).
  644. * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
  645. * hardware supports 64-bit addresses for consistent allocations
  646. * such descriptors.
  647. * @dma_pfn_offset: offset of DMA memory range relatively of RAM
  648. * @dma_parms: A low level driver may set these to teach IOMMU code about
  649. * segment limitations.
  650. * @dma_pools: Dma pools (if dma'ble device).
  651. * @dma_mem: Internal for coherent mem override.
  652. * @cma_area: Contiguous memory area for dma allocations
  653. * @archdata: For arch-specific additions.
  654. * @of_node: Associated device tree node.
  655. * @fwnode: Associated device node supplied by platform firmware.
  656. * @devt: For creating the sysfs "dev".
  657. * @id: device instance
  658. * @devres_lock: Spinlock to protect the resource of the device.
  659. * @devres_head: The resources list of the device.
  660. * @knode_class: The node used to add the device to the class list.
  661. * @class: The class of the device.
  662. * @groups: Optional attribute groups.
  663. * @release: Callback to free the device after all references have
  664. * gone away. This should be set by the allocator of the
  665. * device (i.e. the bus driver that discovered the device).
  666. * @iommu_group: IOMMU group the device belongs to.
  667. *
  668. * @offline_disabled: If set, the device is permanently online.
  669. * @offline: Set after successful invocation of bus type's .offline().
  670. *
  671. * At the lowest level, every device in a Linux system is represented by an
  672. * instance of struct device. The device structure contains the information
  673. * that the device model core needs to model the system. Most subsystems,
  674. * however, track additional information about the devices they host. As a
  675. * result, it is rare for devices to be represented by bare device structures;
  676. * instead, that structure, like kobject structures, is usually embedded within
  677. * a higher-level representation of the device.
  678. */
  679. struct device {
  680. struct device *parent;
  681. struct device_private *p;
  682. struct kobject kobj;
  683. const char *init_name; /* initial name of the device */
  684. const struct device_type *type;
  685. struct mutex mutex; /* mutex to synchronize calls to
  686. * its driver.
  687. */
  688. struct bus_type *bus; /* type of bus device is on */
  689. struct device_driver *driver; /* which driver has allocated this
  690. device */
  691. void *platform_data; /* Platform specific data, device
  692. core doesn't touch it */
  693. void *driver_data; /* Driver data, set and get with
  694. dev_set/get_drvdata */
  695. struct dev_pm_info power;
  696. struct dev_pm_domain *pm_domain;
  697. #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
  698. struct irq_domain *msi_domain;
  699. #endif
  700. #ifdef CONFIG_PINCTRL
  701. struct dev_pin_info *pins;
  702. #endif
  703. #ifdef CONFIG_GENERIC_MSI_IRQ
  704. struct list_head msi_list;
  705. #endif
  706. #ifdef CONFIG_NUMA
  707. int numa_node; /* NUMA node this device is close to */
  708. #endif
  709. u64 *dma_mask; /* dma mask (if dma'able device) */
  710. u64 coherent_dma_mask;/* Like dma_mask, but for
  711. alloc_coherent mappings as
  712. not all hardware supports
  713. 64 bit addresses for consistent
  714. allocations such descriptors. */
  715. unsigned long dma_pfn_offset;
  716. struct device_dma_parameters *dma_parms;
  717. struct list_head dma_pools; /* dma pools (if dma'ble) */
  718. struct dma_coherent_mem *dma_mem; /* internal for coherent mem
  719. override */
  720. #ifdef CONFIG_DMA_CMA
  721. struct cma *cma_area; /* contiguous memory area for dma
  722. allocations */
  723. #endif
  724. /* arch specific additions */
  725. struct dev_archdata archdata;
  726. struct device_node *of_node; /* associated device tree node */
  727. struct fwnode_handle *fwnode; /* firmware device node */
  728. dev_t devt; /* dev_t, creates the sysfs "dev" */
  729. u32 id; /* device instance */
  730. spinlock_t devres_lock;
  731. struct list_head devres_head;
  732. struct klist_node knode_class;
  733. struct class *class;
  734. const struct attribute_group **groups; /* optional groups */
  735. void (*release)(struct device *dev);
  736. struct iommu_group *iommu_group;
  737. bool offline_disabled:1;
  738. bool offline:1;
  739. };
  740. static inline struct device *kobj_to_dev(struct kobject *kobj)
  741. {
  742. return container_of(kobj, struct device, kobj);
  743. }
  744. /* Get the wakeup routines, which depend on struct device */
  745. #include <linux/pm_wakeup.h>
  746. static inline const char *dev_name(const struct device *dev)
  747. {
  748. /* Use the init name until the kobject becomes available */
  749. if (dev->init_name)
  750. return dev->init_name;
  751. return kobject_name(&dev->kobj);
  752. }
  753. extern __printf(2, 3)
  754. int dev_set_name(struct device *dev, const char *name, ...);
  755. #ifdef CONFIG_NUMA
  756. static inline int dev_to_node(struct device *dev)
  757. {
  758. return dev->numa_node;
  759. }
  760. static inline void set_dev_node(struct device *dev, int node)
  761. {
  762. dev->numa_node = node;
  763. }
  764. #else
  765. static inline int dev_to_node(struct device *dev)
  766. {
  767. return -1;
  768. }
  769. static inline void set_dev_node(struct device *dev, int node)
  770. {
  771. }
  772. #endif
  773. static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
  774. {
  775. #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
  776. return dev->msi_domain;
  777. #else
  778. return NULL;
  779. #endif
  780. }
  781. static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
  782. {
  783. #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
  784. dev->msi_domain = d;
  785. #endif
  786. }
  787. static inline void *dev_get_drvdata(const struct device *dev)
  788. {
  789. return dev->driver_data;
  790. }
  791. static inline void dev_set_drvdata(struct device *dev, void *data)
  792. {
  793. dev->driver_data = data;
  794. }
  795. static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
  796. {
  797. return dev ? dev->power.subsys_data : NULL;
  798. }
  799. static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
  800. {
  801. return dev->kobj.uevent_suppress;
  802. }
  803. static inline void dev_set_uevent_suppress(struct device *dev, int val)
  804. {
  805. dev->kobj.uevent_suppress = val;
  806. }
  807. static inline int device_is_registered(struct device *dev)
  808. {
  809. return dev->kobj.state_in_sysfs;
  810. }
  811. static inline void device_enable_async_suspend(struct device *dev)
  812. {
  813. if (!dev->power.is_prepared)
  814. dev->power.async_suspend = true;
  815. }
  816. static inline void device_disable_async_suspend(struct device *dev)
  817. {
  818. if (!dev->power.is_prepared)
  819. dev->power.async_suspend = false;
  820. }
  821. static inline bool device_async_suspend_enabled(struct device *dev)
  822. {
  823. return !!dev->power.async_suspend;
  824. }
  825. static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
  826. {
  827. dev->power.ignore_children = enable;
  828. }
  829. static inline void dev_pm_syscore_device(struct device *dev, bool val)
  830. {
  831. #ifdef CONFIG_PM_SLEEP
  832. dev->power.syscore = val;
  833. #endif
  834. }
  835. static inline void device_lock(struct device *dev)
  836. {
  837. mutex_lock(&dev->mutex);
  838. }
  839. static inline int device_trylock(struct device *dev)
  840. {
  841. return mutex_trylock(&dev->mutex);
  842. }
  843. static inline void device_unlock(struct device *dev)
  844. {
  845. mutex_unlock(&dev->mutex);
  846. }
  847. static inline void device_lock_assert(struct device *dev)
  848. {
  849. lockdep_assert_held(&dev->mutex);
  850. }
  851. static inline struct device_node *dev_of_node(struct device *dev)
  852. {
  853. if (!IS_ENABLED(CONFIG_OF))
  854. return NULL;
  855. return dev->of_node;
  856. }
  857. void driver_init(void);
  858. /*
  859. * High level routines for use by the bus drivers
  860. */
  861. extern int __must_check device_register(struct device *dev);
  862. extern void device_unregister(struct device *dev);
  863. extern void device_initialize(struct device *dev);
  864. extern int __must_check device_add(struct device *dev);
  865. extern void device_del(struct device *dev);
  866. extern int device_for_each_child(struct device *dev, void *data,
  867. int (*fn)(struct device *dev, void *data));
  868. extern int device_for_each_child_reverse(struct device *dev, void *data,
  869. int (*fn)(struct device *dev, void *data));
  870. extern struct device *device_find_child(struct device *dev, void *data,
  871. int (*match)(struct device *dev, void *data));
  872. extern int device_rename(struct device *dev, const char *new_name);
  873. extern int device_move(struct device *dev, struct device *new_parent,
  874. enum dpm_order dpm_order);
  875. extern const char *device_get_devnode(struct device *dev,
  876. umode_t *mode, kuid_t *uid, kgid_t *gid,
  877. const char **tmp);
  878. static inline bool device_supports_offline(struct device *dev)
  879. {
  880. return dev->bus && dev->bus->offline && dev->bus->online;
  881. }
  882. extern void lock_device_hotplug(void);
  883. extern void unlock_device_hotplug(void);
  884. extern int lock_device_hotplug_sysfs(void);
  885. extern int device_offline(struct device *dev);
  886. extern int device_online(struct device *dev);
  887. extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
  888. extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
  889. /*
  890. * Root device objects for grouping under /sys/devices
  891. */
  892. extern struct device *__root_device_register(const char *name,
  893. struct module *owner);
  894. /* This is a macro to avoid include problems with THIS_MODULE */
  895. #define root_device_register(name) \
  896. __root_device_register(name, THIS_MODULE)
  897. extern void root_device_unregister(struct device *root);
  898. static inline void *dev_get_platdata(const struct device *dev)
  899. {
  900. return dev->platform_data;
  901. }
  902. /*
  903. * Manual binding of a device to driver. See drivers/base/bus.c
  904. * for information on use.
  905. */
  906. extern int __must_check device_bind_driver(struct device *dev);
  907. extern void device_release_driver(struct device *dev);
  908. extern int __must_check device_attach(struct device *dev);
  909. extern int __must_check driver_attach(struct device_driver *drv);
  910. extern void device_initial_probe(struct device *dev);
  911. extern int __must_check device_reprobe(struct device *dev);
  912. /*
  913. * Easy functions for dynamically creating devices on the fly
  914. */
  915. extern __printf(5, 0)
  916. struct device *device_create_vargs(struct class *cls, struct device *parent,
  917. dev_t devt, void *drvdata,
  918. const char *fmt, va_list vargs);
  919. extern __printf(5, 6)
  920. struct device *device_create(struct class *cls, struct device *parent,
  921. dev_t devt, void *drvdata,
  922. const char *fmt, ...);
  923. extern __printf(6, 7)
  924. struct device *device_create_with_groups(struct class *cls,
  925. struct device *parent, dev_t devt, void *drvdata,
  926. const struct attribute_group **groups,
  927. const char *fmt, ...);
  928. extern void device_destroy(struct class *cls, dev_t devt);
  929. /*
  930. * Platform "fixup" functions - allow the platform to have their say
  931. * about devices and actions that the general device layer doesn't
  932. * know about.
  933. */
  934. /* Notify platform of device discovery */
  935. extern int (*platform_notify)(struct device *dev);
  936. extern int (*platform_notify_remove)(struct device *dev);
  937. /*
  938. * get_device - atomically increment the reference count for the device.
  939. *
  940. */
  941. extern struct device *get_device(struct device *dev);
  942. extern void put_device(struct device *dev);
  943. #ifdef CONFIG_DEVTMPFS
  944. extern int devtmpfs_create_node(struct device *dev);
  945. extern int devtmpfs_delete_node(struct device *dev);
  946. extern int devtmpfs_mount(const char *mntdir);
  947. #else
  948. static inline int devtmpfs_create_node(struct device *dev) { return 0; }
  949. static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
  950. static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
  951. #endif
  952. /* drivers/base/power/shutdown.c */
  953. extern void device_shutdown(void);
  954. /* debugging and troubleshooting/diagnostic helpers. */
  955. extern const char *dev_driver_string(const struct device *dev);
  956. #ifdef CONFIG_PRINTK
  957. extern __printf(3, 0)
  958. int dev_vprintk_emit(int level, const struct device *dev,
  959. const char *fmt, va_list args);
  960. extern __printf(3, 4)
  961. int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
  962. extern __printf(3, 4)
  963. void dev_printk(const char *level, const struct device *dev,
  964. const char *fmt, ...);
  965. extern __printf(2, 3)
  966. void dev_emerg(const struct device *dev, const char *fmt, ...);
  967. extern __printf(2, 3)
  968. void dev_alert(const struct device *dev, const char *fmt, ...);
  969. extern __printf(2, 3)
  970. void dev_crit(const struct device *dev, const char *fmt, ...);
  971. extern __printf(2, 3)
  972. void dev_err(const struct device *dev, const char *fmt, ...);
  973. extern __printf(2, 3)
  974. void dev_warn(const struct device *dev, const char *fmt, ...);
  975. extern __printf(2, 3)
  976. void dev_notice(const struct device *dev, const char *fmt, ...);
  977. extern __printf(2, 3)
  978. void _dev_info(const struct device *dev, const char *fmt, ...);
  979. #else
  980. static inline __printf(3, 0)
  981. int dev_vprintk_emit(int level, const struct device *dev,
  982. const char *fmt, va_list args)
  983. { return 0; }
  984. static inline __printf(3, 4)
  985. int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
  986. { return 0; }
  987. static inline void __dev_printk(const char *level, const struct device *dev,
  988. struct va_format *vaf)
  989. {}
  990. static inline __printf(3, 4)
  991. void dev_printk(const char *level, const struct device *dev,
  992. const char *fmt, ...)
  993. {}
  994. static inline __printf(2, 3)
  995. void dev_emerg(const struct device *dev, const char *fmt, ...)
  996. {}
  997. static inline __printf(2, 3)
  998. void dev_crit(const struct device *dev, const char *fmt, ...)
  999. {}
  1000. static inline __printf(2, 3)
  1001. void dev_alert(const struct device *dev, const char *fmt, ...)
  1002. {}
  1003. static inline __printf(2, 3)
  1004. void dev_err(const struct device *dev, const char *fmt, ...)
  1005. {}
  1006. static inline __printf(2, 3)
  1007. void dev_warn(const struct device *dev, const char *fmt, ...)
  1008. {}
  1009. static inline __printf(2, 3)
  1010. void dev_notice(const struct device *dev, const char *fmt, ...)
  1011. {}
  1012. static inline __printf(2, 3)
  1013. void _dev_info(const struct device *dev, const char *fmt, ...)
  1014. {}
  1015. #endif
  1016. /*
  1017. * Stupid hackaround for existing uses of non-printk uses dev_info
  1018. *
  1019. * Note that the definition of dev_info below is actually _dev_info
  1020. * and a macro is used to avoid redefining dev_info
  1021. */
  1022. #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
  1023. #if defined(CONFIG_DYNAMIC_DEBUG)
  1024. #define dev_dbg(dev, format, ...) \
  1025. do { \
  1026. dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
  1027. } while (0)
  1028. #elif defined(DEBUG)
  1029. #define dev_dbg(dev, format, arg...) \
  1030. dev_printk(KERN_DEBUG, dev, format, ##arg)
  1031. #else
  1032. #define dev_dbg(dev, format, arg...) \
  1033. ({ \
  1034. if (0) \
  1035. dev_printk(KERN_DEBUG, dev, format, ##arg); \
  1036. })
  1037. #endif
  1038. #ifdef CONFIG_PRINTK
  1039. #define dev_level_once(dev_level, dev, fmt, ...) \
  1040. do { \
  1041. static bool __print_once __read_mostly; \
  1042. \
  1043. if (!__print_once) { \
  1044. __print_once = true; \
  1045. dev_level(dev, fmt, ##__VA_ARGS__); \
  1046. } \
  1047. } while (0)
  1048. #else
  1049. #define dev_level_once(dev_level, dev, fmt, ...) \
  1050. do { \
  1051. if (0) \
  1052. dev_level(dev, fmt, ##__VA_ARGS__); \
  1053. } while (0)
  1054. #endif
  1055. #define dev_emerg_once(dev, fmt, ...) \
  1056. dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
  1057. #define dev_alert_once(dev, fmt, ...) \
  1058. dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
  1059. #define dev_crit_once(dev, fmt, ...) \
  1060. dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
  1061. #define dev_err_once(dev, fmt, ...) \
  1062. dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
  1063. #define dev_warn_once(dev, fmt, ...) \
  1064. dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
  1065. #define dev_notice_once(dev, fmt, ...) \
  1066. dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
  1067. #define dev_info_once(dev, fmt, ...) \
  1068. dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
  1069. #define dev_dbg_once(dev, fmt, ...) \
  1070. dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
  1071. #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
  1072. do { \
  1073. static DEFINE_RATELIMIT_STATE(_rs, \
  1074. DEFAULT_RATELIMIT_INTERVAL, \
  1075. DEFAULT_RATELIMIT_BURST); \
  1076. if (__ratelimit(&_rs)) \
  1077. dev_level(dev, fmt, ##__VA_ARGS__); \
  1078. } while (0)
  1079. #define dev_emerg_ratelimited(dev, fmt, ...) \
  1080. dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
  1081. #define dev_alert_ratelimited(dev, fmt, ...) \
  1082. dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
  1083. #define dev_crit_ratelimited(dev, fmt, ...) \
  1084. dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
  1085. #define dev_err_ratelimited(dev, fmt, ...) \
  1086. dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
  1087. #define dev_warn_ratelimited(dev, fmt, ...) \
  1088. dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
  1089. #define dev_notice_ratelimited(dev, fmt, ...) \
  1090. dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
  1091. #define dev_info_ratelimited(dev, fmt, ...) \
  1092. dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
  1093. #if defined(CONFIG_DYNAMIC_DEBUG)
  1094. /* descriptor check is first to prevent flooding with "callbacks suppressed" */
  1095. #define dev_dbg_ratelimited(dev, fmt, ...) \
  1096. do { \
  1097. static DEFINE_RATELIMIT_STATE(_rs, \
  1098. DEFAULT_RATELIMIT_INTERVAL, \
  1099. DEFAULT_RATELIMIT_BURST); \
  1100. DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
  1101. if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
  1102. __ratelimit(&_rs)) \
  1103. __dynamic_dev_dbg(&descriptor, dev, fmt, \
  1104. ##__VA_ARGS__); \
  1105. } while (0)
  1106. #elif defined(DEBUG)
  1107. #define dev_dbg_ratelimited(dev, fmt, ...) \
  1108. do { \
  1109. static DEFINE_RATELIMIT_STATE(_rs, \
  1110. DEFAULT_RATELIMIT_INTERVAL, \
  1111. DEFAULT_RATELIMIT_BURST); \
  1112. if (__ratelimit(&_rs)) \
  1113. dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
  1114. } while (0)
  1115. #else
  1116. #define dev_dbg_ratelimited(dev, fmt, ...) \
  1117. no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
  1118. #endif
  1119. #ifdef VERBOSE_DEBUG
  1120. #define dev_vdbg dev_dbg
  1121. #else
  1122. #define dev_vdbg(dev, format, arg...) \
  1123. ({ \
  1124. if (0) \
  1125. dev_printk(KERN_DEBUG, dev, format, ##arg); \
  1126. })
  1127. #endif
  1128. /*
  1129. * dev_WARN*() acts like dev_printk(), but with the key difference of
  1130. * using WARN/WARN_ONCE to include file/line information and a backtrace.
  1131. */
  1132. #define dev_WARN(dev, format, arg...) \
  1133. WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
  1134. #define dev_WARN_ONCE(dev, condition, format, arg...) \
  1135. WARN_ONCE(condition, "%s %s: " format, \
  1136. dev_driver_string(dev), dev_name(dev), ## arg)
  1137. /* Create alias, so I can be autoloaded. */
  1138. #define MODULE_ALIAS_CHARDEV(major,minor) \
  1139. MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
  1140. #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
  1141. MODULE_ALIAS("char-major-" __stringify(major) "-*")
  1142. #ifdef CONFIG_SYSFS_DEPRECATED
  1143. extern long sysfs_deprecated;
  1144. #else
  1145. #define sysfs_deprecated 0
  1146. #endif
  1147. /**
  1148. * module_driver() - Helper macro for drivers that don't do anything
  1149. * special in module init/exit. This eliminates a lot of boilerplate.
  1150. * Each module may only use this macro once, and calling it replaces
  1151. * module_init() and module_exit().
  1152. *
  1153. * @__driver: driver name
  1154. * @__register: register function for this driver type
  1155. * @__unregister: unregister function for this driver type
  1156. * @...: Additional arguments to be passed to __register and __unregister.
  1157. *
  1158. * Use this macro to construct bus specific macros for registering
  1159. * drivers, and do not use it on its own.
  1160. */
  1161. #define module_driver(__driver, __register, __unregister, ...) \
  1162. static int __init __driver##_init(void) \
  1163. { \
  1164. return __register(&(__driver) , ##__VA_ARGS__); \
  1165. } \
  1166. module_init(__driver##_init); \
  1167. static void __exit __driver##_exit(void) \
  1168. { \
  1169. __unregister(&(__driver) , ##__VA_ARGS__); \
  1170. } \
  1171. module_exit(__driver##_exit);
  1172. /**
  1173. * builtin_driver() - Helper macro for drivers that don't do anything
  1174. * special in init and have no exit. This eliminates some boilerplate.
  1175. * Each driver may only use this macro once, and calling it replaces
  1176. * device_initcall (or in some cases, the legacy __initcall). This is
  1177. * meant to be a direct parallel of module_driver() above but without
  1178. * the __exit stuff that is not used for builtin cases.
  1179. *
  1180. * @__driver: driver name
  1181. * @__register: register function for this driver type
  1182. * @...: Additional arguments to be passed to __register
  1183. *
  1184. * Use this macro to construct bus specific macros for registering
  1185. * drivers, and do not use it on its own.
  1186. */
  1187. #define builtin_driver(__driver, __register, ...) \
  1188. static int __init __driver##_init(void) \
  1189. { \
  1190. return __register(&(__driver) , ##__VA_ARGS__); \
  1191. } \
  1192. device_initcall(__driver##_init);
  1193. #endif /* _DEVICE_H_ */