device.h 47 KB

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