gpiovar.h revision 1.13 
1/* $NetBSD: gpiovar.h,v 1.13 2011/08/31 12:20:35 mbalmer Exp $ */
2/*	$OpenBSD: gpiovar.h,v 1.3 2006/01/14 12:33:49 grange Exp $	*/
3
4/*
5 * Copyright (c) 2004, 2006 Alexander Yurchenko <grange@openbsd.org>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19
20#ifndef _DEV_GPIO_GPIOVAR_H_
21#define _DEV_GPIO_GPIOVAR_H_
22
23#include <sys/device.h>
24
25/* GPIO controller description */
26typedef struct gpio_chipset_tag {
27	void	*gp_cookie;
28
29	int	(*gp_gc_open)(void *, device_t);
30	void    (*gp_gc_close)(void *, device_t);
31	int	(*gp_pin_read)(void *, int);
32	void	(*gp_pin_write)(void *, int, int);
33	void	(*gp_pin_ctl)(void *, int, int);
34} *gpio_chipset_tag_t;
35
36/* GPIO pin description */
37typedef struct gpio_pin {
38	int			pin_num;	/* number */
39	int			pin_caps;	/* capabilities */
40	int			pin_flags;	/* current configuration */
41	int			pin_state;	/* current state */
42	int			pin_mapped;	/* is mapped */
43	callout_t		pin_pulse;	/* for pulsing */
44	int			pin_ticks_on;	/* "on" period */
45	int			pin_ticks_off;	/* "off" period */
46	gpio_chipset_tag_t	pin_gc;		/* reference the controller */
47} gpio_pin_t;
48
49/* Attach GPIO framework to the controller */
50struct gpiobus_attach_args {
51	gpio_chipset_tag_t	 gba_gc;	/* underlying controller */
52	gpio_pin_t		*gba_pins;	/* pins array */
53	int			 gba_npins;	/* total number of pins */
54};
55
56int gpiobus_print(void *, const char *);
57
58/* GPIO framework private methods */
59#define gpiobus_open(gc, dev) \
60    ((gc)->gp_gc_open ? ((gc)->gp_gc_open((gc)->gp_cookie, dev)) : 0)
61#define gpiobus_close(gc, dev) \
62    ((gc)->gp_gc_close ? ((gc)->gp_gc_close((gc)->gp_cookie, dev)), 1 : 0)
63#define gpiobus_pin_read(gc, pin) \
64    ((gc)->gp_pin_read((gc)->gp_cookie, (pin)))
65#define gpiobus_pin_write(gc, pin, value) \
66    ((gc)->gp_pin_write((gc)->gp_cookie, (pin), (value)))
67#define gpiobus_pin_ctl(gc, pin, flags) \
68    ((gc)->gp_pin_ctl((gc)->gp_cookie, (pin), (flags)))
69
70/* Attach devices connected to the GPIO pins */
71struct gpio_attach_args {
72	void		*ga_gpio;
73	int		 ga_offset;
74	uint32_t	 ga_mask;
75	char		*ga_dvname;
76};
77
78/* GPIO pin map */
79struct gpio_pinmap {
80	int		*pm_map;		/* pin map */
81	int		 pm_size;		/* map size */
82};
83
84struct gpio_dev {
85	device_t		sc_dev;	/* the gpio device */
86	LIST_ENTRY(gpio_dev)	sc_next;
87};
88
89struct gpio_name {
90	char			gp_name[GPIOMAXNAME];
91	int			gp_pin;
92	LIST_ENTRY(gpio_name)	gp_next;
93};
94
95int	gpio_pin_can_map(void *, int, uint32_t);
96int	gpio_pin_map(void *, int, uint32_t, struct gpio_pinmap *);
97void	gpio_pin_unmap(void *, struct gpio_pinmap *);
98int	gpio_pin_read(void *, struct gpio_pinmap *, int);
99void	gpio_pin_write(void *, struct gpio_pinmap *, int, int);
100void	gpio_pin_ctl(void *, struct gpio_pinmap *, int, int);
101int	gpio_pin_caps(void *, struct gpio_pinmap *, int);
102int	gpio_npins(uint32_t);
103
104int	gpio_lock(void *);
105void	gpio_unlock(void *);
106
107#endif	/* !_DEV_GPIO_GPIOVAR_H_ */
108