xref: /freebsd/sys/kern/cpufreq_if.m (revision ebacd8013fe5f7fdf9f6a5b286f6680dd2891036)
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# $FreeBSD$
27#
28
29#include <sys/bus.h>
30
31INTERFACE cpufreq;
32
33HEADER {
34	struct cf_level;
35	struct cf_setting;
36};
37
38# cpufreq interface methods
39
40#
41# Set the current CPU frequency level.
42#
43METHOD int set {
44	device_t		dev;
45	const struct cf_level	*level;
46	int			priority;
47};
48
49#
50# Get the current active level.
51#
52METHOD int get {
53	device_t		dev;
54	struct cf_level		*level;
55};
56
57#
58# Get the current possible levels, based on all drivers.
59#
60METHOD int levels {
61	device_t		dev;
62	struct cf_level		*levels;
63	int			*count;
64};
65
66# Individual frequency driver methods
67
68#
69# Set an individual driver's setting.
70#
71METHOD int drv_set {
72	device_t		dev;
73	const struct cf_setting	*set;
74};
75
76#
77# Get an individual driver's setting.
78#
79METHOD int drv_get {
80	device_t		dev;
81	struct cf_setting	*set;
82};
83
84#
85# Get the settings supported by a driver.
86#
87METHOD int drv_settings {
88	device_t		dev;
89	struct cf_setting	*sets;
90	int			*count;
91};
92
93#
94# Get an individual driver's type.
95#
96METHOD int drv_type {
97	device_t		dev;
98	int			*type;
99};
100
101