70c0cd0e63baef8b62533b1b2406999267c4b590
[dragonfly.git] / sys / dev / powermng / wbsio / wbsio.c
1 /*      $NetBSD: wbsio.c,v 1.1 2010/02/21 05:16:29 cnst Exp $   */
2 /*      $OpenBSD: wbsio.c,v 1.5 2009/03/29 21:53:52 sthen Exp $ */
3 /*
4  * Copyright (c) 2008 Mark Kettenis <kettenis@openbsd.org>
5  * Copyright (c) 2010 Constantine A. Murenin <cnst++@dragonflybsd.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 /*
21  * Winbond LPC Super I/O driver.
22  */
23
24 #include <sys/param.h>
25 #include <sys/bus.h>
26 #include <sys/kernel.h>
27 #include <sys/module.h>
28 #include <sys/rman.h>
29 #include <sys/systm.h>
30
31 #include <bus/isa/isavar.h>
32
33 /* ISA bus registers */
34 #define WBSIO_INDEX             0x00    /* Configuration Index Register */
35 #define WBSIO_DATA              0x01    /* Configuration Data Register */
36
37 #define WBSIO_IOSIZE            0x02    /* ISA I/O space size */
38
39 #define WBSIO_CONF_EN_MAGIC     0x87    /* enable configuration mode */
40 #define WBSIO_CONF_DS_MAGIC     0xaa    /* disable configuration mode */
41
42 /* Configuration Space Registers */
43 #define WBSIO_LDN               0x07    /* Logical Device Number */
44 #define WBSIO_ID                0x20    /* Device ID */
45 #define WBSIO_REV               0x21    /* Device Revision */
46
47 #define WBSIO_ID_W83627HF       0x52
48 #define WBSIO_ID_W83627THF      0x82
49 #define WBSIO_ID_W83627EHF      0x88
50 #define WBSIO_ID_W83627DHG      0xa0
51 #define WBSIO_ID_W83627SF       0x59
52 #define WBSIO_ID_W83637HF       0x70
53 #define WBSIO_ID_W83667HG       0xa5
54 #define WBSIO_ID_W83687THF      0x85
55 #define WBSIO_ID_W83697HF       0x60
56
57 /* Logical Device Number (LDN) Assignments */
58 #define WBSIO_LDN_HM            0x0b
59
60 /* Hardware Monitor Control Registers (LDN B) */
61 #define WBSIO_HM_ADDR_MSB       0x60    /* Address [15:8] */
62 #define WBSIO_HM_ADDR_LSB       0x61    /* Address [7:0] */
63
64 struct wbsio_softc {
65         struct device           *sc_dev;
66
67         struct resource         *sc_iores;
68         int                     sc_iorid;
69
70         bus_space_tag_t         sc_iot;
71         bus_space_handle_t      sc_ioh;
72 };
73
74 static void     wbsio_identify(driver_t *, struct device *);
75 static int      wbsio_probe(struct device *);
76 static int      wbsio_attach(struct device *);
77 static int      wbsio_detach(struct device *);
78
79 static device_method_t wbsio_methods[] = {
80         DEVMETHOD(device_identify,      wbsio_identify),
81         DEVMETHOD(device_probe,         wbsio_probe),
82         DEVMETHOD(device_attach,        wbsio_attach),
83         DEVMETHOD(device_detach,        wbsio_detach),
84
85         { NULL, NULL}
86 };
87
88 static driver_t wbsio_driver = {
89         "wbsio",
90         wbsio_methods,
91         sizeof(struct wbsio_softc)
92 };
93
94 static devclass_t wbsio_devclass;
95
96 DRIVER_MODULE(wbsio, isa, wbsio_driver, wbsio_devclass, NULL, NULL);
97
98
99 static __inline void
100 wbsio_conf_enable(bus_space_tag_t iot, bus_space_handle_t ioh)
101 {
102         bus_space_write_1(iot, ioh, WBSIO_INDEX, WBSIO_CONF_EN_MAGIC);
103         bus_space_write_1(iot, ioh, WBSIO_INDEX, WBSIO_CONF_EN_MAGIC);
104 }
105
106 static __inline void
107 wbsio_conf_disable(bus_space_tag_t iot, bus_space_handle_t ioh)
108 {
109         bus_space_write_1(iot, ioh, WBSIO_INDEX, WBSIO_CONF_DS_MAGIC);
110 }
111
112 static __inline u_int8_t
113 wbsio_conf_read(bus_space_tag_t iot, bus_space_handle_t ioh, u_int8_t index)
114 {
115         bus_space_write_1(iot, ioh, WBSIO_INDEX, index);
116         return (bus_space_read_1(iot, ioh, WBSIO_DATA));
117 }
118
119 static __inline void
120 wbsio_conf_write(bus_space_tag_t iot, bus_space_handle_t ioh, u_int8_t index,
121     u_int8_t data)
122 {
123         bus_space_write_1(iot, ioh, WBSIO_INDEX, index);
124         bus_space_write_1(iot, ioh, WBSIO_DATA, data);
125 }
126
127 static void
128 wbsio_identify(driver_t *driver, struct device *parent)
129 {
130 #ifdef KLD_MODULE
131         struct device *child[2];
132         const int port[2] = { 0x2e, 0x4e };
133
134         for (int i = 0; i < 2; i++) {
135                 child[i] = device_find_child(parent, driver->name, i);
136                 if (child[i] == NULL) {
137                         child[i] = BUS_ADD_CHILD(parent, parent, ISA_ORDER_PNP,
138                             driver->name, i);
139                         if (child[i] == NULL) {
140                                 kprintf("%s: cannot add child[%i]\n",
141                                     __func__, i);
142                                 continue;
143                         }
144                 } else
145                         continue;
146                 if (bus_set_resource(child[i], SYS_RES_IOPORT, 0,
147                         port[i], WBSIO_IOSIZE))
148                         kprintf("%s: cannot set resource for child[%i]\n",
149                             __func__, i);
150         }
151 #endif
152 }
153
154 static int
155 wbsio_probe(struct device *dev)
156 {
157         struct resource *iores;
158         int iorid = 0;
159         bus_space_tag_t iot;
160         bus_space_handle_t ioh;
161         uint8_t reg_id, reg_rev;
162         const char *desc = NULL;
163         char fulldesc[64];
164
165         /* Match by device ID */
166
167         iores = bus_alloc_resource(dev, SYS_RES_IOPORT, &iorid,
168             0ul, ~0ul, WBSIO_IOSIZE,
169             RF_ACTIVE);
170         if (iores == NULL)
171                 return ENXIO;
172         iot = rman_get_bustag(iores);
173         ioh = rman_get_bushandle(iores);
174
175         wbsio_conf_enable(iot, ioh);
176         /* Read device ID */
177         reg_id = wbsio_conf_read(iot, ioh, WBSIO_ID);
178         /* Read device revision */
179         reg_rev = wbsio_conf_read(iot, ioh, WBSIO_REV);
180         wbsio_conf_disable(iot, ioh);
181         bus_release_resource(dev, SYS_RES_IOPORT, iorid, iores);
182
183         switch (reg_id) {
184         case WBSIO_ID_W83627HF:
185                 desc = "W83627HF";
186                 break;
187         case WBSIO_ID_W83627THF:
188                 desc = "W83627THF";
189                 break;
190         case WBSIO_ID_W83627EHF:
191                 desc = "W83627EHF";
192                 break;
193         case WBSIO_ID_W83627DHG:
194                 desc = "W83627DHG";
195                 break;
196         case WBSIO_ID_W83637HF:
197                 desc = "W83637HF";
198                 break;
199         case WBSIO_ID_W83667HG:
200                 desc = "W83667HG";
201                 break;
202         case WBSIO_ID_W83687THF:
203                 desc = "W83687THF";
204                 break;
205         case WBSIO_ID_W83697HF:
206                 desc = "W83697HF";
207                 break;
208         }
209
210         if (desc == NULL) {
211 #ifndef KLD_MODULE
212                 if (bootverbose)
213 #endif
214                         if (!(reg_id == 0xff && reg_rev == 0xff))
215                                 device_printf(dev, "%s port 0x%02x: "
216                                     "Device ID 0x%02x, Rev 0x%02x\n",
217                                     __func__, isa_get_port(dev),
218                                     reg_id, reg_rev);
219                 return ENXIO;
220         }
221
222         ksnprintf(fulldesc, sizeof(fulldesc),
223             "Winbond LPC Super I/O %s rev 0x%02x", desc, reg_rev);
224         device_set_desc_copy(dev, fulldesc);
225         return 0;
226 }
227
228 static int
229 wbsio_attach(struct device *dev)
230 {
231         struct wbsio_softc *sc = device_get_softc(dev);
232         uint8_t reg0, reg1;
233         uint16_t iobase;
234         struct device *parent = device_get_parent(dev);
235         struct device *child;
236         struct devclass *c_dc;
237         int c_maxunit;
238
239         /* Map ISA I/O space */
240         sc->sc_iores = bus_alloc_resource(dev, SYS_RES_IOPORT, &sc->sc_iorid,
241             0ul, ~0ul, WBSIO_IOSIZE,
242             RF_ACTIVE);
243         if (sc->sc_iores == NULL) {
244                 device_printf(dev, "can't map i/o space\n");
245                 return ENXIO;
246         }
247         sc->sc_iot = rman_get_bustag(sc->sc_iores);
248         sc->sc_ioh = rman_get_bushandle(sc->sc_iores);
249
250         /* Enter configuration mode */
251         wbsio_conf_enable(sc->sc_iot, sc->sc_ioh);
252
253         /* Select HM logical device */
254         wbsio_conf_write(sc->sc_iot, sc->sc_ioh, WBSIO_LDN, WBSIO_LDN_HM);
255
256         /*
257          * The address should be 8-byte aligned, but it seems some
258          * BIOSes ignore this.  They get away with it, because
259          * Apparently the hardware simply ignores the lower three
260          * bits.  We do the same here.
261          */
262         reg0 = wbsio_conf_read(sc->sc_iot, sc->sc_ioh, WBSIO_HM_ADDR_LSB);
263         reg1 = wbsio_conf_read(sc->sc_iot, sc->sc_ioh, WBSIO_HM_ADDR_MSB);
264         iobase = (reg1 << 8) | (reg0 & ~0x7);
265         device_printf(dev, "hardware monitor iobase is 0x%x\n", iobase);
266
267         /* Escape from configuration mode */
268         wbsio_conf_disable(sc->sc_iot, sc->sc_ioh);
269
270         if (iobase == 0) {
271                 device_printf(dev, "no hardware monitor configured\n");
272                 return 0;
273         }
274
275         child = NULL;
276         c_dc = devclass_find("lm");
277         if (c_dc == NULL) {
278                 device_printf(dev, "lm devclass not found\n");
279                 return ENXIO;
280         }
281         c_maxunit = devclass_get_maxunit(c_dc);
282         for (int u = 0; u < c_maxunit; u++) {
283                 child = devclass_get_device(c_dc, u);
284                 if (child == NULL)
285                         continue;
286                 if (isa_get_port(child) == iobase) {
287                         if (device_is_attached(child)) {
288                                 device_printf(dev,
289                                     "%s is already attached at 0x%x\n",
290                                     device_get_nameunit(child), iobase);
291                                 return 0;
292                         }
293                         break;
294                 }
295                 if (device_is_attached(child)) {
296                         child = NULL;
297                         continue;
298                 }
299                 device_printf(dev,
300                     "found unused %s at 0x%x with state %i, reusing at 0x%x\n",
301                     device_get_nameunit(child), isa_get_port(child),
302                     device_get_state(child), iobase);
303                 break;
304         }
305         if (child == NULL)
306                 child = BUS_ADD_CHILD(parent, parent, ISA_ORDER_PNP,
307                     "lm", -1);
308 //      child = BUS_ADD_CHILD(parent, parent, ISA_ORDER_PNP,
309 //          "lm", 3 + device_get_unit(dev));
310         if (child == NULL) {
311                 device_printf(dev, "cannot add child\n");
312                 return ENXIO;
313         }
314         if (bus_set_resource(child, SYS_RES_IOPORT, 0, iobase, 8)) {
315                 device_printf(dev, "cannot set resource\n");
316                 return ENXIO;
317         }
318         return device_probe_and_attach(child);
319 }
320
321 static int
322 wbsio_detach(struct device *dev)
323 {
324         struct wbsio_softc *sc = device_get_softc(dev);
325
326         return bus_release_resource(dev, SYS_RES_IOPORT,
327             sc->sc_iorid, sc->sc_iores);
328 }