1 /*- 2 * Copyright (c) 2010 Isilon Systems, Inc. 3 * Copyright (c) 2010 iX Systems, Inc. 4 * Copyright (c) 2010 Panasas, Inc. 5 * Copyright (c) 2013-2016 Mellanox Technologies, Ltd. 6 * All rights reserved. 7 * Copyright (c) 2021-2022 The FreeBSD Foundation 8 * 9 * Portions of this software were developed by Björn Zeeb 10 * under sponsorship from the FreeBSD Foundation. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice unmodified, this list of conditions, and the following 17 * disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 * 33 * $FreeBSD$ 34 */ 35 #ifndef _LINUXKPI_LINUX_DEVICE_H_ 36 #define _LINUXKPI_LINUX_DEVICE_H_ 37 38 #include <linux/err.h> 39 #include <linux/types.h> 40 #include <linux/kobject.h> 41 #include <linux/sysfs.h> 42 #include <linux/list.h> 43 #include <linux/compiler.h> 44 #include <linux/module.h> 45 #include <linux/workqueue.h> 46 #include <linux/kdev_t.h> 47 #include <linux/backlight.h> 48 #include <linux/pm.h> 49 #include <linux/idr.h> 50 #include <linux/ratelimit.h> /* via linux/dev_printk.h */ 51 #include <asm/atomic.h> 52 53 #include <sys/bus.h> 54 #include <sys/backlight.h> 55 56 struct device; 57 struct fwnode_handle; 58 59 struct class { 60 const char *name; 61 struct module *owner; 62 struct kobject kobj; 63 devclass_t bsdclass; 64 const struct dev_pm_ops *pm; 65 const struct attribute_group **dev_groups; 66 void (*class_release)(struct class *class); 67 void (*dev_release)(struct device *dev); 68 char * (*devnode)(struct device *dev, umode_t *mode); 69 }; 70 71 struct dev_pm_ops { 72 int (*prepare)(struct device *dev); 73 int (*suspend)(struct device *dev); 74 int (*suspend_late)(struct device *dev); 75 int (*resume)(struct device *dev); 76 int (*resume_early)(struct device *dev); 77 int (*freeze)(struct device *dev); 78 int (*freeze_late)(struct device *dev); 79 int (*thaw)(struct device *dev); 80 int (*thaw_early)(struct device *dev); 81 int (*poweroff)(struct device *dev); 82 int (*poweroff_late)(struct device *dev); 83 int (*restore)(struct device *dev); 84 int (*restore_early)(struct device *dev); 85 int (*runtime_suspend)(struct device *dev); 86 int (*runtime_resume)(struct device *dev); 87 int (*runtime_idle)(struct device *dev); 88 }; 89 90 struct device_driver { 91 const char *name; 92 const struct dev_pm_ops *pm; 93 }; 94 95 struct device_type { 96 const char *name; 97 }; 98 99 struct device { 100 struct device *parent; 101 struct list_head irqents; 102 device_t bsddev; 103 /* 104 * The following flag is used to determine if the LinuxKPI is 105 * responsible for detaching the BSD device or not. If the 106 * LinuxKPI got the BSD device using devclass_get_device(), it 107 * must not try to detach or delete it, because it's already 108 * done somewhere else. 109 */ 110 bool bsddev_attached_here; 111 struct device_driver *driver; 112 struct device_type *type; 113 dev_t devt; 114 struct class *class; 115 void (*release)(struct device *dev); 116 struct kobject kobj; 117 void *dma_priv; 118 void *driver_data; 119 unsigned int irq; 120 #define LINUX_IRQ_INVALID 65535 121 unsigned int irq_start; 122 unsigned int irq_end; 123 const struct attribute_group **groups; 124 struct fwnode_handle *fwnode; 125 struct cdev *backlight_dev; 126 struct backlight_device *bd; 127 128 spinlock_t devres_lock; 129 struct list_head devres_head; 130 131 struct dev_pm_info power; 132 }; 133 134 extern struct device linux_root_device; 135 extern struct kobject linux_class_root; 136 extern const struct kobj_type linux_dev_ktype; 137 extern const struct kobj_type linux_class_ktype; 138 139 struct class_attribute { 140 struct attribute attr; 141 ssize_t (*show)(struct class *, struct class_attribute *, char *); 142 ssize_t (*store)(struct class *, struct class_attribute *, const char *, size_t); 143 const void *(*namespace)(struct class *, const struct class_attribute *); 144 }; 145 146 #define CLASS_ATTR(_name, _mode, _show, _store) \ 147 struct class_attribute class_attr_##_name = \ 148 { { #_name, NULL, _mode }, _show, _store } 149 150 struct device_attribute { 151 struct attribute attr; 152 ssize_t (*show)(struct device *, 153 struct device_attribute *, char *); 154 ssize_t (*store)(struct device *, 155 struct device_attribute *, const char *, 156 size_t); 157 }; 158 159 #define DEVICE_ATTR(_name, _mode, _show, _store) \ 160 struct device_attribute dev_attr_##_name = \ 161 __ATTR(_name, _mode, _show, _store) 162 #define DEVICE_ATTR_RO(_name) \ 163 struct device_attribute dev_attr_##_name = __ATTR_RO(_name) 164 #define DEVICE_ATTR_WO(_name) \ 165 struct device_attribute dev_attr_##_name = __ATTR_WO(_name) 166 #define DEVICE_ATTR_RW(_name) \ 167 struct device_attribute dev_attr_##_name = __ATTR_RW(_name) 168 169 /* Simple class attribute that is just a static string */ 170 struct class_attribute_string { 171 struct class_attribute attr; 172 char *str; 173 }; 174 175 static inline ssize_t 176 show_class_attr_string(struct class *class, 177 struct class_attribute *attr, char *buf) 178 { 179 struct class_attribute_string *cs; 180 cs = container_of(attr, struct class_attribute_string, attr); 181 return snprintf(buf, PAGE_SIZE, "%s\n", cs->str); 182 } 183 184 /* Currently read-only only */ 185 #define _CLASS_ATTR_STRING(_name, _mode, _str) \ 186 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str } 187 #define CLASS_ATTR_STRING(_name, _mode, _str) \ 188 struct class_attribute_string class_attr_##_name = \ 189 _CLASS_ATTR_STRING(_name, _mode, _str) 190 191 #define dev_err(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 192 #define dev_crit(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 193 #define dev_warn(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 194 #define dev_info(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 195 #define dev_notice(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 196 #define dev_emerg(dev, fmt, ...) device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 197 #define dev_dbg(dev, fmt, ...) do { } while (0) 198 #define dev_printk(lvl, dev, fmt, ...) \ 199 device_printf((dev)->bsddev, fmt, ##__VA_ARGS__) 200 201 #define dev_info_once(dev, ...) do { \ 202 static bool __dev_info_once; \ 203 if (!__dev_info_once) { \ 204 __dev_info_once = true; \ 205 dev_info(dev, __VA_ARGS__); \ 206 } \ 207 } while (0) 208 209 #define dev_err_once(dev, ...) do { \ 210 static bool __dev_err_once; \ 211 if (!__dev_err_once) { \ 212 __dev_err_once = 1; \ 213 dev_err(dev, __VA_ARGS__); \ 214 } \ 215 } while (0) 216 217 #define dev_err_ratelimited(dev, ...) do { \ 218 static linux_ratelimit_t __ratelimited; \ 219 if (linux_ratelimited(&__ratelimited)) \ 220 dev_err(dev, __VA_ARGS__); \ 221 } while (0) 222 223 #define dev_warn_ratelimited(dev, ...) do { \ 224 static linux_ratelimit_t __ratelimited; \ 225 if (linux_ratelimited(&__ratelimited)) \ 226 dev_warn(dev, __VA_ARGS__); \ 227 } while (0) 228 229 /* Public and LinuxKPI internal devres functions. */ 230 void *lkpi_devres_alloc(void(*release)(struct device *, void *), size_t, gfp_t); 231 void lkpi_devres_add(struct device *, void *); 232 void lkpi_devres_free(void *); 233 void *lkpi_devres_find(struct device *, void(*release)(struct device *, void *), 234 int (*match)(struct device *, void *, void *), void *); 235 int lkpi_devres_destroy(struct device *, void(*release)(struct device *, void *), 236 int (*match)(struct device *, void *, void *), void *); 237 #define devres_alloc(_r, _s, _g) lkpi_devres_alloc(_r, _s, _g) 238 #define devres_add(_d, _p) lkpi_devres_add(_d, _p) 239 #define devres_free(_p) lkpi_devres_free(_p) 240 #define devres_find(_d, _rfn, _mfn, _mp) \ 241 lkpi_devres_find(_d, _rfn, _mfn, _mp) 242 #define devres_destroy(_d, _rfn, _mfn, _mp) \ 243 lkpi_devres_destroy(_d, _rfn, _mfn, _mp) 244 void lkpi_devres_release_free_list(struct device *); 245 void lkpi_devres_unlink(struct device *, void *); 246 void lkpi_devm_kmalloc_release(struct device *, void *); 247 248 static inline const char * 249 dev_driver_string(const struct device *dev) 250 { 251 driver_t *drv; 252 const char *str = ""; 253 254 if (dev->bsddev != NULL) { 255 drv = device_get_driver(dev->bsddev); 256 if (drv != NULL) 257 str = drv->name; 258 } 259 260 return (str); 261 } 262 263 static inline void * 264 dev_get_drvdata(const struct device *dev) 265 { 266 267 return dev->driver_data; 268 } 269 270 static inline void 271 dev_set_drvdata(struct device *dev, void *data) 272 { 273 274 dev->driver_data = data; 275 } 276 277 static inline struct device * 278 get_device(struct device *dev) 279 { 280 281 if (dev) 282 kobject_get(&dev->kobj); 283 284 return (dev); 285 } 286 287 static inline char * 288 dev_name(const struct device *dev) 289 { 290 291 return kobject_name(&dev->kobj); 292 } 293 294 #define dev_set_name(_dev, _fmt, ...) \ 295 kobject_set_name(&(_dev)->kobj, (_fmt), ##__VA_ARGS__) 296 297 static inline void 298 put_device(struct device *dev) 299 { 300 301 if (dev) 302 kobject_put(&dev->kobj); 303 } 304 305 struct class *class_create(struct module *owner, const char *name); 306 307 static inline int 308 class_register(struct class *class) 309 { 310 311 class->bsdclass = devclass_create(class->name); 312 kobject_init(&class->kobj, &linux_class_ktype); 313 kobject_set_name(&class->kobj, class->name); 314 kobject_add(&class->kobj, &linux_class_root, class->name); 315 316 return (0); 317 } 318 319 static inline void 320 class_unregister(struct class *class) 321 { 322 323 kobject_put(&class->kobj); 324 } 325 326 static inline struct device *kobj_to_dev(struct kobject *kobj) 327 { 328 return container_of(kobj, struct device, kobj); 329 } 330 331 struct device *device_create(struct class *class, struct device *parent, 332 dev_t devt, void *drvdata, const char *fmt, ...); 333 struct device *device_create_groups_vargs(struct class *class, struct device *parent, 334 dev_t devt, void *drvdata, const struct attribute_group **groups, 335 const char *fmt, va_list args); 336 337 /* 338 * Devices are registered and created for exporting to sysfs. Create 339 * implies register and register assumes the device fields have been 340 * setup appropriately before being called. 341 */ 342 static inline void 343 device_initialize(struct device *dev) 344 { 345 device_t bsddev = NULL; 346 int unit = -1; 347 348 if (dev->devt) { 349 unit = MINOR(dev->devt); 350 bsddev = devclass_get_device(dev->class->bsdclass, unit); 351 dev->bsddev_attached_here = false; 352 } else if (dev->parent == NULL) { 353 bsddev = devclass_get_device(dev->class->bsdclass, 0); 354 dev->bsddev_attached_here = false; 355 } else { 356 dev->bsddev_attached_here = true; 357 } 358 359 if (bsddev == NULL && dev->parent != NULL) { 360 bsddev = device_add_child(dev->parent->bsddev, 361 dev->class->kobj.name, unit); 362 } 363 364 if (bsddev != NULL) 365 device_set_softc(bsddev, dev); 366 367 dev->bsddev = bsddev; 368 MPASS(dev->bsddev != NULL); 369 kobject_init(&dev->kobj, &linux_dev_ktype); 370 371 spin_lock_init(&dev->devres_lock); 372 INIT_LIST_HEAD(&dev->devres_head); 373 } 374 375 static inline int 376 device_add(struct device *dev) 377 { 378 if (dev->bsddev != NULL) { 379 if (dev->devt == 0) 380 dev->devt = makedev(0, device_get_unit(dev->bsddev)); 381 } 382 kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev)); 383 384 if (dev->groups) 385 return (sysfs_create_groups(&dev->kobj, dev->groups)); 386 387 return (0); 388 } 389 390 static inline void 391 device_create_release(struct device *dev) 392 { 393 kfree(dev); 394 } 395 396 static inline struct device * 397 device_create_with_groups(struct class *class, 398 struct device *parent, dev_t devt, void *drvdata, 399 const struct attribute_group **groups, const char *fmt, ...) 400 { 401 va_list vargs; 402 struct device *dev; 403 404 va_start(vargs, fmt); 405 dev = device_create_groups_vargs(class, parent, devt, drvdata, 406 groups, fmt, vargs); 407 va_end(vargs); 408 return dev; 409 } 410 411 static inline bool 412 device_is_registered(struct device *dev) 413 { 414 415 return (dev->bsddev != NULL); 416 } 417 418 static inline int 419 device_register(struct device *dev) 420 { 421 device_t bsddev = NULL; 422 int unit = -1; 423 424 if (device_is_registered(dev)) 425 goto done; 426 427 if (dev->devt) { 428 unit = MINOR(dev->devt); 429 bsddev = devclass_get_device(dev->class->bsdclass, unit); 430 dev->bsddev_attached_here = false; 431 } else if (dev->parent == NULL) { 432 bsddev = devclass_get_device(dev->class->bsdclass, 0); 433 dev->bsddev_attached_here = false; 434 } else { 435 dev->bsddev_attached_here = true; 436 } 437 if (bsddev == NULL && dev->parent != NULL) { 438 bsddev = device_add_child(dev->parent->bsddev, 439 dev->class->kobj.name, unit); 440 } 441 if (bsddev != NULL) { 442 if (dev->devt == 0) 443 dev->devt = makedev(0, device_get_unit(bsddev)); 444 device_set_softc(bsddev, dev); 445 } 446 dev->bsddev = bsddev; 447 done: 448 kobject_init(&dev->kobj, &linux_dev_ktype); 449 kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev)); 450 451 sysfs_create_groups(&dev->kobj, dev->class->dev_groups); 452 453 return (0); 454 } 455 456 static inline void 457 device_unregister(struct device *dev) 458 { 459 device_t bsddev; 460 461 sysfs_remove_groups(&dev->kobj, dev->class->dev_groups); 462 463 bsddev = dev->bsddev; 464 dev->bsddev = NULL; 465 466 if (bsddev != NULL && dev->bsddev_attached_here) { 467 bus_topo_lock(); 468 device_delete_child(device_get_parent(bsddev), bsddev); 469 bus_topo_unlock(); 470 } 471 put_device(dev); 472 } 473 474 static inline void 475 device_del(struct device *dev) 476 { 477 device_t bsddev; 478 479 bsddev = dev->bsddev; 480 dev->bsddev = NULL; 481 482 if (bsddev != NULL && dev->bsddev_attached_here) { 483 bus_topo_lock(); 484 device_delete_child(device_get_parent(bsddev), bsddev); 485 bus_topo_unlock(); 486 } 487 } 488 489 static inline void 490 device_destroy(struct class *class, dev_t devt) 491 { 492 device_t bsddev; 493 int unit; 494 495 unit = MINOR(devt); 496 bsddev = devclass_get_device(class->bsdclass, unit); 497 if (bsddev != NULL) 498 device_unregister(device_get_softc(bsddev)); 499 } 500 501 static inline void 502 device_release_driver(struct device *dev) 503 { 504 505 #if 0 506 /* This leads to panics. Disable temporarily. Keep to rework. */ 507 508 /* We also need to cleanup LinuxKPI bits. What else? */ 509 lkpi_devres_release_free_list(dev); 510 dev_set_drvdata(dev, NULL); 511 /* Do not call dev->release! */ 512 513 bus_topo_lock(); 514 if (device_is_attached(dev->bsddev)) 515 device_detach(dev->bsddev); 516 bus_topo_unlock(); 517 #endif 518 } 519 520 static inline int 521 device_reprobe(struct device *dev) 522 { 523 int error; 524 525 device_release_driver(dev); 526 bus_topo_lock(); 527 error = device_probe_and_attach(dev->bsddev); 528 bus_topo_unlock(); 529 530 return (-error); 531 } 532 533 #define dev_pm_set_driver_flags(dev, flags) do { \ 534 } while (0) 535 536 static inline void 537 linux_class_kfree(struct class *class) 538 { 539 540 kfree(class); 541 } 542 543 static inline void 544 class_destroy(struct class *class) 545 { 546 547 if (class == NULL) 548 return; 549 class_unregister(class); 550 } 551 552 static inline int 553 device_create_file(struct device *dev, const struct device_attribute *attr) 554 { 555 556 if (dev) 557 return sysfs_create_file(&dev->kobj, &attr->attr); 558 return -EINVAL; 559 } 560 561 static inline void 562 device_remove_file(struct device *dev, const struct device_attribute *attr) 563 { 564 565 if (dev) 566 sysfs_remove_file(&dev->kobj, &attr->attr); 567 } 568 569 static inline int 570 class_create_file(struct class *class, const struct class_attribute *attr) 571 { 572 573 if (class) 574 return sysfs_create_file(&class->kobj, &attr->attr); 575 return -EINVAL; 576 } 577 578 static inline void 579 class_remove_file(struct class *class, const struct class_attribute *attr) 580 { 581 582 if (class) 583 sysfs_remove_file(&class->kobj, &attr->attr); 584 } 585 586 #define dev_to_node(dev) linux_dev_to_node(dev) 587 #define of_node_to_nid(node) -1 588 int linux_dev_to_node(struct device *); 589 590 char *kvasprintf(gfp_t, const char *, va_list); 591 char *kasprintf(gfp_t, const char *, ...); 592 char *lkpi_devm_kasprintf(struct device *, gfp_t, const char *, ...); 593 594 #define devm_kasprintf(_dev, _gfp, _fmt, ...) \ 595 lkpi_devm_kasprintf(_dev, _gfp, _fmt, ##__VA_ARGS__) 596 597 static __inline void * 598 devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) 599 { 600 void *p; 601 602 p = lkpi_devres_alloc(lkpi_devm_kmalloc_release, size, gfp); 603 if (p != NULL) 604 lkpi_devres_add(dev, p); 605 606 return (p); 607 } 608 609 static inline void * 610 devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp) 611 { 612 void *dst; 613 614 if (len == 0) 615 return (NULL); 616 617 dst = devm_kmalloc(dev, len, gfp); 618 if (dst != NULL) 619 memcpy(dst, src, len); 620 621 return (dst); 622 } 623 624 #define devm_kzalloc(_dev, _size, _gfp) \ 625 devm_kmalloc((_dev), (_size), (_gfp) | __GFP_ZERO) 626 627 #define devm_kcalloc(_dev, _sizen, _size, _gfp) \ 628 devm_kmalloc((_dev), ((_sizen) * (_size)), (_gfp) | __GFP_ZERO) 629 630 #endif /* _LINUXKPI_LINUX_DEVICE_H_ */ 631