gpio_if.m revision 278786 
1#-
2# Copyright (c) 2009 Oleksandr Tymoshenko <gonzo@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# $FreeBSD: stable/10/sys/dev/gpio/gpio_if.m 278786 2015-02-14 21:16:19Z loos $
27#
28
29#include <sys/bus.h>
30#include <sys/gpio.h>
31
32INTERFACE gpio;
33
34CODE {
35	static int
36	gpio_default_map_gpios(device_t bus, phandle_t dev,
37	    phandle_t gparent, int gcells, pcell_t *gpios, uint32_t *pin,
38	    uint32_t *flags)
39	{
40		/* Propagate up the bus hierarchy until someone handles it. */  
41		if (device_get_parent(bus) != NULL)
42			return (GPIO_MAP_GPIOS(device_get_parent(bus), dev,
43			    gparent, gcells, gpios, pin, flags));
44
45		/* If that fails, then assume the FreeBSD defaults. */
46		*pin = gpios[0];
47		if (gcells == 2 || gcells == 3)
48			*flags = gpios[gcells - 1];
49
50		return (0);
51	}
52};
53
54HEADER {
55	#include <dev/ofw/openfirm.h>
56};
57
58#
59# Get maximum pin number
60#
61METHOD int pin_max {
62	device_t dev;
63	int *maxpin;
64};
65
66#
67# Set value of pin specifed by pin_num 
68#
69METHOD int pin_set {
70	device_t dev;
71	uint32_t pin_num;
72	uint32_t pin_value;
73};
74
75#
76# Get value of pin specifed by pin_num 
77#
78METHOD int pin_get {
79	device_t dev;
80	uint32_t pin_num;
81	uint32_t *pin_value;
82};
83
84#
85# Toggle value of pin specifed by pin_num 
86#
87METHOD int pin_toggle {
88	device_t dev;
89	uint32_t pin_num;
90};
91
92#
93# Get pin capabilities
94#
95METHOD int pin_getcaps {
96	device_t dev;
97	uint32_t pin_num;
98	uint32_t *caps;
99};
100
101#
102# Get pin flags
103#
104METHOD int pin_getflags {
105	device_t dev;
106	uint32_t pin_num;
107	uint32_t *flags;
108};
109
110#
111# Get pin name
112#
113METHOD int pin_getname {
114	device_t dev;
115	uint32_t pin_num;
116	char *name;
117};
118
119#
120# Set current configuration and capabilities
121#
122METHOD int pin_setflags {
123	device_t dev;
124	uint32_t pin_num;
125	uint32_t flags;
126};
127
128#
129# Allow the GPIO controller to map the gpio-specifier on its own.
130#
131METHOD int map_gpios {
132        device_t bus;
133        phandle_t dev;
134        phandle_t gparent;
135        int gcells;
136        pcell_t *gpios;
137        uint32_t *pin;
138        uint32_t *flags;
139} DEFAULT gpio_default_map_gpios;
140