Documentation/gpu: split up the gpu documentation
[linux-2.6-block.git] / Documentation / gpu / vga-switcheroo.rst
CommitLineData
ca00c2b9
JN
1==============
2VGA Switcheroo
3==============
4
5.. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
6 :doc: Overview
7
8Modes of Use
9============
10
11Manual switching and manual power control
12-----------------------------------------
13
14.. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
15 :doc: Manual switching and manual power control
16
17Driver power control
18--------------------
19
20.. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
21 :doc: Driver power control
22
23API
24===
25
26Public functions
27----------------
28
29.. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
30 :export:
31
32Public structures
33-----------------
34
35.. kernel-doc:: include/linux/vga_switcheroo.h
36 :functions: vga_switcheroo_handler
37
38.. kernel-doc:: include/linux/vga_switcheroo.h
39 :functions: vga_switcheroo_client_ops
40
41Public constants
42----------------
43
44.. kernel-doc:: include/linux/vga_switcheroo.h
45 :functions: vga_switcheroo_handler_flags_t
46
47.. kernel-doc:: include/linux/vga_switcheroo.h
48 :functions: vga_switcheroo_client_id
49
50.. kernel-doc:: include/linux/vga_switcheroo.h
51 :functions: vga_switcheroo_state
52
53Private structures
54------------------
55
56.. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
57 :functions: vgasr_priv
58
59.. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
60 :functions: vga_switcheroo_client
61
62Handlers
63========
64
65apple-gmux Handler
66------------------
67
68.. kernel-doc:: drivers/platform/x86/apple-gmux.c
69 :doc: Overview
70
71.. kernel-doc:: drivers/platform/x86/apple-gmux.c
72 :doc: Interrupt
73
74Graphics mux
75~~~~~~~~~~~~
76
77.. kernel-doc:: drivers/platform/x86/apple-gmux.c
78 :doc: Graphics mux
79
80Power control
81~~~~~~~~~~~~~
82
83.. kernel-doc:: drivers/platform/x86/apple-gmux.c
84 :doc: Power control
85
86Backlight control
87~~~~~~~~~~~~~~~~~
88
89.. kernel-doc:: drivers/platform/x86/apple-gmux.c
90 :doc: Backlight control
91
92Public functions
93~~~~~~~~~~~~~~~~
94
95.. kernel-doc:: include/linux/apple-gmux.h
96 :internal:
97
98.. WARNING: DOCPROC directive not supported: !Cdrivers/gpu/vga/vga_switcheroo.c
99
100.. WARNING: DOCPROC directive not supported: !Cinclude/linux/vga_switcheroo.h
101
102.. WARNING: DOCPROC directive not supported: !Cdrivers/platform/x86/apple-gmux.c