gpu/doc: Add vga_switcheroo documentation

Requires Markdown support.

Signed-off-by: Lukas Wunner <lukas@wunner.de>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
This commit is contained in:
Lukas Wunner 2015-10-11 11:55:00 +02:00 committed by Daniel Vetter
parent 7f81707429
commit 6648f4879a
1 changed files with 72 additions and 4 deletions

View File

@ -40,6 +40,16 @@
</address> </address>
</affiliation> </affiliation>
</author> </author>
<author>
<firstname>Lukas</firstname>
<surname>Wunner</surname>
<contrib>vga_switcheroo documentation</contrib>
<affiliation>
<address>
<email>lukas@wunner.de</email>
</address>
</affiliation>
</author>
</authorgroup> </authorgroup>
<copyright> <copyright>
@ -51,6 +61,10 @@
<year>2012</year> <year>2012</year>
<holder>Laurent Pinchart</holder> <holder>Laurent Pinchart</holder>
</copyright> </copyright>
<copyright>
<year>2015</year>
<holder>Lukas Wunner</holder>
</copyright>
<legalnotice> <legalnotice>
<para> <para>
@ -69,6 +83,13 @@
<revremark>Added extensive documentation about driver internals. <revremark>Added extensive documentation about driver internals.
</revremark> </revremark>
</revision> </revision>
<revision>
<revnumber>1.1</revnumber>
<date>2015-10-11</date>
<authorinitials>LW</authorinitials>
<revremark>Added vga_switcheroo documentation.
</revremark>
</revision>
</revhistory> </revhistory>
</bookinfo> </bookinfo>
@ -3583,10 +3604,11 @@ void (*postclose) (struct drm_device *, struct drm_file *);</synopsis>
plane properties to default value, so that a subsequent open of the plane properties to default value, so that a subsequent open of the
device will not inherit state from the previous user. It can also be device will not inherit state from the previous user. It can also be
used to execute delayed power switching state changes, e.g. in used to execute delayed power switching state changes, e.g. in
conjunction with the vga_switcheroo infrastructure. Beyond that KMS conjunction with the vga_switcheroo infrastructure (see
drivers should not do any further cleanup. Only legacy UMS drivers might <xref linkend="vga_switcheroo"/>). Beyond that KMS drivers should not
need to clean up device state so that the vga console or an independent do any further cleanup. Only legacy UMS drivers might need to clean up
fbdev driver could take over. device state so that the vga console or an independent fbdev driver
could take over.
</para> </para>
</sect2> </sect2>
<sect2> <sect2>
@ -4200,4 +4222,50 @@ int num_ioctls;</synopsis>
</chapter> </chapter>
!Cdrivers/gpu/drm/i915/i915_irq.c !Cdrivers/gpu/drm/i915/i915_irq.c
</part> </part>
<part id="vga_switcheroo">
<title>vga_switcheroo</title>
<partintro>
!Pdrivers/gpu/vga/vga_switcheroo.c Overview
</partintro>
<chapter id="modes_of_use">
<title>Modes of Use</title>
<sect1>
<title>Manual switching and manual power control</title>
!Pdrivers/gpu/vga/vga_switcheroo.c Manual switching and manual power control
</sect1>
<sect1>
<title>Driver power control</title>
!Pdrivers/gpu/vga/vga_switcheroo.c Driver power control
</sect1>
</chapter>
<chapter id="pubfunctions">
<title>Public functions</title>
!Edrivers/gpu/vga/vga_switcheroo.c
</chapter>
<chapter id="pubstructures">
<title>Public structures</title>
!Finclude/linux/vga_switcheroo.h vga_switcheroo_handler
!Finclude/linux/vga_switcheroo.h vga_switcheroo_client_ops
</chapter>
<chapter id="pubconstants">
<title>Public constants</title>
!Finclude/linux/vga_switcheroo.h vga_switcheroo_client_id
!Finclude/linux/vga_switcheroo.h vga_switcheroo_state
</chapter>
<chapter id="privstructures">
<title>Private structures</title>
!Fdrivers/gpu/vga/vga_switcheroo.c vgasr_priv
!Fdrivers/gpu/vga/vga_switcheroo.c vga_switcheroo_client
</chapter>
!Cdrivers/gpu/vga/vga_switcheroo.c
!Cinclude/linux/vga_switcheroo.h
</part>
</book> </book>