xref: /netbsd-src/sys/dev/pci/pwdog.c (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1 /*	$$NetBSD: pwdog.c,v 1.8 2015/04/23 23:23:01 pgoyette 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@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 	memtype = pci_mapreg_type(pa->pa_pc, pa->pa_tag, PCI_MAPREG_START);
87 	if (pci_mapreg_map(pa, PCI_MAPREG_START, memtype, 0, &sc->sc_iot,
88 	    &sc->sc_ioh, NULL, &sc->sc_iosize)) {
89 		aprint_error("\n");
90 		aprint_error_dev(self, "PCI %s region not found\n",
91 		    memtype == PCI_MAPREG_TYPE_IO ? "I/O" : "memory");
92 		return;
93 	}
94 	printf("\n");
95 
96 	sc->sc_dev = self;
97 
98 	pmf_device_register(self, pwdog_suspend, pwdog_resume);
99 	bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_DISABLE, 0);
100 
101 	sc->sc_smw.smw_name = device_xname(self);
102 	sc->sc_smw.smw_cookie = sc;
103 	sc->sc_smw.smw_setmode = pwdog_setmode;
104 	sc->sc_smw.smw_tickle = pwdog_tickle;
105 	sc->sc_smw.smw_period = PWDOG_MAX_PERIOD;
106 
107 	if (sysmon_wdog_register(&sc->sc_smw))
108 		aprint_error_dev(self, "couldn't register with sysmon\n");
109 	else
110 		sc->sc_smw_valid = true;
111 }
112 
113 static int
114 pwdog_detach(device_t self, int flags)
115 {
116 	struct pwdog_softc *sc = device_private(self);
117 
118 	/* XXX check flags & DETACH_FORCE (or DETACH_SHUTDOWN)? */
119 	if (sc->sc_smw_valid) {
120 		if ((sc->sc_smw.smw_mode & WDOG_MODE_MASK)
121 		    != WDOG_MODE_DISARMED)
122 			return EBUSY;
123 
124 		sysmon_wdog_unregister(&sc->sc_smw);
125 		sc->sc_smw_valid = false;
126 	}
127 
128 	pmf_device_deregister(self);
129 
130 	if (sc->sc_iosize)
131 		bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
132 	return 0;
133 }
134 
135 static bool
136 pwdog_resume(device_t self, const pmf_qual_t *qual)
137 {
138 	struct pwdog_softc *sc = device_private(self);
139 
140 	if (sc->sc_smw_valid == false)
141 		return true;
142 
143 	/*
144 	 * suspend is inhibited when the watchdog timer was armed,
145 	 * so when we end up here, the watchdog is disabled; program the
146 	 * hardware accordingly.
147 	 */
148 	bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_DISABLE, 0);
149 	return true;
150 }
151 
152 static bool
153 pwdog_suspend(device_t self, const pmf_qual_t *qual)
154 {
155 	struct pwdog_softc *sc = device_private(self);
156 
157 	if (sc->sc_smw_valid == false)
158 		return true;
159 
160 	if ((sc->sc_smw.smw_mode & WDOG_MODE_MASK) != WDOG_MODE_DISARMED)
161 		return false;
162 
163 	return true;
164 }
165 
166 static int
167 pwdog_setmode(struct sysmon_wdog *smw)
168 {
169 	struct pwdog_softc *sc = smw->smw_cookie;
170 
171 	switch (smw->smw_mode & WDOG_MODE_MASK) {
172 	case WDOG_MODE_DISARMED:
173 		bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_DISABLE, 0);
174 		break;
175 	default:
176 		/*
177 		 * NB: the timer period set by the user is ignored
178 		 * since the period can only be set in hardware.
179 		 */
180 		bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_ACTIVATE, 0);
181 	}
182 	return 0;
183 }
184 
185 static int
186 pwdog_tickle(struct sysmon_wdog *smw)
187 {
188 	struct pwdog_softc *sc = smw->smw_cookie;
189 
190 	bus_space_write_1(sc->sc_iot, sc->sc_ioh, PWDOG_ACTIVATE, 0);
191 	return 0;
192 }
193 
194 MODULE(MODULE_CLASS_DRIVER, pwdog, "pci,sysmon_wdog");
195 
196 #ifdef _MODULE
197 #include "ioconf.c"
198 #endif
199 
200 static int
201 pwdog_modcmd(modcmd_t cmd, void *opaque)
202 {
203 	int error;
204 
205 	error = 0;
206 	switch (cmd) {
207 	case MODULE_CMD_INIT:
208 #ifdef _MODULE
209 		error = config_init_component(cfdriver_ioconf_pwdog,
210 		    cfattach_ioconf_pwdog, cfdata_ioconf_pwdog);
211 		if (error)
212 			aprint_error("%s: unable to init component\n",
213 			    pwdog_cd.cd_name);
214 #endif
215 		break;
216 	case MODULE_CMD_FINI:
217 #ifdef _MODULE
218 		config_fini_component(cfdriver_ioconf_pwdog,
219 		    cfattach_ioconf_pwdog, cfdata_ioconf_pwdog);
220 #endif
221 		break;
222 	default:
223 		error = ENOTTY;
224 	}
225 	return error;
226 }
227