xref: /netbsd-src/sys/external/bsd/drm2/dist/drm/amd/display/dc/gpio/hw_factory.h (revision 41ec02673d281bbb3d38e6c78504ce6e30c228c1)
1 /*	$NetBSD: hw_factory.h,v 1.2 2021/12/18 23:45:04 riastradh Exp $	*/
2 
3 /*
4  * Copyright 2012-15 Advanced Micro Devices, Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors: AMD
25  *
26  */
27 
28 #ifndef __DAL_HW_FACTORY_H__
29 #define __DAL_HW_FACTORY_H__
30 
31 struct hw_gpio_pin;
32 struct hw_hpd;
33 struct hw_ddc;
34 struct hw_generic;
35 struct gpio;
36 
37 struct hw_factory {
38 	uint32_t number_of_pins[GPIO_ID_COUNT];
39 
40 	const struct hw_factory_funcs {
41 		void (*init_ddc_data)(
42 				struct hw_ddc **hw_ddc,
43 				struct dc_context *ctx,
44 				enum gpio_id id,
45 				uint32_t en);
46 		void (*init_generic)(
47 				struct hw_generic **hw_generic,
48 				struct dc_context *ctx,
49 				enum gpio_id id,
50 				uint32_t en);
51 		void (*init_hpd)(
52 				struct hw_hpd **hw_hpd,
53 				struct dc_context *ctx,
54 				enum gpio_id id,
55 				uint32_t en);
56 		struct hw_gpio_pin *(*get_hpd_pin)(
57 				struct gpio *gpio);
58 		struct hw_gpio_pin *(*get_ddc_pin)(
59 				struct gpio *gpio);
60 		struct hw_gpio_pin *(*get_generic_pin)(
61 				struct gpio *gpio);
62 		void (*define_hpd_registers)(
63 				struct hw_gpio_pin *pin,
64 				uint32_t en);
65 		void (*define_ddc_registers)(
66 				struct hw_gpio_pin *pin,
67 				uint32_t en);
68 		void (*define_generic_registers)(
69 				struct hw_gpio_pin *pin,
70 				uint32_t en);
71 	} *funcs;
72 };
73 
74 bool dal_hw_factory_init(
75 	struct hw_factory *factory,
76 	enum dce_version dce_version,
77 	enum dce_environment dce_environment);
78 
79 #endif
80