gpiobusvar.h revision 279761 
1/*-
2 * Copyright (c) 2009 Oleksandr Tymoshenko <gonzo@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/dev/gpio/gpiobusvar.h 279761 2015-03-08 00:47:50Z loos $
27 *
28 */
29
30#ifndef	__GPIOBUS_H__
31#define	__GPIOBUS_H__
32
33#include "opt_platform.h"
34
35#include <sys/lock.h>
36#include <sys/mutex.h>
37#include <sys/rman.h>
38
39#ifdef FDT
40#include <dev/ofw/ofw_bus_subr.h>
41#endif
42
43#include "gpio_if.h"
44
45#ifdef FDT
46#define	GPIOBUS_IVAR(d) (struct gpiobus_ivar *)				\
47	&((struct ofw_gpiobus_devinfo *)device_get_ivars(d))->opd_dinfo
48#else
49#define	GPIOBUS_IVAR(d) (struct gpiobus_ivar *) device_get_ivars(d)
50#endif
51#define	GPIOBUS_SOFTC(d) (struct gpiobus_softc *) device_get_softc(d)
52#define	GPIOBUS_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
53#define	GPIOBUS_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
54#define	GPIOBUS_LOCK_INIT(_sc) mtx_init(&_sc->sc_mtx,			\
55	    device_get_nameunit(_sc->sc_dev), "gpiobus", MTX_DEF)
56#define	GPIOBUS_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx)
57#define	GPIOBUS_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED)
58#define	GPIOBUS_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED)
59
60#define	GPIOBUS_WAIT		1
61#define	GPIOBUS_DONTWAIT	2
62
63struct gpiobus_pin_data
64{
65	int		mapped;		/* pin is mapped/reserved. */
66	char		*name;		/* pin name. */
67};
68
69struct gpiobus_softc
70{
71	struct mtx	sc_mtx;		/* bus mutex */
72	struct rman	sc_intr_rman;	/* isr resources */
73	device_t	sc_busdev;	/* bus device */
74	device_t	sc_owner;	/* bus owner */
75	device_t	sc_dev;		/* driver device */
76	int		sc_npins;	/* total pins on bus */
77	struct gpiobus_pin_data	*sc_pins; /* pin data */
78};
79
80struct gpiobus_pin
81{
82	device_t	dev;	/* gpio device */
83	uint32_t	flags;	/* pin flags */
84	uint32_t	pin;	/* pin number */
85};
86
87struct gpiobus_ivar
88{
89	struct resource_list	rl;	/* isr resource list */
90	uint32_t	npins;	/* pins total */
91	uint32_t	*flags;	/* pins flags */
92	uint32_t	*pins;	/* pins map */
93};
94
95#ifdef FDT
96struct ofw_gpiobus_devinfo {
97	struct gpiobus_ivar	opd_dinfo;
98	struct ofw_bus_devinfo	opd_obdinfo;
99};
100
101static __inline int
102gpio_map_gpios(device_t bus, phandle_t dev, phandle_t gparent, int gcells,
103    pcell_t *gpios, uint32_t *pin, uint32_t *flags)
104{
105	return (GPIO_MAP_GPIOS(bus, dev, gparent, gcells, gpios, pin, flags));
106}
107
108device_t ofw_gpiobus_add_fdt_child(device_t, const char *, phandle_t);
109int ofw_gpiobus_parse_gpios(device_t, char *, struct gpiobus_pin **);
110void ofw_gpiobus_register_provider(device_t);
111void ofw_gpiobus_unregister_provider(device_t);
112#endif
113int gpio_check_flags(uint32_t, uint32_t);
114device_t gpiobus_attach_bus(device_t);
115int gpiobus_detach_bus(device_t);
116int gpiobus_init_softc(device_t);
117int gpiobus_alloc_ivars(struct gpiobus_ivar *);
118void gpiobus_free_ivars(struct gpiobus_ivar *);
119int gpiobus_map_pin(device_t, uint32_t);
120
121extern driver_t gpiobus_driver;
122
123#endif	/* __GPIOBUS_H__ */
124