sysfs.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
  1. /*
  2. * sysfs.h - definitions for the device driver filesystem
  3. *
  4. * Copyright (c) 2001,2002 Patrick Mochel
  5. * Copyright (c) 2004 Silicon Graphics, Inc.
  6. * Copyright (c) 2007 SUSE Linux Products GmbH
  7. * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
  8. *
  9. * Please see Documentation/filesystems/sysfs.txt for more information.
  10. */
  11. #ifndef _SYSFS_H_
  12. #define _SYSFS_H_
  13. #include <linux/compiler.h>
  14. #include <linux/errno.h>
  15. #include <linux/list.h>
  16. #include <linux/lockdep.h>
  17. #include <linux/kobject_ns.h>
  18. #include <linux/stat.h>
  19. #include <linux/atomic.h>
  20. struct kobject;
  21. struct module;
  22. struct bin_attribute;
  23. enum kobj_ns_type;
  24. struct attribute {
  25. const char *name;
  26. umode_t mode;
  27. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  28. bool ignore_lockdep:1;
  29. struct lock_class_key *key;
  30. struct lock_class_key skey;
  31. #endif
  32. };
  33. /**
  34. * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
  35. * @attr: struct attribute to initialize
  36. *
  37. * Initialize a dynamically allocated struct attribute so we can
  38. * make lockdep happy. This is a new requirement for attributes
  39. * and initially this is only needed when lockdep is enabled.
  40. * Lockdep gives a nice error when your attribute is added to
  41. * sysfs if you don't have this.
  42. */
  43. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  44. #define sysfs_attr_init(attr) \
  45. do { \
  46. static struct lock_class_key __key; \
  47. \
  48. (attr)->key = &__key; \
  49. } while (0)
  50. #else
  51. #define sysfs_attr_init(attr) do {} while (0)
  52. #endif
  53. struct attribute_group {
  54. const char *name;
  55. umode_t (*is_visible)(struct kobject *,
  56. struct attribute *, int);
  57. struct attribute **attrs;
  58. struct bin_attribute **bin_attrs;
  59. };
  60. /**
  61. * Use these macros to make defining attributes easier. See include/linux/device.h
  62. * for examples..
  63. */
  64. #define __ATTR(_name, _mode, _show, _store) { \
  65. .attr = {.name = __stringify(_name), .mode = _mode }, \
  66. .show = _show, \
  67. .store = _store, \
  68. }
  69. #define __ATTR_RO(_name) { \
  70. .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
  71. .show = _name##_show, \
  72. }
  73. #define __ATTR_WO(_name) { \
  74. .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \
  75. .store = _name##_store, \
  76. }
  77. #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
  78. _name##_show, _name##_store)
  79. #define __ATTR_NULL { .attr = { .name = NULL } }
  80. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  81. #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
  82. .attr = {.name = __stringify(_name), .mode = _mode, \
  83. .ignore_lockdep = true }, \
  84. .show = _show, \
  85. .store = _store, \
  86. }
  87. #else
  88. #define __ATTR_IGNORE_LOCKDEP __ATTR
  89. #endif
  90. #define __ATTRIBUTE_GROUPS(_name) \
  91. static const struct attribute_group *_name##_groups[] = { \
  92. &_name##_group, \
  93. NULL, \
  94. }
  95. #define ATTRIBUTE_GROUPS(_name) \
  96. static const struct attribute_group _name##_group = { \
  97. .attrs = _name##_attrs, \
  98. }; \
  99. __ATTRIBUTE_GROUPS(_name)
  100. struct file;
  101. struct vm_area_struct;
  102. struct bin_attribute {
  103. struct attribute attr;
  104. size_t size;
  105. void *private;
  106. ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
  107. char *, loff_t, size_t);
  108. ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
  109. char *, loff_t, size_t);
  110. int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
  111. struct vm_area_struct *vma);
  112. };
  113. /**
  114. * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
  115. * @attr: struct bin_attribute to initialize
  116. *
  117. * Initialize a dynamically allocated struct bin_attribute so we
  118. * can make lockdep happy. This is a new requirement for
  119. * attributes and initially this is only needed when lockdep is
  120. * enabled. Lockdep gives a nice error when your attribute is
  121. * added to sysfs if you don't have this.
  122. */
  123. #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
  124. /* macros to create static binary attributes easier */
  125. #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
  126. .attr = { .name = __stringify(_name), .mode = _mode }, \
  127. .read = _read, \
  128. .write = _write, \
  129. .size = _size, \
  130. }
  131. #define __BIN_ATTR_RO(_name, _size) { \
  132. .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
  133. .read = _name##_read, \
  134. .size = _size, \
  135. }
  136. #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
  137. (S_IWUSR | S_IRUGO), _name##_read, \
  138. _name##_write, _size)
  139. #define __BIN_ATTR_NULL __ATTR_NULL
  140. #define BIN_ATTR(_name, _mode, _read, _write, _size) \
  141. struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
  142. _write, _size)
  143. #define BIN_ATTR_RO(_name, _size) \
  144. struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
  145. #define BIN_ATTR_RW(_name, _size) \
  146. struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
  147. struct sysfs_ops {
  148. ssize_t (*show)(struct kobject *, struct attribute *, char *);
  149. ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
  150. };
  151. struct sysfs_dirent;
  152. #ifdef CONFIG_SYSFS
  153. int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
  154. void *data, struct module *owner);
  155. int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns);
  156. void sysfs_remove_dir(struct kobject *kobj);
  157. int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
  158. const void *new_ns);
  159. int __must_check sysfs_move_dir_ns(struct kobject *kobj,
  160. struct kobject *new_parent_kobj,
  161. const void *new_ns);
  162. int __must_check sysfs_create_file_ns(struct kobject *kobj,
  163. const struct attribute *attr,
  164. const void *ns);
  165. int __must_check sysfs_create_files(struct kobject *kobj,
  166. const struct attribute **attr);
  167. int __must_check sysfs_chmod_file(struct kobject *kobj,
  168. const struct attribute *attr, umode_t mode);
  169. void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
  170. const void *ns);
  171. void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
  172. int __must_check sysfs_create_bin_file(struct kobject *kobj,
  173. const struct bin_attribute *attr);
  174. void sysfs_remove_bin_file(struct kobject *kobj,
  175. const struct bin_attribute *attr);
  176. int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
  177. const char *name);
  178. int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
  179. struct kobject *target,
  180. const char *name);
  181. void sysfs_remove_link(struct kobject *kobj, const char *name);
  182. int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
  183. const char *old_name, const char *new_name,
  184. const void *new_ns);
  185. void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
  186. const char *name);
  187. int __must_check sysfs_create_group(struct kobject *kobj,
  188. const struct attribute_group *grp);
  189. int __must_check sysfs_create_groups(struct kobject *kobj,
  190. const struct attribute_group **groups);
  191. int sysfs_update_group(struct kobject *kobj,
  192. const struct attribute_group *grp);
  193. void sysfs_remove_group(struct kobject *kobj,
  194. const struct attribute_group *grp);
  195. void sysfs_remove_groups(struct kobject *kobj,
  196. const struct attribute_group **groups);
  197. int sysfs_add_file_to_group(struct kobject *kobj,
  198. const struct attribute *attr, const char *group);
  199. void sysfs_remove_file_from_group(struct kobject *kobj,
  200. const struct attribute *attr, const char *group);
  201. int sysfs_merge_group(struct kobject *kobj,
  202. const struct attribute_group *grp);
  203. void sysfs_unmerge_group(struct kobject *kobj,
  204. const struct attribute_group *grp);
  205. int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
  206. struct kobject *target, const char *link_name);
  207. void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
  208. const char *link_name);
  209. void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
  210. void sysfs_notify_dirent(struct sysfs_dirent *sd);
  211. struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
  212. const void *ns,
  213. const unsigned char *name);
  214. struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
  215. void sysfs_put(struct sysfs_dirent *sd);
  216. int __must_check sysfs_init(void);
  217. #else /* CONFIG_SYSFS */
  218. static inline int sysfs_schedule_callback(struct kobject *kobj,
  219. void (*func)(void *), void *data, struct module *owner)
  220. {
  221. return -ENOSYS;
  222. }
  223. static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
  224. {
  225. return 0;
  226. }
  227. static inline void sysfs_remove_dir(struct kobject *kobj)
  228. {
  229. }
  230. static inline int sysfs_rename_dir_ns(struct kobject *kobj,
  231. const char *new_name, const void *new_ns)
  232. {
  233. return 0;
  234. }
  235. static inline int sysfs_move_dir_ns(struct kobject *kobj,
  236. struct kobject *new_parent_kobj,
  237. const void *new_ns)
  238. {
  239. return 0;
  240. }
  241. static inline int sysfs_create_file_ns(struct kobject *kobj,
  242. const struct attribute *attr,
  243. const void *ns)
  244. {
  245. return 0;
  246. }
  247. static inline int sysfs_create_files(struct kobject *kobj,
  248. const struct attribute **attr)
  249. {
  250. return 0;
  251. }
  252. static inline int sysfs_chmod_file(struct kobject *kobj,
  253. const struct attribute *attr, umode_t mode)
  254. {
  255. return 0;
  256. }
  257. static inline void sysfs_remove_file_ns(struct kobject *kobj,
  258. const struct attribute *attr,
  259. const void *ns)
  260. {
  261. }
  262. static inline void sysfs_remove_files(struct kobject *kobj,
  263. const struct attribute **attr)
  264. {
  265. }
  266. static inline int sysfs_create_bin_file(struct kobject *kobj,
  267. const struct bin_attribute *attr)
  268. {
  269. return 0;
  270. }
  271. static inline void sysfs_remove_bin_file(struct kobject *kobj,
  272. const struct bin_attribute *attr)
  273. {
  274. }
  275. static inline int sysfs_create_link(struct kobject *kobj,
  276. struct kobject *target, const char *name)
  277. {
  278. return 0;
  279. }
  280. static inline int sysfs_create_link_nowarn(struct kobject *kobj,
  281. struct kobject *target,
  282. const char *name)
  283. {
  284. return 0;
  285. }
  286. static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
  287. {
  288. }
  289. static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t,
  290. const char *old_name,
  291. const char *new_name, const void *ns)
  292. {
  293. return 0;
  294. }
  295. static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
  296. const char *name)
  297. {
  298. }
  299. static inline int sysfs_create_group(struct kobject *kobj,
  300. const struct attribute_group *grp)
  301. {
  302. return 0;
  303. }
  304. static inline int sysfs_create_groups(struct kobject *kobj,
  305. const struct attribute_group **groups)
  306. {
  307. return 0;
  308. }
  309. static inline int sysfs_update_group(struct kobject *kobj,
  310. const struct attribute_group *grp)
  311. {
  312. return 0;
  313. }
  314. static inline void sysfs_remove_group(struct kobject *kobj,
  315. const struct attribute_group *grp)
  316. {
  317. }
  318. static inline void sysfs_remove_groups(struct kobject *kobj,
  319. const struct attribute_group **groups)
  320. {
  321. }
  322. static inline int sysfs_add_file_to_group(struct kobject *kobj,
  323. const struct attribute *attr, const char *group)
  324. {
  325. return 0;
  326. }
  327. static inline void sysfs_remove_file_from_group(struct kobject *kobj,
  328. const struct attribute *attr, const char *group)
  329. {
  330. }
  331. static inline int sysfs_merge_group(struct kobject *kobj,
  332. const struct attribute_group *grp)
  333. {
  334. return 0;
  335. }
  336. static inline void sysfs_unmerge_group(struct kobject *kobj,
  337. const struct attribute_group *grp)
  338. {
  339. }
  340. static inline int sysfs_add_link_to_group(struct kobject *kobj,
  341. const char *group_name, struct kobject *target,
  342. const char *link_name)
  343. {
  344. return 0;
  345. }
  346. static inline void sysfs_remove_link_from_group(struct kobject *kobj,
  347. const char *group_name, const char *link_name)
  348. {
  349. }
  350. static inline void sysfs_notify(struct kobject *kobj, const char *dir,
  351. const char *attr)
  352. {
  353. }
  354. static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
  355. {
  356. }
  357. static inline
  358. struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
  359. const void *ns,
  360. const unsigned char *name)
  361. {
  362. return NULL;
  363. }
  364. static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
  365. {
  366. return NULL;
  367. }
  368. static inline void sysfs_put(struct sysfs_dirent *sd)
  369. {
  370. }
  371. static inline int __must_check sysfs_init(void)
  372. {
  373. return 0;
  374. }
  375. #endif /* CONFIG_SYSFS */
  376. static inline int __must_check sysfs_create_file(struct kobject *kobj,
  377. const struct attribute *attr)
  378. {
  379. return sysfs_create_file_ns(kobj, attr, NULL);
  380. }
  381. static inline void sysfs_remove_file(struct kobject *kobj,
  382. const struct attribute *attr)
  383. {
  384. return sysfs_remove_file_ns(kobj, attr, NULL);
  385. }
  386. static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
  387. const char *old_name, const char *new_name)
  388. {
  389. return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL);
  390. }
  391. #endif /* _SYSFS_H_ */