xref: /dflybsd-src/sys/dev/drm/amd/display/dc/gpio/gpio_service.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_SERVICE_H__
27*b843c749SSergey Zigachev #define __DAL_GPIO_SERVICE_H__
28*b843c749SSergey Zigachev 
29*b843c749SSergey Zigachev struct hw_translate;
30*b843c749SSergey Zigachev struct hw_factory;
31*b843c749SSergey Zigachev 
32*b843c749SSergey Zigachev struct gpio_service {
33*b843c749SSergey Zigachev 	struct dc_context *ctx;
34*b843c749SSergey Zigachev 	struct hw_translate translate;
35*b843c749SSergey Zigachev 	struct hw_factory factory;
36*b843c749SSergey Zigachev 	/*
37*b843c749SSergey Zigachev 	 * @brief
38*b843c749SSergey Zigachev 	 * Business storage.
39*b843c749SSergey Zigachev 	 * For each member of 'enum gpio_id',
40*b843c749SSergey Zigachev 	 * store array of bits (packed into uint32_t slots),
41*b843c749SSergey Zigachev 	 * index individual bit by 'en' value */
42*b843c749SSergey Zigachev 	uint32_t *busyness[GPIO_ID_COUNT];
43*b843c749SSergey Zigachev };
44*b843c749SSergey Zigachev 
45*b843c749SSergey Zigachev enum gpio_result dal_gpio_service_open(
46*b843c749SSergey Zigachev 	struct gpio_service *service,
47*b843c749SSergey Zigachev 	enum gpio_id id,
48*b843c749SSergey Zigachev 	uint32_t en,
49*b843c749SSergey Zigachev 	enum gpio_mode mode,
50*b843c749SSergey Zigachev 	struct hw_gpio_pin **ptr);
51*b843c749SSergey Zigachev 
52*b843c749SSergey Zigachev void dal_gpio_service_close(
53*b843c749SSergey Zigachev 	struct gpio_service *service,
54*b843c749SSergey Zigachev 	struct hw_gpio_pin **ptr);
55*b843c749SSergey Zigachev 
56*b843c749SSergey Zigachev #endif
57