1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * The class-specific portions of the driver model 4 * 5 * Copyright (c) 2001-2003 Patrick Mochel <[email protected]> 6 * Copyright (c) 2004-2009 Greg Kroah-Hartman <[email protected]> 7 * Copyright (c) 2008-2009 Novell Inc. 8 * Copyright (c) 2012-2019 Greg Kroah-Hartman <[email protected]> 9 * Copyright (c) 2012-2019 Linux Foundation 10 * 11 * See Documentation/driver-api/driver-model/ for more information. 12 */ 13 14 #ifndef _DEVICE_CLASS_H_ 15 #define _DEVICE_CLASS_H_ 16 17 #include <linux/kobject.h> 18 #include <linux/klist.h> 19 #include <linux/pm.h> 20 #include <linux/device/bus.h> 21 22 struct device; 23 struct fwnode_handle; 24 25 /** 26 * struct class - device classes 27 * @name: Name of the class. 28 * @class_groups: Default attributes of this class. 29 * @dev_groups: Default attributes of the devices that belong to the class. 30 * @dev_kobj: The kobject that represents this class and links it into the hierarchy. 31 * @dev_uevent: Called when a device is added, removed from this class, or a 32 * few other things that generate uevents to add the environment 33 * variables. 34 * @devnode: Callback to provide the devtmpfs. 35 * @class_release: Called to release this class. 36 * @dev_release: Called to release the device. 37 * @shutdown_pre: Called at shut-down time before driver shutdown. 38 * @ns_type: Callbacks so sysfs can detemine namespaces. 39 * @namespace: Namespace of the device belongs to this class. 40 * @get_ownership: Allows class to specify uid/gid of the sysfs directories 41 * for the devices belonging to the class. Usually tied to 42 * device's namespace. 43 * @pm: The default device power management operations of this class. 44 * @p: The private data of the driver core, no one other than the 45 * driver core can touch this. 46 * 47 * A class is a higher-level view of a device that abstracts out low-level 48 * implementation details. Drivers may see a SCSI disk or an ATA disk, but, 49 * at the class level, they are all simply disks. Classes allow user space 50 * to work with devices based on what they do, rather than how they are 51 * connected or how they work. 52 */ 53 struct class { 54 const char *name; 55 56 const struct attribute_group **class_groups; 57 const struct attribute_group **dev_groups; 58 struct kobject *dev_kobj; 59 60 int (*dev_uevent)(const struct device *dev, struct kobj_uevent_env *env); 61 char *(*devnode)(const struct device *dev, umode_t *mode); 62 63 void (*class_release)(struct class *class); 64 void (*dev_release)(struct device *dev); 65 66 int (*shutdown_pre)(struct device *dev); 67 68 const struct kobj_ns_type_operations *ns_type; 69 const void *(*namespace)(const struct device *dev); 70 71 void (*get_ownership)(const struct device *dev, kuid_t *uid, kgid_t *gid); 72 73 const struct dev_pm_ops *pm; 74 }; 75 76 struct class_dev_iter { 77 struct klist_iter ki; 78 const struct device_type *type; 79 }; 80 81 extern struct kobject *sysfs_dev_block_kobj; 82 83 int __must_check class_register(struct class *class); 84 void class_unregister(const struct class *class); 85 bool class_is_registered(const struct class *class); 86 87 struct class_compat; 88 struct class_compat *class_compat_register(const char *name); 89 void class_compat_unregister(struct class_compat *cls); 90 int class_compat_create_link(struct class_compat *cls, struct device *dev, 91 struct device *device_link); 92 void class_compat_remove_link(struct class_compat *cls, struct device *dev, 93 struct device *device_link); 94 95 void class_dev_iter_init(struct class_dev_iter *iter, const struct class *class, 96 const struct device *start, const struct device_type *type); 97 struct device *class_dev_iter_next(struct class_dev_iter *iter); 98 void class_dev_iter_exit(struct class_dev_iter *iter); 99 100 int class_for_each_device(const struct class *class, const struct device *start, void *data, 101 int (*fn)(struct device *dev, void *data)); 102 struct device *class_find_device(const struct class *class, const struct device *start, 103 const void *data, int (*match)(struct device *, const void *)); 104 105 /** 106 * class_find_device_by_name - device iterator for locating a particular device 107 * of a specific name. 108 * @class: class type 109 * @name: name of the device to match 110 */ 111 static inline struct device *class_find_device_by_name(const struct class *class, 112 const char *name) 113 { 114 return class_find_device(class, NULL, name, device_match_name); 115 } 116 117 /** 118 * class_find_device_by_of_node : device iterator for locating a particular device 119 * matching the of_node. 120 * @class: class type 121 * @np: of_node of the device to match. 122 */ 123 static inline struct device *class_find_device_by_of_node(const struct class *class, 124 const struct device_node *np) 125 { 126 return class_find_device(class, NULL, np, device_match_of_node); 127 } 128 129 /** 130 * class_find_device_by_fwnode : device iterator for locating a particular device 131 * matching the fwnode. 132 * @class: class type 133 * @fwnode: fwnode of the device to match. 134 */ 135 static inline struct device *class_find_device_by_fwnode(const struct class *class, 136 const struct fwnode_handle *fwnode) 137 { 138 return class_find_device(class, NULL, fwnode, device_match_fwnode); 139 } 140 141 /** 142 * class_find_device_by_devt : device iterator for locating a particular device 143 * matching the device type. 144 * @class: class type 145 * @devt: device type of the device to match. 146 */ 147 static inline struct device *class_find_device_by_devt(const struct class *class, 148 dev_t devt) 149 { 150 return class_find_device(class, NULL, &devt, device_match_devt); 151 } 152 153 #ifdef CONFIG_ACPI 154 struct acpi_device; 155 /** 156 * class_find_device_by_acpi_dev : device iterator for locating a particular 157 * device matching the ACPI_COMPANION device. 158 * @class: class type 159 * @adev: ACPI_COMPANION device to match. 160 */ 161 static inline struct device *class_find_device_by_acpi_dev(const struct class *class, 162 const struct acpi_device *adev) 163 { 164 return class_find_device(class, NULL, adev, device_match_acpi_dev); 165 } 166 #else 167 static inline struct device *class_find_device_by_acpi_dev(const struct class *class, 168 const void *adev) 169 { 170 return NULL; 171 } 172 #endif 173 174 struct class_attribute { 175 struct attribute attr; 176 ssize_t (*show)(const struct class *class, const struct class_attribute *attr, 177 char *buf); 178 ssize_t (*store)(const struct class *class, const struct class_attribute *attr, 179 const char *buf, size_t count); 180 }; 181 182 #define CLASS_ATTR_RW(_name) \ 183 struct class_attribute class_attr_##_name = __ATTR_RW(_name) 184 #define CLASS_ATTR_RO(_name) \ 185 struct class_attribute class_attr_##_name = __ATTR_RO(_name) 186 #define CLASS_ATTR_WO(_name) \ 187 struct class_attribute class_attr_##_name = __ATTR_WO(_name) 188 189 int __must_check class_create_file_ns(const struct class *class, const struct class_attribute *attr, 190 const void *ns); 191 void class_remove_file_ns(const struct class *class, const struct class_attribute *attr, 192 const void *ns); 193 194 static inline int __must_check class_create_file(const struct class *class, 195 const struct class_attribute *attr) 196 { 197 return class_create_file_ns(class, attr, NULL); 198 } 199 200 static inline void class_remove_file(const struct class *class, 201 const struct class_attribute *attr) 202 { 203 return class_remove_file_ns(class, attr, NULL); 204 } 205 206 /* Simple class attribute that is just a static string */ 207 struct class_attribute_string { 208 struct class_attribute attr; 209 char *str; 210 }; 211 212 /* Currently read-only only */ 213 #define _CLASS_ATTR_STRING(_name, _mode, _str) \ 214 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str } 215 #define CLASS_ATTR_STRING(_name, _mode, _str) \ 216 struct class_attribute_string class_attr_##_name = \ 217 _CLASS_ATTR_STRING(_name, _mode, _str) 218 219 ssize_t show_class_attr_string(const struct class *class, const struct class_attribute *attr, 220 char *buf); 221 222 struct class_interface { 223 struct list_head node; 224 struct class *class; 225 226 int (*add_dev) (struct device *, struct class_interface *); 227 void (*remove_dev) (struct device *, struct class_interface *); 228 }; 229 230 int __must_check class_interface_register(struct class_interface *); 231 void class_interface_unregister(struct class_interface *); 232 233 struct class * __must_check class_create(const char *name); 234 void class_destroy(const struct class *cls); 235 236 #endif /* _DEVICE_CLASS_H_ */ 237