xref: /freebsd/sys/dev/fdt/fdt_clock_if.m (revision 5e3190f700637fcfc1a52daeaa4a031fdd2557c7)
1#-
2# Copyright (c) 2014 Ian Lepore
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/types.h>
29
30#
31# This is the interface that fdt_clock drivers provide to other drivers.
32# In this context, clock refers to a clock signal provided to some other
33# hardware component within the system.  They are most often found within
34# embedded processors that have on-chip IO controllers.
35#
36
37INTERFACE fdt_clock;
38
39HEADER {
40
41	enum {
42		FDT_CIFLAG_RUNNING =	0x01,
43	};
44
45	struct fdt_clock_info {
46		device_t	provider;
47		uint32_t	index;
48		const char *	name;         /* May be "", will not be NULL. */
49		uint32_t	flags;
50		uint64_t	frequency;    /* In Hz. */
51	};
52}
53
54#
55# Enable the specified clock.
56# Returns 0 on success or a standard errno value.
57#
58METHOD int enable {
59	device_t	provider;
60	int		index;
61};
62
63#
64# Disable the specified clock.
65# Returns 0 on success or a standard errno value.
66#
67METHOD int disable {
68	device_t	provider;
69	int		index;
70};
71
72#
73# Returns information about the current operational state of specified clock.
74#
75METHOD int get_info {
76	device_t	provider;
77	int		index;
78	struct fdt_clock_info *info;
79};
80
81