xref: /freebsd/sys/dev/gpio/gpiobus_if.m (revision 8eb2bee6c0f4957c6c1cea826e59cda4d18a2a64)
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$
27#
28
29#include <sys/bus.h>
30#include <sys/gpio.h>
31
32INTERFACE gpiobus;
33
34#
35# Dedicate the gpio bus control for a child
36#
37METHOD int acquire_bus {
38	device_t busdev;
39	device_t dev;
40	int how;
41};
42
43#
44# Release the bus
45#
46METHOD void release_bus {
47	device_t busdev;
48	device_t dev;
49};
50
51#
52# Set value of pin specified by pin_num
53#
54METHOD int pin_set {
55	device_t dev;
56	device_t child;
57	uint32_t pin_num;
58	uint32_t pin_value;
59};
60
61#
62# Get value of pin specified by pin_num
63#
64METHOD int pin_get {
65	device_t dev;
66	device_t child;
67	uint32_t pin_num;
68	uint32_t *pin_value;
69};
70
71#
72# Toggle value of pin specified by pin_num
73#
74METHOD int pin_toggle {
75	device_t dev;
76	device_t child;
77	uint32_t pin_num;
78};
79
80#
81# Get pin capabilities
82#
83METHOD int pin_getcaps {
84	device_t dev;
85	device_t child;
86	uint32_t pin_num;
87	uint32_t *caps;
88};
89
90#
91# Get pin flags
92#
93METHOD int pin_getflags {
94	device_t dev;
95	device_t child;
96	uint32_t pin_num;
97	uint32_t *flags;
98};
99
100#
101# Set current configuration and capabilities
102#
103METHOD int pin_setflags {
104	device_t dev;
105	device_t child;
106	uint32_t pin_num;
107	uint32_t flags;
108};
109
110#
111# Get the pin name
112#
113METHOD int pin_getname {
114	device_t dev;
115	uint32_t pin_num;
116	char *name;
117};
118
119#
120# Set the pin name
121#
122METHOD int pin_setname {
123	device_t dev;
124	uint32_t pin_num;
125	const char *name;
126};
127