Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

drm/fb-helper: document remove*_conflicting_framebuffers()

Copy remove*_conflicting_framebuffers() kerneldocs from fbdev code
to make DRM developers' life easier.

Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/f70c1cc4a4f77dd9bad58fc7ca344609c0a91fa7.1536342228.git.mirq-linux@rere.qmqm.pl

authored by

Michał Mirosław and committed by
Daniel Vetter
c9527f0d d3147adc

+22
+22
include/drm/drm_fb_helper.h
··· 604 604 605 605 #endif 606 606 607 + /** 608 + * drm_fb_helper_remove_conflicting_framebuffers - remove firmware-configured framebuffers 609 + * @a: memory range, users of which are to be removed 610 + * @name: requesting driver name 611 + * @primary: also kick vga16fb if present 612 + * 613 + * This function removes framebuffer devices (initialized by firmware/bootloader) 614 + * which use memory range described by @a. If @a is NULL all such devices are 615 + * removed. 616 + */ 607 617 static inline int 608 618 drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a, 609 619 const char *name, bool primary) ··· 625 615 #endif 626 616 } 627 617 618 + /** 619 + * drm_fb_helper_remove_conflicting_pci_framebuffers - remove firmware-configured framebuffers for PCI devices 620 + * @pdev: PCI device 621 + * @resource_id: index of PCI BAR configuring framebuffer memory 622 + * @name: requesting driver name 623 + * 624 + * This function removes framebuffer devices (eg. initialized by firmware) 625 + * using memory range configured for @pdev's BAR @resource_id. 626 + * 627 + * The function assumes that PCI device with shadowed ROM drives a primary 628 + * display and so kicks out vga16fb. 629 + */ 628 630 static inline int 629 631 drm_fb_helper_remove_conflicting_pci_framebuffers(struct pci_dev *pdev, 630 632 int resource_id,