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 #ifndef _LINUXKPI_LINUX_DEVICE_H_ 34 #define _LINUXKPI_LINUX_DEVICE_H_ 35 36 #include <linux/err.h> 37 #include <linux/types.h> 38 #include <linux/kobject.h> 39 #include <linux/sysfs.h> 40 #include <linux/list.h> 41 #include <linux/compiler.h> 42 #include <linux/module.h> 43 #include <linux/workqueue.h> 44 #include <linux/kdev_t.h> 45 #include <linux/backlight.h> 46 #include <linux/pm.h> 47 #include <linux/idr.h> 48 #include <linux/ratelimit.h> /* via linux/dev_printk.h */ 49 #include <linux/fwnode.h> 50 #include <asm/atomic.h> 51 52 #include <sys/bus.h> 53 #include <sys/backlight.h> 54 55 struct device; 56 57 struct class { 58 const char *name; 59 struct module *owner; 60 struct kobject kobj; 61 devclass_t bsdclass; 62 const struct dev_pm_ops *pm; 63 const struct attribute_group **dev_groups; 64 void (*class_release)(struct class *class); 65 void (*dev_release)(struct device *dev); 66 char * (*devnode)(struct device *dev, umode_t *mode); 67 }; 68 69 struct dev_pm_ops { 70 int (*prepare)(struct device *dev); 71 void (*complete)(struct device *dev); 72 int (*suspend)(struct device *dev); 73 int (*suspend_late)(struct device *dev); 74 int (*resume)(struct device *dev); 75 int (*resume_early)(struct device *dev); 76 int (*freeze)(struct device *dev); 77 int (*freeze_late)(struct device *dev); 78 int (*thaw)(struct device *dev); 79 int (*thaw_early)(struct device *dev); 80 int (*poweroff)(struct device *dev); 81 int (*poweroff_late)(struct device *dev); 82 int (*restore)(struct device *dev); 83 int (*restore_early)(struct device *dev); 84 int (*suspend_noirq)(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_WARN(dev, fmt, ...) \ 202 device_printf((dev)->bsddev, "%s:%d: " fmt, __func__, __LINE__, ##__VA_ARGS__) 203 204 #define dev_WARN_ONCE(dev, condition, fmt, ...) do { \ 205 static bool __dev_WARN_ONCE; \ 206 bool __ret_warn_on = (condition); \ 207 if (unlikely(__ret_warn_on)) { \ 208 if (!__dev_WARN_ONCE) { \ 209 __dev_WARN_ONCE = true; \ 210 device_printf((dev)->bsddev, "%s:%d: " fmt, __func__, __LINE__, ##__VA_ARGS__); \ 211 } \ 212 } \ 213 } while (0) 214 215 #define dev_info_once(dev, ...) do { \ 216 static bool __dev_info_once; \ 217 if (!__dev_info_once) { \ 218 __dev_info_once = true; \ 219 dev_info(dev, __VA_ARGS__); \ 220 } \ 221 } while (0) 222 223 #define dev_warn_once(dev, ...) do { \ 224 static bool __dev_warn_once; \ 225 if (!__dev_warn_once) { \ 226 __dev_warn_once = 1; \ 227 dev_warn(dev, __VA_ARGS__); \ 228 } \ 229 } while (0) 230 231 #define dev_err_once(dev, ...) do { \ 232 static bool __dev_err_once; \ 233 if (!__dev_err_once) { \ 234 __dev_err_once = 1; \ 235 dev_err(dev, __VA_ARGS__); \ 236 } \ 237 } while (0) 238 239 #define dev_err_ratelimited(dev, ...) do { \ 240 static linux_ratelimit_t __ratelimited; \ 241 if (linux_ratelimited(&__ratelimited)) \ 242 dev_err(dev, __VA_ARGS__); \ 243 } while (0) 244 245 #define dev_warn_ratelimited(dev, ...) do { \ 246 static linux_ratelimit_t __ratelimited; \ 247 if (linux_ratelimited(&__ratelimited)) \ 248 dev_warn(dev, __VA_ARGS__); \ 249 } while (0) 250 251 #define dev_dbg_ratelimited(dev, ...) do { \ 252 static linux_ratelimit_t __ratelimited; \ 253 if (linux_ratelimited(&__ratelimited)) \ 254 dev_dbg(dev, __VA_ARGS__); \ 255 } while (0) 256 257 /* Public and LinuxKPI internal devres functions. */ 258 void *lkpi_devres_alloc(void(*release)(struct device *, void *), size_t, gfp_t); 259 void lkpi_devres_add(struct device *, void *); 260 void lkpi_devres_free(void *); 261 void *lkpi_devres_find(struct device *, void(*release)(struct device *, void *), 262 int (*match)(struct device *, void *, void *), void *); 263 int lkpi_devres_destroy(struct device *, void(*release)(struct device *, void *), 264 int (*match)(struct device *, void *, void *), void *); 265 #define devres_alloc(_r, _s, _g) lkpi_devres_alloc(_r, _s, _g) 266 #define devres_add(_d, _p) lkpi_devres_add(_d, _p) 267 #define devres_free(_p) lkpi_devres_free(_p) 268 #define devres_find(_d, _rfn, _mfn, _mp) \ 269 lkpi_devres_find(_d, _rfn, _mfn, _mp) 270 #define devres_destroy(_d, _rfn, _mfn, _mp) \ 271 lkpi_devres_destroy(_d, _rfn, _mfn, _mp) 272 void lkpi_devres_release_free_list(struct device *); 273 void lkpi_devres_unlink(struct device *, void *); 274 void lkpi_devm_kmalloc_release(struct device *, void *); 275 276 static inline const char * 277 dev_driver_string(const struct device *dev) 278 { 279 driver_t *drv; 280 const char *str = ""; 281 282 if (dev->bsddev != NULL) { 283 drv = device_get_driver(dev->bsddev); 284 if (drv != NULL) 285 str = drv->name; 286 } 287 288 return (str); 289 } 290 291 static inline void * 292 dev_get_drvdata(const struct device *dev) 293 { 294 295 return dev->driver_data; 296 } 297 298 static inline void 299 dev_set_drvdata(struct device *dev, void *data) 300 { 301 302 dev->driver_data = data; 303 } 304 305 static inline struct device * 306 get_device(struct device *dev) 307 { 308 309 if (dev) 310 kobject_get(&dev->kobj); 311 312 return (dev); 313 } 314 315 static inline char * 316 dev_name(const struct device *dev) 317 { 318 319 return kobject_name(&dev->kobj); 320 } 321 322 #define dev_set_name(_dev, _fmt, ...) \ 323 kobject_set_name(&(_dev)->kobj, (_fmt), ##__VA_ARGS__) 324 325 static inline void 326 put_device(struct device *dev) 327 { 328 329 if (dev) 330 kobject_put(&dev->kobj); 331 } 332 333 struct class *class_create(struct module *owner, const char *name); 334 335 static inline int 336 class_register(struct class *class) 337 { 338 339 class->bsdclass = devclass_create(class->name); 340 kobject_init(&class->kobj, &linux_class_ktype); 341 kobject_set_name(&class->kobj, class->name); 342 kobject_add(&class->kobj, &linux_class_root, class->name); 343 344 return (0); 345 } 346 347 static inline void 348 class_unregister(struct class *class) 349 { 350 351 kobject_put(&class->kobj); 352 } 353 354 static inline struct device *kobj_to_dev(struct kobject *kobj) 355 { 356 return container_of(kobj, struct device, kobj); 357 } 358 359 struct device *device_create(struct class *class, struct device *parent, 360 dev_t devt, void *drvdata, const char *fmt, ...); 361 struct device *device_create_groups_vargs(struct class *class, struct device *parent, 362 dev_t devt, void *drvdata, const struct attribute_group **groups, 363 const char *fmt, va_list args); 364 365 /* 366 * Devices are registered and created for exporting to sysfs. Create 367 * implies register and register assumes the device fields have been 368 * setup appropriately before being called. 369 */ 370 static inline void 371 device_initialize(struct device *dev) 372 { 373 device_t bsddev = NULL; 374 int unit = -1; 375 376 if (dev->devt) { 377 unit = MINOR(dev->devt); 378 bsddev = devclass_get_device(dev->class->bsdclass, unit); 379 dev->bsddev_attached_here = false; 380 } else if (dev->parent == NULL) { 381 bsddev = devclass_get_device(dev->class->bsdclass, 0); 382 dev->bsddev_attached_here = false; 383 } else { 384 dev->bsddev_attached_here = true; 385 } 386 387 if (bsddev == NULL && dev->parent != NULL) { 388 bsddev = device_add_child(dev->parent->bsddev, 389 dev->class->kobj.name, unit); 390 } 391 392 if (bsddev != NULL) 393 device_set_softc(bsddev, dev); 394 395 dev->bsddev = bsddev; 396 MPASS(dev->bsddev != NULL); 397 kobject_init(&dev->kobj, &linux_dev_ktype); 398 399 spin_lock_init(&dev->devres_lock); 400 INIT_LIST_HEAD(&dev->devres_head); 401 } 402 403 static inline int 404 device_add(struct device *dev) 405 { 406 if (dev->bsddev != NULL) { 407 if (dev->devt == 0) 408 dev->devt = makedev(0, device_get_unit(dev->bsddev)); 409 } 410 kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev)); 411 412 if (dev->groups) 413 return (sysfs_create_groups(&dev->kobj, dev->groups)); 414 415 return (0); 416 } 417 418 static inline void 419 device_create_release(struct device *dev) 420 { 421 kfree(dev); 422 } 423 424 static inline struct device * 425 device_create_with_groups(struct class *class, 426 struct device *parent, dev_t devt, void *drvdata, 427 const struct attribute_group **groups, const char *fmt, ...) 428 { 429 va_list vargs; 430 struct device *dev; 431 432 va_start(vargs, fmt); 433 dev = device_create_groups_vargs(class, parent, devt, drvdata, 434 groups, fmt, vargs); 435 va_end(vargs); 436 return dev; 437 } 438 439 static inline bool 440 device_is_registered(struct device *dev) 441 { 442 443 return (dev->bsddev != NULL); 444 } 445 446 static inline int 447 device_register(struct device *dev) 448 { 449 device_t bsddev = NULL; 450 int unit = -1; 451 452 if (device_is_registered(dev)) 453 goto done; 454 455 if (dev->devt) { 456 unit = MINOR(dev->devt); 457 bsddev = devclass_get_device(dev->class->bsdclass, unit); 458 dev->bsddev_attached_here = false; 459 } else if (dev->parent == NULL) { 460 bsddev = devclass_get_device(dev->class->bsdclass, 0); 461 dev->bsddev_attached_here = false; 462 } else { 463 dev->bsddev_attached_here = true; 464 } 465 if (bsddev == NULL && dev->parent != NULL) { 466 bsddev = device_add_child(dev->parent->bsddev, 467 dev->class->kobj.name, unit); 468 } 469 if (bsddev != NULL) { 470 if (dev->devt == 0) 471 dev->devt = makedev(0, device_get_unit(bsddev)); 472 device_set_softc(bsddev, dev); 473 } 474 dev->bsddev = bsddev; 475 done: 476 kobject_init(&dev->kobj, &linux_dev_ktype); 477 kobject_add(&dev->kobj, &dev->class->kobj, dev_name(dev)); 478 479 sysfs_create_groups(&dev->kobj, dev->class->dev_groups); 480 481 return (0); 482 } 483 484 static inline void 485 device_unregister(struct device *dev) 486 { 487 device_t bsddev; 488 489 sysfs_remove_groups(&dev->kobj, dev->class->dev_groups); 490 491 bsddev = dev->bsddev; 492 dev->bsddev = NULL; 493 494 if (bsddev != NULL && dev->bsddev_attached_here) { 495 bus_topo_lock(); 496 device_delete_child(device_get_parent(bsddev), bsddev); 497 bus_topo_unlock(); 498 } 499 put_device(dev); 500 } 501 502 static inline void 503 device_del(struct device *dev) 504 { 505 device_t bsddev; 506 507 bsddev = dev->bsddev; 508 dev->bsddev = NULL; 509 510 if (bsddev != NULL && dev->bsddev_attached_here) { 511 bus_topo_lock(); 512 device_delete_child(device_get_parent(bsddev), bsddev); 513 bus_topo_unlock(); 514 } 515 } 516 517 static inline void 518 device_destroy(struct class *class, dev_t devt) 519 { 520 device_t bsddev; 521 int unit; 522 523 unit = MINOR(devt); 524 bsddev = devclass_get_device(class->bsdclass, unit); 525 if (bsddev != NULL) 526 device_unregister(device_get_softc(bsddev)); 527 } 528 529 static inline void 530 device_release_driver(struct device *dev) 531 { 532 533 #if 0 534 /* This leads to panics. Disable temporarily. Keep to rework. */ 535 536 /* We also need to cleanup LinuxKPI bits. What else? */ 537 lkpi_devres_release_free_list(dev); 538 dev_set_drvdata(dev, NULL); 539 /* Do not call dev->release! */ 540 541 bus_topo_lock(); 542 if (device_is_attached(dev->bsddev)) 543 device_detach(dev->bsddev); 544 bus_topo_unlock(); 545 #endif 546 } 547 548 static inline int 549 device_reprobe(struct device *dev) 550 { 551 int error; 552 553 device_release_driver(dev); 554 bus_topo_lock(); 555 error = device_probe_and_attach(dev->bsddev); 556 bus_topo_unlock(); 557 558 return (-error); 559 } 560 561 static inline void 562 device_set_wakeup_enable(struct device *dev __unused, bool enable __unused) 563 { 564 565 /* 566 * XXX-BZ TODO This is used by wireless drivers supporting WoWLAN which 567 * we currently do not support. 568 */ 569 } 570 571 static inline int 572 device_wakeup_enable(struct device *dev) 573 { 574 575 device_set_wakeup_enable(dev, true); 576 return (0); 577 } 578 579 static inline bool 580 device_iommu_mapped(struct device *dev __unused) 581 { 582 return (false); 583 } 584 585 #define dev_pm_set_driver_flags(dev, flags) do { \ 586 } while (0) 587 588 static inline void 589 linux_class_kfree(struct class *class) 590 { 591 592 kfree(class); 593 } 594 595 static inline void 596 class_destroy(struct class *class) 597 { 598 599 if (class == NULL) 600 return; 601 class_unregister(class); 602 } 603 604 static inline int 605 device_create_file(struct device *dev, const struct device_attribute *attr) 606 { 607 608 if (dev) 609 return sysfs_create_file(&dev->kobj, &attr->attr); 610 return -EINVAL; 611 } 612 613 static inline void 614 device_remove_file(struct device *dev, const struct device_attribute *attr) 615 { 616 617 if (dev) 618 sysfs_remove_file(&dev->kobj, &attr->attr); 619 } 620 621 static inline int 622 class_create_file(struct class *class, const struct class_attribute *attr) 623 { 624 625 if (class) 626 return sysfs_create_file(&class->kobj, &attr->attr); 627 return -EINVAL; 628 } 629 630 static inline void 631 class_remove_file(struct class *class, const struct class_attribute *attr) 632 { 633 634 if (class) 635 sysfs_remove_file(&class->kobj, &attr->attr); 636 } 637 638 #define dev_to_node(dev) linux_dev_to_node(dev) 639 #define of_node_to_nid(node) -1 640 int linux_dev_to_node(struct device *); 641 642 char *kvasprintf(gfp_t, const char *, va_list); 643 char *kasprintf(gfp_t, const char *, ...); 644 char *lkpi_devm_kasprintf(struct device *, gfp_t, const char *, ...); 645 646 #define devm_kasprintf(_dev, _gfp, _fmt, ...) \ 647 lkpi_devm_kasprintf(_dev, _gfp, _fmt, ##__VA_ARGS__) 648 649 static __inline void * 650 devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) 651 { 652 void *p; 653 654 p = lkpi_devres_alloc(lkpi_devm_kmalloc_release, size, gfp); 655 if (p != NULL) 656 lkpi_devres_add(dev, p); 657 658 return (p); 659 } 660 661 static inline void * 662 devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp) 663 { 664 void *dst; 665 666 if (len == 0) 667 return (NULL); 668 669 dst = devm_kmalloc(dev, len, gfp); 670 if (dst != NULL) 671 memcpy(dst, src, len); 672 673 return (dst); 674 } 675 676 #define devm_kzalloc(_dev, _size, _gfp) \ 677 devm_kmalloc((_dev), (_size), (_gfp) | __GFP_ZERO) 678 679 #define devm_kcalloc(_dev, _sizen, _size, _gfp) \ 680 devm_kmalloc((_dev), ((_sizen) * (_size)), (_gfp) | __GFP_ZERO) 681 682 int lkpi_devm_add_action(struct device *dev, void (*action)(void *), void *data); 683 #define devm_add_action(dev, action, data) \ 684 lkpi_devm_add_action(dev, action, data); 685 int lkpi_devm_add_action_or_reset(struct device *dev, void (*action)(void *), void *data); 686 #define devm_add_action_or_reset(dev, action, data) \ 687 lkpi_devm_add_action_or_reset(dev, action, data) 688 689 #endif /* _LINUXKPI_LINUX_DEVICE_H_ */ 690