Home | History | Annotate | Line # | Download | only in gpio
gpiobutton.c revision 1.2.2.2
      1  1.2.2.2  skrll /* $NetBSD: gpiobutton.c,v 1.2.2.2 2015/06/06 14:40:07 skrll Exp $ */
      2  1.2.2.2  skrll 
      3  1.2.2.2  skrll /*-
      4  1.2.2.2  skrll  * Copyright (c) 2015 Jared D. McNeill <jmcneill (at) invisible.ca>
      5  1.2.2.2  skrll  * All rights reserved.
      6  1.2.2.2  skrll  *
      7  1.2.2.2  skrll  * Redistribution and use in source and binary forms, with or without
      8  1.2.2.2  skrll  * modification, are permitted provided that the following conditions
      9  1.2.2.2  skrll  * are met:
     10  1.2.2.2  skrll  * 1. Redistributions of source code must retain the above copyright
     11  1.2.2.2  skrll  *    notice, this list of conditions and the following disclaimer.
     12  1.2.2.2  skrll  * 2. Redistributions in binary form must reproduce the above copyright
     13  1.2.2.2  skrll  *    notice, this list of conditions and the following disclaimer in the
     14  1.2.2.2  skrll  *    documentation and/or other materials provided with the distribution.
     15  1.2.2.2  skrll  *
     16  1.2.2.2  skrll  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     17  1.2.2.2  skrll  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     18  1.2.2.2  skrll  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     19  1.2.2.2  skrll  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     20  1.2.2.2  skrll  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     21  1.2.2.2  skrll  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     22  1.2.2.2  skrll  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
     23  1.2.2.2  skrll  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
     24  1.2.2.2  skrll  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     25  1.2.2.2  skrll  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     26  1.2.2.2  skrll  * SUCH DAMAGE.
     27  1.2.2.2  skrll  */
     28  1.2.2.2  skrll 
     29  1.2.2.2  skrll #include "locators.h"
     30  1.2.2.2  skrll 
     31  1.2.2.2  skrll #include <sys/cdefs.h>
     32  1.2.2.2  skrll __KERNEL_RCSID(0, "$NetBSD: gpiobutton.c,v 1.2.2.2 2015/06/06 14:40:07 skrll Exp $");
     33  1.2.2.2  skrll 
     34  1.2.2.2  skrll #include <sys/param.h>
     35  1.2.2.2  skrll #include <sys/bus.h>
     36  1.2.2.2  skrll #include <sys/device.h>
     37  1.2.2.2  skrll #include <sys/intr.h>
     38  1.2.2.2  skrll #include <sys/systm.h>
     39  1.2.2.2  skrll #include <sys/kernel.h>
     40  1.2.2.2  skrll #include <sys/workqueue.h>
     41  1.2.2.2  skrll #include <sys/gpio.h>
     42  1.2.2.2  skrll 
     43  1.2.2.2  skrll #include <dev/sysmon/sysmonvar.h>
     44  1.2.2.2  skrll 
     45  1.2.2.2  skrll #include <dev/gpio/gpiovar.h>
     46  1.2.2.2  skrll 
     47  1.2.2.2  skrll #define GPIOBUTTON_POLL_INTERVAL	mstohz(200)
     48  1.2.2.2  skrll 
     49  1.2.2.2  skrll #define GPIOBUTTON_POLARITY_MASK	0x80
     50  1.2.2.2  skrll #define GPIOBUTTON_POLARITY_ACTIVE_LOW	0
     51  1.2.2.2  skrll #define GPIOBUTTON_POLARITY_ACTIVE_HIGH	1
     52  1.2.2.2  skrll #define GPIOBUTTON_TYPE_MASK		0x0f
     53  1.2.2.2  skrll #define GPIOBUTTON_TYPE_POWER		1
     54  1.2.2.2  skrll #define GPIOBUTTON_TYPE_SLEEP		2
     55  1.2.2.2  skrll 
     56  1.2.2.2  skrll static int	gpiobutton_match(device_t, cfdata_t, void *);
     57  1.2.2.2  skrll static void	gpiobutton_attach(device_t, device_t, void *);
     58  1.2.2.2  skrll 
     59  1.2.2.2  skrll struct gpiobutton_softc {
     60  1.2.2.2  skrll 	device_t		sc_dev;
     61  1.2.2.2  skrll 	void			*sc_gpio;
     62  1.2.2.2  skrll 	struct gpio_pinmap	sc_map;
     63  1.2.2.2  skrll 	int			sc_pinmap[1];
     64  1.2.2.2  skrll 	bool			sc_active_high;
     65  1.2.2.2  skrll 
     66  1.2.2.2  skrll 	struct sysmon_pswitch	sc_smpsw;
     67  1.2.2.2  skrll 
     68  1.2.2.2  skrll 	struct workqueue	*sc_wq;
     69  1.2.2.2  skrll 	callout_t		sc_tick;
     70  1.2.2.2  skrll 	bool			sc_state;
     71  1.2.2.2  skrll 	struct work		sc_work;
     72  1.2.2.2  skrll };
     73  1.2.2.2  skrll 
     74  1.2.2.2  skrll static bool	gpiobutton_is_pressed(struct gpiobutton_softc *);
     75  1.2.2.2  skrll static void	gpiobutton_tick(void *);
     76  1.2.2.2  skrll static void	gpiobutton_task(struct work *, void *);
     77  1.2.2.2  skrll 
     78  1.2.2.2  skrll CFATTACH_DECL_NEW(gpiobutton, sizeof(struct gpiobutton_softc),
     79  1.2.2.2  skrll 	gpiobutton_match, gpiobutton_attach, NULL, NULL);
     80  1.2.2.2  skrll 
     81  1.2.2.2  skrll static int
     82  1.2.2.2  skrll gpiobutton_match(device_t parent, cfdata_t cf, void *aux)
     83  1.2.2.2  skrll {
     84  1.2.2.2  skrll 	struct gpio_attach_args * const ga = aux;
     85  1.2.2.2  skrll 
     86  1.2.2.2  skrll 	if (strcmp(ga->ga_dvname, cf->cf_name) != 0)
     87  1.2.2.2  skrll 		return 0;
     88  1.2.2.2  skrll 
     89  1.2.2.2  skrll 	if (ga->ga_offset == -1 || gpio_npins(ga->ga_mask) != 1)
     90  1.2.2.2  skrll 		return 0;
     91  1.2.2.2  skrll 
     92  1.2.2.2  skrll 	const u_int type = __SHIFTOUT(ga->ga_flags, GPIOBUTTON_TYPE_MASK);
     93  1.2.2.2  skrll 
     94  1.2.2.2  skrll 	switch (type) {
     95  1.2.2.2  skrll 	case GPIOBUTTON_TYPE_POWER:
     96  1.2.2.2  skrll 	case GPIOBUTTON_TYPE_SLEEP:
     97  1.2.2.2  skrll 		return 1;
     98  1.2.2.2  skrll 	default:
     99  1.2.2.2  skrll 		return 0;
    100  1.2.2.2  skrll 	}
    101  1.2.2.2  skrll }
    102  1.2.2.2  skrll 
    103  1.2.2.2  skrll static void
    104  1.2.2.2  skrll gpiobutton_attach(device_t parent, device_t self, void *aux)
    105  1.2.2.2  skrll {
    106  1.2.2.2  skrll 	struct gpiobutton_softc * const sc = device_private(self);
    107  1.2.2.2  skrll 	struct gpio_attach_args * const ga = aux;
    108  1.2.2.2  skrll 	const char *desc;
    109  1.2.2.2  skrll 	int caps, error;
    110  1.2.2.2  skrll 
    111  1.2.2.2  skrll 	const u_int type = __SHIFTOUT(ga->ga_flags, GPIOBUTTON_TYPE_MASK);
    112  1.2.2.2  skrll 	const u_int pol = __SHIFTOUT(ga->ga_flags, GPIOBUTTON_POLARITY_MASK);
    113  1.2.2.2  skrll 
    114  1.2.2.2  skrll 	sc->sc_dev = self;
    115  1.2.2.2  skrll 	sc->sc_gpio = ga->ga_gpio;
    116  1.2.2.2  skrll 	sc->sc_map.pm_map = sc->sc_pinmap;
    117  1.2.2.2  skrll 	if (gpio_pin_map(sc->sc_gpio, ga->ga_offset, ga->ga_mask,
    118  1.2.2.2  skrll 	    &sc->sc_map)) {
    119  1.2.2.2  skrll 		aprint_error(": couldn't map pins\n");
    120  1.2.2.2  skrll 		return;
    121  1.2.2.2  skrll 	}
    122  1.2.2.2  skrll 	sc->sc_active_high = pol == GPIOBUTTON_POLARITY_ACTIVE_HIGH;
    123  1.2.2.2  skrll 
    124  1.2.2.2  skrll 	caps = gpio_pin_caps(sc->sc_gpio, &sc->sc_map, 0);
    125  1.2.2.2  skrll 	if ((caps & GPIO_PIN_INPUT) == 0) {
    126  1.2.2.2  skrll 		aprint_error(": pin is not an input pin\n");
    127  1.2.2.2  skrll 		return;
    128  1.2.2.2  skrll 	}
    129  1.2.2.2  skrll 
    130  1.2.2.2  skrll 	gpio_pin_ctl(sc->sc_gpio, &sc->sc_map, 0, GPIO_PIN_INPUT);
    131  1.2.2.2  skrll 
    132  1.2.2.2  skrll 	sc->sc_smpsw.smpsw_name = device_xname(self);
    133  1.2.2.2  skrll 	switch (type) {
    134  1.2.2.2  skrll 	case GPIOBUTTON_TYPE_POWER:
    135  1.2.2.2  skrll 		sc->sc_smpsw.smpsw_type = PSWITCH_TYPE_POWER;
    136  1.2.2.2  skrll 		desc = "Power";
    137  1.2.2.2  skrll 		break;
    138  1.2.2.2  skrll 	case GPIOBUTTON_TYPE_SLEEP:
    139  1.2.2.2  skrll 		sc->sc_smpsw.smpsw_type = PSWITCH_TYPE_SLEEP;
    140  1.2.2.2  skrll 		desc = "Sleep";
    141  1.2.2.2  skrll 		break;
    142  1.2.2.2  skrll 	default:
    143  1.2.2.2  skrll 		panic("%s: impossible", __func__);
    144  1.2.2.2  skrll 	}
    145  1.2.2.2  skrll 
    146  1.2.2.2  skrll 	aprint_naive("\n");
    147  1.2.2.2  skrll 	aprint_normal(": %s button\n", desc);
    148  1.2.2.2  skrll 
    149  1.2.2.2  skrll 	sysmon_pswitch_register(&sc->sc_smpsw);
    150  1.2.2.2  skrll 
    151  1.2.2.2  skrll 	callout_init(&sc->sc_tick, CALLOUT_MPSAFE);
    152  1.2.2.2  skrll 	callout_setfunc(&sc->sc_tick, gpiobutton_tick, sc);
    153  1.2.2.2  skrll 
    154  1.2.2.2  skrll 	error = workqueue_create(&sc->sc_wq, device_xname(self),
    155  1.2.2.2  skrll 	    gpiobutton_task, sc, PRI_NONE, IPL_VM, WQ_MPSAFE);
    156  1.2.2.2  skrll 	if (error) {
    157  1.2.2.2  skrll 		aprint_error_dev(self, "couldn't create workqueue: %d\n",
    158  1.2.2.2  skrll 		    error);
    159  1.2.2.2  skrll 		return;
    160  1.2.2.2  skrll 	}
    161  1.2.2.2  skrll 
    162  1.2.2.2  skrll 	gpiobutton_task(&sc->sc_work, sc);
    163  1.2.2.2  skrll }
    164  1.2.2.2  skrll 
    165  1.2.2.2  skrll static bool
    166  1.2.2.2  skrll gpiobutton_is_pressed(struct gpiobutton_softc *sc)
    167  1.2.2.2  skrll {
    168  1.2.2.2  skrll 	int val;
    169  1.2.2.2  skrll 
    170  1.2.2.2  skrll 	val = gpio_pin_read(sc->sc_gpio, &sc->sc_map, 0);
    171  1.2.2.2  skrll 	if (!sc->sc_active_high)
    172  1.2.2.2  skrll 		val = !val;
    173  1.2.2.2  skrll 
    174  1.2.2.2  skrll 	return val;
    175  1.2.2.2  skrll }
    176  1.2.2.2  skrll 
    177  1.2.2.2  skrll static void
    178  1.2.2.2  skrll gpiobutton_tick(void *priv)
    179  1.2.2.2  skrll {
    180  1.2.2.2  skrll 	struct gpiobutton_softc * const sc = priv;
    181  1.2.2.2  skrll 
    182  1.2.2.2  skrll 	workqueue_enqueue(sc->sc_wq, &sc->sc_work, NULL);
    183  1.2.2.2  skrll }
    184  1.2.2.2  skrll 
    185  1.2.2.2  skrll static void
    186  1.2.2.2  skrll gpiobutton_task(struct work *wk, void *priv)
    187  1.2.2.2  skrll {
    188  1.2.2.2  skrll 	struct gpiobutton_softc * const sc = priv;
    189  1.2.2.2  skrll 
    190  1.2.2.2  skrll 	const bool new_state = gpiobutton_is_pressed(sc);
    191  1.2.2.2  skrll 	if (new_state != sc->sc_state) {
    192  1.2.2.2  skrll 		aprint_debug_dev(sc->sc_dev, "button pressed\n");
    193  1.2.2.2  skrll 		sysmon_pswitch_event(&sc->sc_smpsw, PSWITCH_EVENT_PRESSED);
    194  1.2.2.2  skrll 		sc->sc_state = new_state;
    195  1.2.2.2  skrll 	}
    196  1.2.2.2  skrll 
    197  1.2.2.2  skrll 	callout_schedule(&sc->sc_tick, GPIOBUTTON_POLL_INTERVAL);
    198  1.2.2.2  skrll }
    199