xref: /freebsd/sys/dev/gpio/gpio_if.m (revision d2ce15bd43b3a1dcce08eecbff8d5d359946d972)
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 gpio;
33
34#
35# Get total number of pins
36#
37METHOD int pin_max {
38	device_t dev;
39	int *npins;
40};
41
42#
43# Set value of pin specifed by pin_num
44#
45METHOD int pin_set {
46	device_t dev;
47	uint32_t pin_num;
48	uint32_t pin_value;
49};
50
51#
52# Get value of pin specifed by pin_num
53#
54METHOD int pin_get {
55	device_t dev;
56	uint32_t pin_num;
57	uint32_t *pin_value;
58};
59
60#
61# Toggle value of pin specifed by pin_num
62#
63METHOD int pin_toggle {
64	device_t dev;
65	uint32_t pin_num;
66};
67
68#
69# Get pin capabilities
70#
71METHOD int pin_getcaps {
72	device_t dev;
73	uint32_t pin_num;
74	uint32_t *caps;
75};
76
77#
78# Get pin flags
79#
80METHOD int pin_getflags {
81	device_t dev;
82	uint32_t pin_num;
83	uint32_t *flags;
84};
85
86#
87# Get pin name
88#
89METHOD int pin_getname {
90	device_t dev;
91	uint32_t pin_num;
92	char *name;
93};
94
95#
96# Set current configuration and capabilities
97#
98METHOD int pin_setflags {
99	device_t dev;
100	uint32_t pin_num;
101	uint32_t flags;
102};
103