xref: /freebsd/sys/dev/clk/clknode_if.m (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1#-
2# Copyright 2016 Michal Meloun <mmel@FreeBSD.org>
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
28INTERFACE clknode;
29
30HEADER {
31	struct clknode;
32}
33
34#
35# Initialize clock node, get shanpshot of cached values
36#
37METHOD int init {
38	struct clknode	*clk;
39	device_t	dev;
40};
41
42#
43# Recalculate frequency
44#     req - in/out recalulated frequency
45#
46METHOD int recalc_freq {
47	struct clknode	*clk;
48	uint64_t	*freq;
49};
50
51#
52# Set frequency
53#     fin - parent (input)frequency.
54#     fout - requested output freqency. If clock cannot change frequency,
55#	    then must return new requested frequency for his parent
56METHOD int set_freq {
57	struct clknode	*clk;
58	uint64_t	fin;
59	uint64_t	*fout;
60	int		flags;
61	int		*done;
62};
63
64#
65# Enable/disable clock
66#
67METHOD int set_gate {
68	struct clknode	*clk;
69	bool		enable;
70};
71
72#
73# Get gate status
74#   Return: ENXIO - method is not implemented
75#	    ENOENT - HW doesn't support reading of gate enable
76#	    0 - success
77#
78METHOD int get_gate {
79	struct clknode	*clk;
80	bool		*enabled;
81};
82
83#
84# Set multiplexer
85#
86METHOD int set_mux {
87	struct clknode	*clk;
88	int		idx;
89};
90