xref: /rk3399_ARM-atf/drivers/gpio/gpio.c (revision 1ffecc24000c5ce3241a7b205d9bd5bced7fae58)
1*1ffecc24SHaojian Zhuang /*
2*1ffecc24SHaojian Zhuang  * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
3*1ffecc24SHaojian Zhuang  *
4*1ffecc24SHaojian Zhuang  * Redistribution and use in source and binary forms, with or without
5*1ffecc24SHaojian Zhuang  * modification, are permitted provided that the following conditions are met:
6*1ffecc24SHaojian Zhuang  *
7*1ffecc24SHaojian Zhuang  * Redistributions of source code must retain the above copyright notice, this
8*1ffecc24SHaojian Zhuang  * list of conditions and the following disclaimer.
9*1ffecc24SHaojian Zhuang  *
10*1ffecc24SHaojian Zhuang  * Redistributions in binary form must reproduce the above copyright notice,
11*1ffecc24SHaojian Zhuang  * this list of conditions and the following disclaimer in the documentation
12*1ffecc24SHaojian Zhuang  * and/or other materials provided with the distribution.
13*1ffecc24SHaojian Zhuang  *
14*1ffecc24SHaojian Zhuang  * Neither the name of ARM nor the names of its contributors may be used
15*1ffecc24SHaojian Zhuang  * to endorse or promote products derived from this software without specific
16*1ffecc24SHaojian Zhuang  * prior written permission.
17*1ffecc24SHaojian Zhuang  *
18*1ffecc24SHaojian Zhuang  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19*1ffecc24SHaojian Zhuang  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20*1ffecc24SHaojian Zhuang  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21*1ffecc24SHaojian Zhuang  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22*1ffecc24SHaojian Zhuang  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23*1ffecc24SHaojian Zhuang  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24*1ffecc24SHaojian Zhuang  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25*1ffecc24SHaojian Zhuang  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26*1ffecc24SHaojian Zhuang  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27*1ffecc24SHaojian Zhuang  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28*1ffecc24SHaojian Zhuang  * POSSIBILITY OF SUCH DAMAGE.
29*1ffecc24SHaojian Zhuang  *
30*1ffecc24SHaojian Zhuang  * GPIO -- General Purpose Input/Output
31*1ffecc24SHaojian Zhuang  *
32*1ffecc24SHaojian Zhuang  * Defines a simple and generic interface to access GPIO device.
33*1ffecc24SHaojian Zhuang  *
34*1ffecc24SHaojian Zhuang  */
35*1ffecc24SHaojian Zhuang 
36*1ffecc24SHaojian Zhuang #include <assert.h>
37*1ffecc24SHaojian Zhuang #include <errno.h>
38*1ffecc24SHaojian Zhuang #include <gpio.h>
39*1ffecc24SHaojian Zhuang 
40*1ffecc24SHaojian Zhuang /*
41*1ffecc24SHaojian Zhuang  * The gpio implementation
42*1ffecc24SHaojian Zhuang  */
43*1ffecc24SHaojian Zhuang static const gpio_ops_t *ops;
44*1ffecc24SHaojian Zhuang 
45*1ffecc24SHaojian Zhuang int gpio_get_direction(int gpio)
46*1ffecc24SHaojian Zhuang {
47*1ffecc24SHaojian Zhuang 	assert(ops);
48*1ffecc24SHaojian Zhuang 	assert(ops->get_direction != 0);
49*1ffecc24SHaojian Zhuang 	assert(gpio >= 0);
50*1ffecc24SHaojian Zhuang 
51*1ffecc24SHaojian Zhuang 	return ops->get_direction(gpio);
52*1ffecc24SHaojian Zhuang }
53*1ffecc24SHaojian Zhuang 
54*1ffecc24SHaojian Zhuang void gpio_set_direction(int gpio, int direction)
55*1ffecc24SHaojian Zhuang {
56*1ffecc24SHaojian Zhuang 	assert(ops);
57*1ffecc24SHaojian Zhuang 	assert(ops->set_direction != 0);
58*1ffecc24SHaojian Zhuang 	assert((direction == GPIO_DIR_OUT) || (direction == GPIO_DIR_IN));
59*1ffecc24SHaojian Zhuang 	assert(gpio >= 0);
60*1ffecc24SHaojian Zhuang 
61*1ffecc24SHaojian Zhuang 	ops->set_direction(gpio, direction);
62*1ffecc24SHaojian Zhuang }
63*1ffecc24SHaojian Zhuang 
64*1ffecc24SHaojian Zhuang int gpio_get_value(int gpio)
65*1ffecc24SHaojian Zhuang {
66*1ffecc24SHaojian Zhuang 	assert(ops);
67*1ffecc24SHaojian Zhuang 	assert(ops->get_value != 0);
68*1ffecc24SHaojian Zhuang 	assert(gpio >= 0);
69*1ffecc24SHaojian Zhuang 
70*1ffecc24SHaojian Zhuang 	return ops->get_value(gpio);
71*1ffecc24SHaojian Zhuang }
72*1ffecc24SHaojian Zhuang 
73*1ffecc24SHaojian Zhuang void gpio_set_value(int gpio, int value)
74*1ffecc24SHaojian Zhuang {
75*1ffecc24SHaojian Zhuang 	assert(ops);
76*1ffecc24SHaojian Zhuang 	assert(ops->set_value != 0);
77*1ffecc24SHaojian Zhuang 	assert((value == GPIO_LEVEL_LOW) || (value == GPIO_LEVEL_HIGH));
78*1ffecc24SHaojian Zhuang 	assert(gpio >= 0);
79*1ffecc24SHaojian Zhuang 
80*1ffecc24SHaojian Zhuang 	ops->set_value(gpio, value);
81*1ffecc24SHaojian Zhuang }
82*1ffecc24SHaojian Zhuang 
83*1ffecc24SHaojian Zhuang /*
84*1ffecc24SHaojian Zhuang  * Initialize the gpio. The fields in the provided gpio
85*1ffecc24SHaojian Zhuang  * ops pointer must be valid.
86*1ffecc24SHaojian Zhuang  */
87*1ffecc24SHaojian Zhuang void gpio_init(const gpio_ops_t *ops_ptr)
88*1ffecc24SHaojian Zhuang {
89*1ffecc24SHaojian Zhuang 	assert(ops_ptr != 0  &&
90*1ffecc24SHaojian Zhuang 	       (ops_ptr->get_direction != 0) &&
91*1ffecc24SHaojian Zhuang 	       (ops_ptr->set_direction != 0) &&
92*1ffecc24SHaojian Zhuang 	       (ops_ptr->get_value != 0) &&
93*1ffecc24SHaojian Zhuang 	       (ops_ptr->set_value != 0));
94*1ffecc24SHaojian Zhuang 
95*1ffecc24SHaojian Zhuang 	ops = ops_ptr;
96*1ffecc24SHaojian Zhuang }
97