xref: /freebsd/sys/kern/cpufreq_if.m (revision 5e3190f700637fcfc1a52daeaa4a031fdd2557c7)
1#
2# Copyright (c) 2004 Nate Lawson
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26#
27
28#include <sys/bus.h>
29
30INTERFACE cpufreq;
31
32HEADER {
33	struct cf_level;
34	struct cf_setting;
35};
36
37# cpufreq interface methods
38
39#
40# Set the current CPU frequency level.
41#
42METHOD int set {
43	device_t		dev;
44	const struct cf_level	*level;
45	int			priority;
46};
47
48#
49# Get the current active level.
50#
51METHOD int get {
52	device_t		dev;
53	struct cf_level		*level;
54};
55
56#
57# Get the current possible levels, based on all drivers.
58#
59METHOD int levels {
60	device_t		dev;
61	struct cf_level		*levels;
62	int			*count;
63};
64
65# Individual frequency driver methods
66
67#
68# Set an individual driver's setting.
69#
70METHOD int drv_set {
71	device_t		dev;
72	const struct cf_setting	*set;
73};
74
75#
76# Get an individual driver's setting.
77#
78METHOD int drv_get {
79	device_t		dev;
80	struct cf_setting	*set;
81};
82
83#
84# Get the settings supported by a driver.
85#
86METHOD int drv_settings {
87	device_t		dev;
88	struct cf_setting	*sets;
89	int			*count;
90};
91
92#
93# Get an individual driver's type.
94#
95METHOD int drv_type {
96	device_t		dev;
97	int			*type;
98};
99
100