Home | History | Annotate | Line # | Download | only in pci
      1 /*	$$NetBSD: pwdog.c,v 1.10 2017/01/20 12:25:07 maya Exp $ */
      2 /*	$OpenBSD: pwdog.c,v 1.7 2010/04/08 00:23:53 tedu Exp $ */
      3 
      4 /*
      5  * Copyright (c) 2006, 2011 Marc Balmer <mbalmer (at) NetBSD.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 #include <sys/types.h>
     21 #include <sys/param.h>
     22 #include <sys/device.h>
     23 #include <sys/kernel.h>
     24 #include <sys/module.h>
     25 #include <sys/systm.h>
     26 
     27 #include <dev/pci/pcivar.h>
     28 #include <dev/pci/pcireg.h>
     29 #include <dev/pci/pcidevs.h>
     30 
     31 #include <dev/sysmon/sysmonvar.h>
     32 
     33 struct pwdog_softc {
     34 	device_t		sc_dev;
     35 
     36 	bus_space_tag_t		sc_iot;
     37 	bus_space_handle_t	sc_ioh;
     38 	bus_size_t		sc_iosize;
     39 
     40 	struct sysmon_wdog	sc_smw;
     41 	bool			sc_smw_valid;
     42 };
     43 
     44 /* registers */
     45 #define PWDOG_ACTIVATE	0
     46 #define PWDOG_DISABLE	1
     47 
     48 /* maximum timeout period in seconds */
     49 #define PWDOG_MAX_PERIOD	(12*60)	/* 12 minutes */
     50 
     51 static int pwdog_match(device_t, cfdata_t, void *);
     52 static void pwdog_attach(device_t, device_t, void *);
     53 static int pwdog_detach(device_t, int);
     54 static bool pwdog_suspend(device_t, const pmf_qual_t *);
     55 static bool pwdog_resume(device_t, const pmf_qual_t *);
     56 static int pwdog_setmode(struct sysmon_wdog *);
     57 static int pwdog_tickle(struct sysmon_wdog *);
     58 
     59 CFATTACH_DECL_NEW(
     60     pwdog,
     61     sizeof(struct pwdog_softc),
     62     pwdog_match,
     63     pwdog_attach,
     64     pwdog_detach,
     65     NULL
     66 );
     67 
     68 static int
     69 pwdog_match(device_t parent, cfdata_t match, void *aux)
     70 {
     71 	struct pci_attach_args *pa = (struct pci_attach_args *)aux;
     72 
     73 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_QUANCOM &&
     74 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_QUANCOM_PWDOG1)
     75 		return 1;
     76 	return 0;
     77 }
     78 
     79 void
     80 pwdog_attach(device_t parent, device_t self, void *aux)
     81 {
     82 	struct pwdog_softc *sc = device_private(self);
     83 	struct pci_attach_args *const pa = (struct pci_attach_args *)aux;
     84 	pcireg_t memtype;
     85 
     86 	aprint_naive("\n");
     87 	memtype = pci_mapreg_type(pa->pa_pc, pa->pa_tag, PCI_MAPREG_START);
     88 	if (pci_mapreg_map(pa, PCI_MAPREG_START, memtype, 0, &sc->sc_iot,
     89 	    &sc->sc_ioh, NULL, &sc->sc_iosize)) {
     90 		aprint_error("\n");
     91 		aprint_error_dev(self, "PCI %s region not found\n",
     92 		    memtype == PCI_MAPREG_TYPE_IO ? "I/O" : "memory");
     93 		return;
     94 	}
     95 	aprint_normal("\n");
     96 
     97 	sc->sc_dev = self;
     98 
     99 	if (!pmf_device_register(self, pwdog_suspend, pwdog_resume))
    100 		aprint_error_dev(self, "couldn't establish power handler\n");
    101 	bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_DISABLE, 0);
    102 
    103 	sc->sc_smw.smw_name = device_xname(self);
    104 	sc->sc_smw.smw_cookie = sc;
    105 	sc->sc_smw.smw_setmode = pwdog_setmode;
    106 	sc->sc_smw.smw_tickle = pwdog_tickle;
    107 	sc->sc_smw.smw_period = PWDOG_MAX_PERIOD;
    108 
    109 	if (sysmon_wdog_register(&sc->sc_smw))
    110 		aprint_error_dev(self, "couldn't register with sysmon\n");
    111 	else
    112 		sc->sc_smw_valid = true;
    113 }
    114 
    115 static int
    116 pwdog_detach(device_t self, int flags)
    117 {
    118 	struct pwdog_softc *sc = device_private(self);
    119 
    120 	/* XXX check flags & DETACH_FORCE (or DETACH_SHUTDOWN)? */
    121 	if (sc->sc_smw_valid) {
    122 		if ((sc->sc_smw.smw_mode & WDOG_MODE_MASK)
    123 		    != WDOG_MODE_DISARMED)
    124 			return EBUSY;
    125 
    126 		sysmon_wdog_unregister(&sc->sc_smw);
    127 		sc->sc_smw_valid = false;
    128 	}
    129 
    130 	pmf_device_deregister(self);
    131 
    132 	if (sc->sc_iosize)
    133 		bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
    134 	return 0;
    135 }
    136 
    137 static bool
    138 pwdog_resume(device_t self, const pmf_qual_t *qual)
    139 {
    140 	struct pwdog_softc *sc = device_private(self);
    141 
    142 	if (sc->sc_smw_valid == false)
    143 		return true;
    144 
    145 	/*
    146 	 * suspend is inhibited when the watchdog timer was armed,
    147 	 * so when we end up here, the watchdog is disabled; program the
    148 	 * hardware accordingly.
    149 	 */
    150 	bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_DISABLE, 0);
    151 	return true;
    152 }
    153 
    154 static bool
    155 pwdog_suspend(device_t self, const pmf_qual_t *qual)
    156 {
    157 	struct pwdog_softc *sc = device_private(self);
    158 
    159 	if (sc->sc_smw_valid == false)
    160 		return true;
    161 
    162 	if ((sc->sc_smw.smw_mode & WDOG_MODE_MASK) != WDOG_MODE_DISARMED)
    163 		return false;
    164 
    165 	return true;
    166 }
    167 
    168 static int
    169 pwdog_setmode(struct sysmon_wdog *smw)
    170 {
    171 	struct pwdog_softc *sc = smw->smw_cookie;
    172 
    173 	switch (smw->smw_mode & WDOG_MODE_MASK) {
    174 	case WDOG_MODE_DISARMED:
    175 		bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_DISABLE, 0);
    176 		break;
    177 	default:
    178 		/*
    179 		 * NB: the timer period set by the user is ignored
    180 		 * since the period can only be set in hardware.
    181 		 */
    182 		bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_ACTIVATE, 0);
    183 	}
    184 	return 0;
    185 }
    186 
    187 static int
    188 pwdog_tickle(struct sysmon_wdog *smw)
    189 {
    190 	struct pwdog_softc *sc = smw->smw_cookie;
    191 
    192 	bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_ACTIVATE, 0);
    193 	return 0;
    194 }
    195 
    196 MODULE(MODULE_CLASS_DRIVER, pwdog, "pci,sysmon_wdog");
    197 
    198 #ifdef _MODULE
    199 #include "ioconf.c"
    200 #endif
    201 
    202 static int
    203 pwdog_modcmd(modcmd_t cmd, void *opaque)
    204 {
    205 	int error;
    206 
    207 	error = 0;
    208 	switch (cmd) {
    209 	case MODULE_CMD_INIT:
    210 #ifdef _MODULE
    211 		error = config_init_component(cfdriver_ioconf_pwdog,
    212 		    cfattach_ioconf_pwdog, cfdata_ioconf_pwdog);
    213 		if (error)
    214 			aprint_error("%s: unable to init component\n",
    215 			    pwdog_cd.cd_name);
    216 #endif
    217 		break;
    218 	case MODULE_CMD_FINI:
    219 #ifdef _MODULE
    220 		config_fini_component(cfdriver_ioconf_pwdog,
    221 		    cfattach_ioconf_pwdog, cfdata_ioconf_pwdog);
    222 #endif
    223 		break;
    224 	default:
    225 		error = ENOTTY;
    226 	}
    227 	return error;
    228 }
    229