xref: /openbsd-src/sys/dev/ofw/ofw_gpio.h (revision a436d6bbe515c896c93526df23a13a15df4158f3)
1 /*	$OpenBSD: ofw_gpio.h,v 1.6 2025/01/09 19:38:13 kettenis Exp $	*/
2 /*
3  * Copyright (c) 2016 Mark Kettenis
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #ifndef _DEV_OFW_GPIO_H_
19 #define _DEV_OFW_GPIO_H_
20 
21 #define GPIO_ACTIVE_HIGH	(0 << 0)
22 #define GPIO_ACTIVE_LOW		(1 << 0)
23 #define GPIO_PUSH_PULL		(0 << 1)
24 #define GPIO_SINGLE_ENDED	(1 << 1)
25 #define GPIO_LINE_OPEN_SOURCE	(0 << 2)
26 #define GPIO_LINE_OPEN_DRAIN	(1 << 2)
27 
28 #define GPIO_OPEN_DRAIN		(GPIO_SINGLE_ENDED | GPIO_LINE_OPEN_DRAIN)
29 #define GPIO_OPEN_SOURCE	(GPIO_SINGLE_ENDED | GPIO_LINE_OPEN_SOURCE)
30 
31 struct gpio_controller {
32 	int	gc_node;
33 	void	*gc_cookie;
34 	void	(*gc_config_pin)(void *, uint32_t *, int);
35 	int	(*gc_get_pin)(void *, uint32_t *);
36 	void	(*gc_set_pin)(void *, uint32_t *, int);
37 	void	*(*gc_intr_establish)(void *, uint32_t *, int,
38 		    struct cpu_info *, int (*)(void *), void *, char *);
39 
40 	LIST_ENTRY(gpio_controller) gc_list;
41 	uint32_t gc_phandle;
42 	uint32_t gc_cells;
43 };
44 
45 void	gpio_controller_register(struct gpio_controller *);
46 
47 #define GPIO_CONFIG_INPUT	0x0000
48 #define GPIO_CONFIG_OUTPUT	0x0001
49 #define GPIO_CONFIG_PULL_UP	0x0010
50 #define GPIO_CONFIG_PULL_DOWN	0x0020
51 #define GPIO_CONFIG_MD0		0x1000
52 #define GPIO_CONFIG_MD1		0x2000
53 #define GPIO_CONFIG_MD2		0x4000
54 #define GPIO_CONFIG_MD3		0x8000
55 void	gpio_controller_config_pin(uint32_t *, int);
56 
57 int	gpio_controller_get_pin(uint32_t *);
58 void	gpio_controller_set_pin(uint32_t *, int);
59 uint32_t *gpio_controller_next_pin(uint32_t *);
60 
61 void	*gpio_controller_intr_establish(uint32_t *, int, struct cpu_info *,
62 	    int (*)(void *), void *, char *);
63 void	gpio_controller_intr_disestablish(void *);
64 
65 #endif /* _DEV_OFW_GPIO_H_ */
66