xref: /freebsd/sys/dev/fdt/fdt_pinctrl_if.m (revision 2008043f386721d58158e37e0d7e50df8095942d)
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#include <sys/bus.h>
30#include <dev/ofw/openfirm.h>
31
32#
33# This is the interface that fdt_pinctrl drivers provide to other drivers.
34#
35
36INTERFACE fdt_pinctrl;
37
38CODE {
39	static int
40	fdt_pinctrl_default_is_gpio(device_t pinctrl, device_t gpio, bool *is_gpio)
41	{
42
43		return (EOPNOTSUPP);
44	}
45
46	static int
47	fdt_pinctrl_default_set_flags(device_t pinctrl, device_t gpio, uint32_t pin,
48	    uint32_t flags)
49	{
50
51		return (EOPNOTSUPP);
52	}
53
54	static int
55	fdt_pinctrl_default_get_flags(device_t pinctrl, device_t gpio, uint32_t pin,
56	    uint32_t *flags)
57	{
58
59		return (EOPNOTSUPP);
60	}
61};
62
63# Needed for timestamping device probe/attach calls
64HEADER {
65	#include <sys/tslog.h>
66}
67
68#
69# Set pins to the specified configuration.  The cfgxref arg is an xref phandle
70# to a descendent node (child, grandchild, ...) of the pinctrl device node.
71# Returns 0 on success or a standard errno value.
72#
73PROLOG {
74	TSENTER2(device_get_name(pinctrl));
75}
76EPILOG {
77	TSEXIT2(device_get_name(pinctrl));
78}
79METHOD int configure {
80	device_t	pinctrl;
81	phandle_t	cfgxref;
82};
83
84
85#
86# Test if the pin is in gpio mode
87# Called from a gpio device
88#
89METHOD int is_gpio {
90	device_t pinctrl;
91	device_t gpio;
92	uint32_t pin;
93	bool *is_gpio;
94} DEFAULT fdt_pinctrl_default_is_gpio;
95
96#
97# Set the flags of a pin
98# Called from a gpio device
99#
100METHOD int set_flags {
101	device_t pinctrl;
102	device_t gpio;
103	uint32_t pin;
104	uint32_t flags;
105} DEFAULT fdt_pinctrl_default_set_flags;
106
107#
108# Get the flags of a pin
109# Called from a gpio device
110#
111METHOD int get_flags {
112	device_t pinctrl;
113	device_t gpio;
114	uint32_t pin;
115	uint32_t *flags;
116} DEFAULT fdt_pinctrl_default_get_flags;
117