1*52506b09SThomas Zimmermann /* SPDX-License-Identifier: MIT */ 2*52506b09SThomas Zimmermann 3*52506b09SThomas Zimmermann #ifndef DRM_MODULE_H 4*52506b09SThomas Zimmermann #define DRM_MODULE_H 5*52506b09SThomas Zimmermann 6*52506b09SThomas Zimmermann #include <linux/pci.h> 7*52506b09SThomas Zimmermann 8*52506b09SThomas Zimmermann #include <drm/drm_drv.h> 9*52506b09SThomas Zimmermann 10*52506b09SThomas Zimmermann /** 11*52506b09SThomas Zimmermann * DOC: overview 12*52506b09SThomas Zimmermann * 13*52506b09SThomas Zimmermann * This library provides helpers registering DRM drivers during module 14*52506b09SThomas Zimmermann * initialization and shutdown. The provided helpers act like bus-specific 15*52506b09SThomas Zimmermann * module helpers, such as module_pci_driver(), but respect additional 16*52506b09SThomas Zimmermann * parameters that control DRM driver registration. 17*52506b09SThomas Zimmermann * 18*52506b09SThomas Zimmermann * Below is an example of initializing a DRM driver for a device on the 19*52506b09SThomas Zimmermann * PCI bus. 20*52506b09SThomas Zimmermann * 21*52506b09SThomas Zimmermann * .. code-block:: c 22*52506b09SThomas Zimmermann * 23*52506b09SThomas Zimmermann * struct pci_driver my_pci_drv = { 24*52506b09SThomas Zimmermann * }; 25*52506b09SThomas Zimmermann * 26*52506b09SThomas Zimmermann * drm_module_pci_driver(my_pci_drv); 27*52506b09SThomas Zimmermann * 28*52506b09SThomas Zimmermann * The generated code will test if DRM drivers are enabled and register 29*52506b09SThomas Zimmermann * the PCI driver my_pci_drv. For more complex module initialization, you 30*52506b09SThomas Zimmermann * can still use module_init() and module_exit() in your driver. 31*52506b09SThomas Zimmermann */ 32*52506b09SThomas Zimmermann 33*52506b09SThomas Zimmermann /* 34*52506b09SThomas Zimmermann * PCI drivers 35*52506b09SThomas Zimmermann */ 36*52506b09SThomas Zimmermann 37*52506b09SThomas Zimmermann static inline int __init drm_pci_register_driver(struct pci_driver *pci_drv) 38*52506b09SThomas Zimmermann { 39*52506b09SThomas Zimmermann if (drm_firmware_drivers_only()) 40*52506b09SThomas Zimmermann return -ENODEV; 41*52506b09SThomas Zimmermann 42*52506b09SThomas Zimmermann return pci_register_driver(pci_drv); 43*52506b09SThomas Zimmermann } 44*52506b09SThomas Zimmermann 45*52506b09SThomas Zimmermann /** 46*52506b09SThomas Zimmermann * drm_module_pci_driver - Register a DRM driver for PCI-based devices 47*52506b09SThomas Zimmermann * @__pci_drv: the PCI driver structure 48*52506b09SThomas Zimmermann * 49*52506b09SThomas Zimmermann * Registers a DRM driver for devices on the PCI bus. The helper 50*52506b09SThomas Zimmermann * macro behaves like module_pci_driver() but tests the state of 51*52506b09SThomas Zimmermann * drm_firmware_drivers_only(). For more complex module initialization, 52*52506b09SThomas Zimmermann * use module_init() and module_exit() directly. 53*52506b09SThomas Zimmermann * 54*52506b09SThomas Zimmermann * Each module may only use this macro once. Calling it replaces 55*52506b09SThomas Zimmermann * module_init() and module_exit(). 56*52506b09SThomas Zimmermann */ 57*52506b09SThomas Zimmermann #define drm_module_pci_driver(__pci_drv) \ 58*52506b09SThomas Zimmermann module_driver(__pci_drv, drm_pci_register_driver, pci_unregister_driver) 59*52506b09SThomas Zimmermann 60*52506b09SThomas Zimmermann static inline int __init 61*52506b09SThomas Zimmermann drm_pci_register_driver_if_modeset(struct pci_driver *pci_drv, int modeset) 62*52506b09SThomas Zimmermann { 63*52506b09SThomas Zimmermann if (drm_firmware_drivers_only() && modeset == -1) 64*52506b09SThomas Zimmermann return -ENODEV; 65*52506b09SThomas Zimmermann if (modeset == 0) 66*52506b09SThomas Zimmermann return -ENODEV; 67*52506b09SThomas Zimmermann 68*52506b09SThomas Zimmermann return pci_register_driver(pci_drv); 69*52506b09SThomas Zimmermann } 70*52506b09SThomas Zimmermann 71*52506b09SThomas Zimmermann static inline void __exit 72*52506b09SThomas Zimmermann drm_pci_unregister_driver_if_modeset(struct pci_driver *pci_drv, int modeset) 73*52506b09SThomas Zimmermann { 74*52506b09SThomas Zimmermann pci_unregister_driver(pci_drv); 75*52506b09SThomas Zimmermann } 76*52506b09SThomas Zimmermann 77*52506b09SThomas Zimmermann /** 78*52506b09SThomas Zimmermann * drm_module_pci_driver_if_modeset - Register a DRM driver for PCI-based devices 79*52506b09SThomas Zimmermann * @__pci_drv: the PCI driver structure 80*52506b09SThomas Zimmermann * @__modeset: an additional parameter that disables the driver 81*52506b09SThomas Zimmermann * 82*52506b09SThomas Zimmermann * This macro is deprecated and only provided for existing drivers. For 83*52506b09SThomas Zimmermann * new drivers, use drm_module_pci_driver(). 84*52506b09SThomas Zimmermann * 85*52506b09SThomas Zimmermann * Registers a DRM driver for devices on the PCI bus. The helper macro 86*52506b09SThomas Zimmermann * behaves like drm_module_pci_driver() with an additional driver-specific 87*52506b09SThomas Zimmermann * flag. If __modeset is 0, the driver has been disabled, if __modeset is 88*52506b09SThomas Zimmermann * -1 the driver state depends on the global DRM state. For all other 89*52506b09SThomas Zimmermann * values, the PCI driver has been enabled. The default should be -1. 90*52506b09SThomas Zimmermann */ 91*52506b09SThomas Zimmermann #define drm_module_pci_driver_if_modeset(__pci_drv, __modeset) \ 92*52506b09SThomas Zimmermann module_driver(__pci_drv, drm_pci_register_driver_if_modeset, \ 93*52506b09SThomas Zimmermann drm_pci_unregister_driver_if_modeset, __modeset) 94*52506b09SThomas Zimmermann 95*52506b09SThomas Zimmermann #endif 96