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