sysfs.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  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 = 0444 }, \
  71. .show = _name##_show, \
  72. }
  73. #define __ATTR_RW(_name) __ATTR(_name, 0644, _name##_show, _name##_store)
  74. #define __ATTR_NULL { .attr = { .name = NULL } }
  75. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  76. #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
  77. .attr = {.name = __stringify(_name), .mode = _mode, \
  78. .ignore_lockdep = true }, \
  79. .show = _show, \
  80. .store = _store, \
  81. }
  82. #else
  83. #define __ATTR_IGNORE_LOCKDEP __ATTR
  84. #endif
  85. #define __ATTRIBUTE_GROUPS(_name) \
  86. static const struct attribute_group *_name##_groups[] = { \
  87. &_name##_group, \
  88. NULL, \
  89. }
  90. #define ATTRIBUTE_GROUPS(_name) \
  91. static const struct attribute_group _name##_group = { \
  92. .attrs = _name##_attrs, \
  93. }; \
  94. __ATTRIBUTE_GROUPS(_name)
  95. #define attr_name(_attr) (_attr).attr.name
  96. struct file;
  97. struct vm_area_struct;
  98. struct bin_attribute {
  99. struct attribute attr;
  100. size_t size;
  101. void *private;
  102. ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
  103. char *, loff_t, size_t);
  104. ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *,
  105. char *, loff_t, size_t);
  106. int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
  107. struct vm_area_struct *vma);
  108. };
  109. /**
  110. * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
  111. * @attr: struct bin_attribute to initialize
  112. *
  113. * Initialize a dynamically allocated struct bin_attribute so we
  114. * can make lockdep happy. This is a new requirement for
  115. * attributes and initially this is only needed when lockdep is
  116. * enabled. Lockdep gives a nice error when your attribute is
  117. * added to sysfs if you don't have this.
  118. */
  119. #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
  120. /* macros to create static binary attributes easier */
  121. #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
  122. .attr = { .name = __stringify(_name), .mode = _mode }, \
  123. .read = _read, \
  124. .write = _write, \
  125. .size = _size, \
  126. }
  127. #define __BIN_ATTR_RO(_name, _size) { \
  128. .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
  129. .read = _name##_read, \
  130. .size = _size, \
  131. }
  132. #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
  133. (S_IWUSR | S_IRUGO), _name##_read, \
  134. _name##_write)
  135. #define __BIN_ATTR_NULL __ATTR_NULL
  136. #define BIN_ATTR(_name, _mode, _read, _write, _size) \
  137. struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
  138. _write, _size)
  139. #define BIN_ATTR_RO(_name, _size) \
  140. struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
  141. #define BIN_ATTR_RW(_name, _size) \
  142. struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
  143. struct sysfs_ops {
  144. ssize_t (*show)(struct kobject *, struct attribute *,char *);
  145. ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
  146. const void *(*namespace)(struct kobject *, const struct attribute *);
  147. };
  148. struct sysfs_dirent;
  149. #ifdef CONFIG_SYSFS
  150. int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
  151. void *data, struct module *owner);
  152. int __must_check sysfs_create_dir(struct kobject *kobj);
  153. void sysfs_remove_dir(struct kobject *kobj);
  154. int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
  155. int __must_check sysfs_move_dir(struct kobject *kobj,
  156. struct kobject *new_parent_kobj);
  157. int __must_check sysfs_create_file(struct kobject *kobj,
  158. const struct attribute *attr);
  159. int __must_check sysfs_create_files(struct kobject *kobj,
  160. const struct attribute **attr);
  161. int __must_check sysfs_chmod_file(struct kobject *kobj,
  162. const struct attribute *attr, umode_t mode);
  163. void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
  164. void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
  165. int __must_check sysfs_create_bin_file(struct kobject *kobj,
  166. const struct bin_attribute *attr);
  167. void sysfs_remove_bin_file(struct kobject *kobj,
  168. const struct bin_attribute *attr);
  169. int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
  170. const char *name);
  171. int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
  172. struct kobject *target,
  173. const char *name);
  174. void sysfs_remove_link(struct kobject *kobj, const char *name);
  175. int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
  176. const char *old_name, const char *new_name);
  177. void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
  178. const char *name);
  179. int __must_check sysfs_create_group(struct kobject *kobj,
  180. const struct attribute_group *grp);
  181. int sysfs_update_group(struct kobject *kobj,
  182. const struct attribute_group *grp);
  183. void sysfs_remove_group(struct kobject *kobj,
  184. const struct attribute_group *grp);
  185. int sysfs_add_file_to_group(struct kobject *kobj,
  186. const struct attribute *attr, const char *group);
  187. void sysfs_remove_file_from_group(struct kobject *kobj,
  188. const struct attribute *attr, const char *group);
  189. int sysfs_merge_group(struct kobject *kobj,
  190. const struct attribute_group *grp);
  191. void sysfs_unmerge_group(struct kobject *kobj,
  192. const struct attribute_group *grp);
  193. int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
  194. struct kobject *target, const char *link_name);
  195. void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
  196. const char *link_name);
  197. void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
  198. void sysfs_notify_dirent(struct sysfs_dirent *sd);
  199. struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
  200. const void *ns,
  201. const unsigned char *name);
  202. struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
  203. void sysfs_put(struct sysfs_dirent *sd);
  204. int __must_check sysfs_init(void);
  205. #else /* CONFIG_SYSFS */
  206. static inline int sysfs_schedule_callback(struct kobject *kobj,
  207. void (*func)(void *), void *data, struct module *owner)
  208. {
  209. return -ENOSYS;
  210. }
  211. static inline int sysfs_create_dir(struct kobject *kobj)
  212. {
  213. return 0;
  214. }
  215. static inline void sysfs_remove_dir(struct kobject *kobj)
  216. {
  217. }
  218. static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
  219. {
  220. return 0;
  221. }
  222. static inline int sysfs_move_dir(struct kobject *kobj,
  223. struct kobject *new_parent_kobj)
  224. {
  225. return 0;
  226. }
  227. static inline int sysfs_create_file(struct kobject *kobj,
  228. const struct attribute *attr)
  229. {
  230. return 0;
  231. }
  232. static inline int sysfs_create_files(struct kobject *kobj,
  233. const struct attribute **attr)
  234. {
  235. return 0;
  236. }
  237. static inline int sysfs_chmod_file(struct kobject *kobj,
  238. const struct attribute *attr, umode_t mode)
  239. {
  240. return 0;
  241. }
  242. static inline void sysfs_remove_file(struct kobject *kobj,
  243. const struct attribute *attr)
  244. {
  245. }
  246. static inline void sysfs_remove_files(struct kobject *kobj,
  247. const struct attribute **attr)
  248. {
  249. }
  250. static inline int sysfs_create_bin_file(struct kobject *kobj,
  251. const struct bin_attribute *attr)
  252. {
  253. return 0;
  254. }
  255. static inline void sysfs_remove_bin_file(struct kobject *kobj,
  256. const struct bin_attribute *attr)
  257. {
  258. }
  259. static inline int sysfs_create_link(struct kobject *kobj,
  260. struct kobject *target, const char *name)
  261. {
  262. return 0;
  263. }
  264. static inline int sysfs_create_link_nowarn(struct kobject *kobj,
  265. struct kobject *target,
  266. const char *name)
  267. {
  268. return 0;
  269. }
  270. static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
  271. {
  272. }
  273. static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
  274. const char *old_name, const char *new_name)
  275. {
  276. return 0;
  277. }
  278. static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
  279. const char *name)
  280. {
  281. }
  282. static inline int sysfs_create_group(struct kobject *kobj,
  283. const struct attribute_group *grp)
  284. {
  285. return 0;
  286. }
  287. static inline int sysfs_update_group(struct kobject *kobj,
  288. const struct attribute_group *grp)
  289. {
  290. return 0;
  291. }
  292. static inline void sysfs_remove_group(struct kobject *kobj,
  293. const struct attribute_group *grp)
  294. {
  295. }
  296. static inline int sysfs_add_file_to_group(struct kobject *kobj,
  297. const struct attribute *attr, const char *group)
  298. {
  299. return 0;
  300. }
  301. static inline void sysfs_remove_file_from_group(struct kobject *kobj,
  302. const struct attribute *attr, const char *group)
  303. {
  304. }
  305. static inline int sysfs_merge_group(struct kobject *kobj,
  306. const struct attribute_group *grp)
  307. {
  308. return 0;
  309. }
  310. static inline void sysfs_unmerge_group(struct kobject *kobj,
  311. const struct attribute_group *grp)
  312. {
  313. }
  314. static inline int sysfs_add_link_to_group(struct kobject *kobj,
  315. const char *group_name, struct kobject *target,
  316. const char *link_name)
  317. {
  318. return 0;
  319. }
  320. static inline void sysfs_remove_link_from_group(struct kobject *kobj,
  321. const char *group_name, const char *link_name)
  322. {
  323. }
  324. static inline void sysfs_notify(struct kobject *kobj, const char *dir,
  325. const char *attr)
  326. {
  327. }
  328. static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
  329. {
  330. }
  331. static inline
  332. struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
  333. const void *ns,
  334. const unsigned char *name)
  335. {
  336. return NULL;
  337. }
  338. static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
  339. {
  340. return NULL;
  341. }
  342. static inline void sysfs_put(struct sysfs_dirent *sd)
  343. {
  344. }
  345. static inline int __must_check sysfs_init(void)
  346. {
  347. return 0;
  348. }
  349. #endif /* CONFIG_SYSFS */
  350. #endif /* _SYSFS_H_ */