dpms.c revision 197022 
1/*-
2 * Copyright (c) 2008 Yahoo!, Inc.
3 * All rights reserved.
4 * Written by: John Baldwin <jhb@FreeBSD.org>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the author nor the names of any co-contributors
15 *    may be used to endorse or promote products derived from this software
16 *    without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30
31/*
32 * Copyright (c) 2004 Benjamin Close <Benjamin.Close@clearchain.com>
33 * All rights reserved.
34 *
35 * Redistribution and use in source and binary forms, with or without
36 * modification, are permitted provided that the following conditions
37 * are met:
38 * 1. Redistributions of source code must retain the above copyright
39 *    notice, this list of conditions and the following disclaimer.
40 * 2. Redistributions in binary form must reproduce the above copyright
41 *    notice, this list of conditions and the following disclaimer in the
42 *    documentation and/or other materials provided with the distribution.
43 *
44 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54 * SUCH DAMAGE.
55 */
56
57/*
58 * Support for managing the display via DPMS for suspend/resume.
59 */
60
61#include <sys/cdefs.h>
62__FBSDID("$FreeBSD: head/sys/dev/dpms/dpms.c 197022 2009-09-09 07:45:08Z delphij $");
63
64#include <sys/param.h>
65#include <sys/bus.h>
66#include <sys/kernel.h>
67#include <sys/libkern.h>
68#include <sys/module.h>
69
70#include <machine/vm86.h>
71
72/*
73 * VESA DPMS States
74 */
75#define DPMS_ON		0x00
76#define DPMS_STANDBY	0x01
77#define DPMS_SUSPEND	0x02
78#define DPMS_OFF	0x04
79#define DPMS_REDUCEDON	0x08
80
81#define	VBE_DPMS_FUNCTION	0x4F10
82#define	VBE_DPMS_GET_SUPPORTED_STATES 0x00
83#define	VBE_DPMS_GET_STATE	0x02
84#define	VBE_DPMS_SET_STATE	0x01
85#define VBE_MAJORVERSION_MASK	0x0F
86#define VBE_MINORVERSION_MASK	0xF0
87
88struct dpms_softc {
89	int	dpms_supported_states;
90	int	dpms_initial_state;
91};
92
93static int	dpms_attach(device_t);
94static int	dpms_detach(device_t);
95static int	dpms_get_supported_states(int *);
96static int	dpms_get_current_state(int *);
97static void	dpms_identify(driver_t *, device_t);
98static int	dpms_probe(device_t);
99static int	dpms_resume(device_t);
100static int	dpms_set_state(int);
101static int	dpms_suspend(device_t);
102
103static device_method_t dpms_methods[] = {
104	DEVMETHOD(device_identify,	dpms_identify),
105	DEVMETHOD(device_probe,		dpms_probe),
106	DEVMETHOD(device_attach,	dpms_attach),
107	DEVMETHOD(device_detach,	dpms_detach),
108	DEVMETHOD(device_suspend,	dpms_suspend),
109	DEVMETHOD(device_resume,	dpms_resume),
110	{ 0, 0 }
111};
112
113static driver_t dpms_driver = {
114	"dpms",
115	dpms_methods,
116	sizeof(struct dpms_softc),
117};
118
119static devclass_t dpms_devclass;
120
121DRIVER_MODULE(dpms, vgapci, dpms_driver, dpms_devclass, NULL, NULL);
122
123static void
124dpms_identify(driver_t *driver, device_t parent)
125{
126
127	/*
128	 * XXX: The DPMS VBE only allows for manipulating a single
129	 * monitor, but we don't know which one.  Just attach to the
130	 * first vgapci(4) device we encounter and hope it is the
131	 * right one.
132	 */
133	if (devclass_get_device(dpms_devclass, 0) == NULL)
134		device_add_child(parent, "dpms", 0);
135}
136
137static int
138dpms_probe(device_t dev)
139{
140	int error, states;
141
142	error = dpms_get_supported_states(&states);
143	if (error)
144		return (error);
145	device_set_desc(dev, "DPMS suspend/resume");
146	device_quiet(dev);
147	return (BUS_PROBE_DEFAULT);
148}
149
150static int
151dpms_attach(device_t dev)
152{
153	struct dpms_softc *sc;
154	int error;
155
156	sc = device_get_softc(dev);
157	error = dpms_get_supported_states(&sc->dpms_supported_states);
158	if (error)
159		return (error);
160	error = dpms_get_current_state(&sc->dpms_initial_state);
161	return (error);
162}
163
164static int
165dpms_detach(device_t dev)
166{
167
168	return (0);
169}
170
171static int
172dpms_suspend(device_t dev)
173{
174
175	dpms_set_state(DPMS_OFF);
176	return (0);
177}
178
179static int
180dpms_resume(device_t dev)
181{
182	struct dpms_softc *sc;
183
184	sc = device_get_softc(dev);
185	dpms_set_state(sc->dpms_initial_state);
186	return (0);
187}
188
189static int
190dpms_call_bios(int subfunction, int *bh)
191{
192	struct vm86frame vmf;
193	int error;
194
195	bzero(&vmf, sizeof(vmf));
196	vmf.vmf_ax = VBE_DPMS_FUNCTION;
197	vmf.vmf_bl = subfunction;
198	vmf.vmf_bh = *bh;
199	vmf.vmf_es = 0;
200	vmf.vmf_di = 0;
201	error = vm86_intcall(0x10, &vmf);
202	if (error == 0 && (vmf.vmf_eax & 0xffff) != 0x004f)
203		error = ENXIO;
204	if (error == 0)
205		*bh = vmf.vmf_bh;
206	return (error);
207}
208
209static int
210dpms_get_supported_states(int *states)
211{
212
213	*states = 0;
214	return (dpms_call_bios(VBE_DPMS_GET_SUPPORTED_STATES, states));
215}
216
217static int
218dpms_get_current_state(int *state)
219{
220
221	*state = 0;
222	return (dpms_call_bios(VBE_DPMS_GET_STATE, state));
223}
224
225static int
226dpms_set_state(int state)
227{
228
229	return (dpms_call_bios(VBE_DPMS_SET_STATE, &state));
230}
231