xref: /dflybsd-src/sys/dev/drm/amd/display/include/gpio_interface.h (revision b843c749addef9340ee7d4e250b09fdd492602a1)
1*b843c749SSergey Zigachev /*
2*b843c749SSergey Zigachev  * Copyright 2012-15 Advanced Micro Devices, Inc.
3*b843c749SSergey Zigachev  *
4*b843c749SSergey Zigachev  * Permission is hereby granted, free of charge, to any person obtaining a
5*b843c749SSergey Zigachev  * copy of this software and associated documentation files (the "Software"),
6*b843c749SSergey Zigachev  * to deal in the Software without restriction, including without limitation
7*b843c749SSergey Zigachev  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8*b843c749SSergey Zigachev  * and/or sell copies of the Software, and to permit persons to whom the
9*b843c749SSergey Zigachev  * Software is furnished to do so, subject to the following conditions:
10*b843c749SSergey Zigachev  *
11*b843c749SSergey Zigachev  * The above copyright notice and this permission notice shall be included in
12*b843c749SSergey Zigachev  * all copies or substantial portions of the Software.
13*b843c749SSergey Zigachev  *
14*b843c749SSergey Zigachev  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15*b843c749SSergey Zigachev  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16*b843c749SSergey Zigachev  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17*b843c749SSergey Zigachev  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18*b843c749SSergey Zigachev  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19*b843c749SSergey Zigachev  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20*b843c749SSergey Zigachev  * OTHER DEALINGS IN THE SOFTWARE.
21*b843c749SSergey Zigachev  *
22*b843c749SSergey Zigachev  * Authors: AMD
23*b843c749SSergey Zigachev  *
24*b843c749SSergey Zigachev  */
25*b843c749SSergey Zigachev 
26*b843c749SSergey Zigachev #ifndef __DAL_GPIO_INTERFACE_H__
27*b843c749SSergey Zigachev #define __DAL_GPIO_INTERFACE_H__
28*b843c749SSergey Zigachev 
29*b843c749SSergey Zigachev #include "gpio_types.h"
30*b843c749SSergey Zigachev #include "grph_object_defs.h"
31*b843c749SSergey Zigachev 
32*b843c749SSergey Zigachev struct gpio;
33*b843c749SSergey Zigachev 
34*b843c749SSergey Zigachev /* Open the handle for future use */
35*b843c749SSergey Zigachev enum gpio_result dal_gpio_open(
36*b843c749SSergey Zigachev 	struct gpio *gpio,
37*b843c749SSergey Zigachev 	enum gpio_mode mode);
38*b843c749SSergey Zigachev 
39*b843c749SSergey Zigachev enum gpio_result dal_gpio_open_ex(
40*b843c749SSergey Zigachev 	struct gpio *gpio,
41*b843c749SSergey Zigachev 	enum gpio_mode mode);
42*b843c749SSergey Zigachev 
43*b843c749SSergey Zigachev /* Get high or low from the pin */
44*b843c749SSergey Zigachev enum gpio_result dal_gpio_get_value(
45*b843c749SSergey Zigachev 	const struct gpio *gpio,
46*b843c749SSergey Zigachev 	uint32_t *value);
47*b843c749SSergey Zigachev 
48*b843c749SSergey Zigachev /* Set pin high or low */
49*b843c749SSergey Zigachev enum gpio_result dal_gpio_set_value(
50*b843c749SSergey Zigachev 	const struct gpio *gpio,
51*b843c749SSergey Zigachev 	uint32_t value);
52*b843c749SSergey Zigachev 
53*b843c749SSergey Zigachev /* Get current mode */
54*b843c749SSergey Zigachev enum gpio_mode dal_gpio_get_mode(
55*b843c749SSergey Zigachev 	const struct gpio *gpio);
56*b843c749SSergey Zigachev 
57*b843c749SSergey Zigachev /* Change mode of the handle */
58*b843c749SSergey Zigachev enum gpio_result dal_gpio_change_mode(
59*b843c749SSergey Zigachev 	struct gpio *gpio,
60*b843c749SSergey Zigachev 	enum gpio_mode mode);
61*b843c749SSergey Zigachev 
62*b843c749SSergey Zigachev /* Get the GPIO id */
63*b843c749SSergey Zigachev enum gpio_id dal_gpio_get_id(
64*b843c749SSergey Zigachev 	const struct gpio *gpio);
65*b843c749SSergey Zigachev 
66*b843c749SSergey Zigachev /* Get the GPIO enum */
67*b843c749SSergey Zigachev uint32_t dal_gpio_get_enum(
68*b843c749SSergey Zigachev 	const struct gpio *gpio);
69*b843c749SSergey Zigachev 
70*b843c749SSergey Zigachev /* Set the GPIO pin configuration */
71*b843c749SSergey Zigachev enum gpio_result dal_gpio_set_config(
72*b843c749SSergey Zigachev 	struct gpio *gpio,
73*b843c749SSergey Zigachev 	const struct gpio_config_data *config_data);
74*b843c749SSergey Zigachev 
75*b843c749SSergey Zigachev /* Obtain GPIO pin info */
76*b843c749SSergey Zigachev enum gpio_result dal_gpio_get_pin_info(
77*b843c749SSergey Zigachev 	const struct gpio *gpio,
78*b843c749SSergey Zigachev 	struct gpio_pin_info *pin_info);
79*b843c749SSergey Zigachev 
80*b843c749SSergey Zigachev /* Obtain GPIO sync source */
81*b843c749SSergey Zigachev enum sync_source dal_gpio_get_sync_source(
82*b843c749SSergey Zigachev 	const struct gpio *gpio);
83*b843c749SSergey Zigachev 
84*b843c749SSergey Zigachev /* Obtain GPIO pin output state (active low or active high) */
85*b843c749SSergey Zigachev enum gpio_pin_output_state dal_gpio_get_output_state(
86*b843c749SSergey Zigachev 	const struct gpio *gpio);
87*b843c749SSergey Zigachev 
88*b843c749SSergey Zigachev /* Close the handle */
89*b843c749SSergey Zigachev void dal_gpio_close(
90*b843c749SSergey Zigachev 	struct gpio *gpio);
91*b843c749SSergey Zigachev 
92*b843c749SSergey Zigachev #endif
93