1/*
2 * Copyright 2012-16 Advanced Micro Devices, Inc.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 *
22 * Authors: AMD
23 *
24 */
25
26#ifndef __DAL_GPIO_H__
27#define __DAL_GPIO_H__
28
29#include "gpio_types.h"
30
31
32union gpio_hw_container {
33	struct hw_ddc *ddc;
34	struct hw_generic *generic;
35	struct hw_hpd *hpd;
36};
37
38struct gpio {
39	struct gpio_service *service;
40	struct hw_gpio_pin *pin;
41	enum gpio_id id;
42	uint32_t en;
43
44	union gpio_hw_container hw_container;
45	enum gpio_mode mode;
46
47	/* when GPIO comes from VBIOS, it has defined output state */
48	enum gpio_pin_output_state output_state;
49};
50
51#if 0
52struct gpio_funcs {
53
54	struct hw_gpio_pin *(*create_ddc_data)(
55		struct dc_context *ctx,
56		enum gpio_id id,
57		uint32_t en);
58	struct hw_gpio_pin *(*create_ddc_clock)(
59		struct dc_context *ctx,
60		enum gpio_id id,
61		uint32_t en);
62	struct hw_gpio_pin *(*create_generic)(
63		struct dc_context *ctx,
64		enum gpio_id id,
65		uint32_t en);
66	struct hw_gpio_pin *(*create_hpd)(
67		struct dc_context *ctx,
68		enum gpio_id id,
69		uint32_t en);
70	struct hw_gpio_pin *(*create_gpio_pad)(
71		struct dc_context *ctx,
72		enum gpio_id id,
73		uint32_t en);
74	struct hw_gpio_pin *(*create_sync)(
75		struct dc_context *ctx,
76		enum gpio_id id,
77		uint32_t en);
78	struct hw_gpio_pin *(*create_gsl)(
79		struct dc_context *ctx,
80		enum gpio_id id,
81		uint32_t en);
82
83	/* HW translation */
84	bool (*offset_to_id)(
85		uint32_t offset,
86		uint32_t mask,
87		enum gpio_id *id,
88		uint32_t *en);
89	bool (*id_to_offset)(
90		enum gpio_id id,
91		uint32_t en,
92		struct gpio_pin_info *info);
93};
94#endif
95
96#endif  /* __DAL_GPIO__ */
97