xref: /freebsd-12.1/sys/dev/extres/syscon/syscon_if.m (revision add41077) 
1#-
2# Copyright (c) 2015 Michal Meloun
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 <machine/bus.h>
30
31INTERFACE syscon;
32
33HEADER {
34	struct syscon;
35	int syscon_get_handle_default(device_t dev, struct syscon **syscon);
36}
37
38METHOD int init {
39	struct syscon	*syscon;
40};
41
42METHOD int uninit {
43	struct syscon	*syscon;
44};
45
46/**
47 * Accessor functions for syscon register space
48 */
49METHOD uint32_t read_4 {
50	struct syscon	*syscon;
51	bus_size_t	offset;
52};
53
54METHOD int write_4 {
55	struct syscon	*syscon;
56	bus_size_t	offset;
57	uint32_t	val;
58};
59
60METHOD int modify_4 {
61	struct syscon	*syscon;
62	bus_size_t	offset;
63	uint32_t	clear_bits;
64	uint32_t	set_bits;
65};
66
67/**
68 * Get syscon handle from parent driver
69 */
70METHOD int get_handle {
71	device_t	dev;
72	struct syscon	**syscon;
73} DEFAULT syscon_get_handle_default;
74