1 /* $OpenBSD: blambert $ */
2 /* $NetBSD: nsclpcsio_isa.c,v 1.5 2002/10/22 16:18:26 drochner Exp $ */
5 * Copyright (c) 2002 Matthias Drochner. All rights reserved.
6 * Copyright (c) 2004 Markus Friedl. All rights reserved.
7 * Copyright (c) 2004 Alexander Yurchenko. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions, and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * National Semiconductor PC87366 LPC Super I/O.
33 * Supported logical devices: GPIO, TMS, VLM.
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/device.h>
41 #include <sys/kernel.h>
42 #include <sys/sensors.h>
43 #include <sys/module.h>
48 #include <bus/isa/isareg.h>
49 #include <bus/isa/isavar.h>
51 #include <dev/misc/gpio/gpio.h>
53 #if defined(NSC_LPC_SIO_DEBUG)
54 #define DPRINTF(x) do { kprintf x; } while (0)
59 #define SIO_REG_SID 0x20 /* Super I/O ID */
60 #define SIO_SID_PC87366 0xE9 /* PC87366 is identified by 0xE9.*/
62 #define SIO_REG_SRID 0x27 /* Super I/O Revision */
64 #define SIO_REG_LDN 0x07 /* Logical Device Number */
65 #define SIO_LDN_FDC 0x00 /* Floppy Disk Controller (FDC) */
66 #define SIO_LDN_PP 0x01 /* Parallel Port (PP) */
67 #define SIO_LDN_SP2 0x02 /* Serial Port 2 with IR (SP2) */
68 #define SIO_LDN_SP1 0x03 /* Serial Port 1 (SP1) */
69 #define SIO_LDN_SWC 0x04 /* System Wake-Up Control (SWC) */
70 #define SIO_LDN_KBCM 0x05 /* Mouse Controller (KBC) */
71 #define SIO_LDN_KBCK 0x06 /* Keyboard Controller (KBC) */
72 #define SIO_LDN_GPIO 0x07 /* General-Purpose I/O (GPIO) Ports */
73 #define SIO_LDN_ACB 0x08 /* ACCESS.bus Interface (ACB) */
74 #define SIO_LDN_FSCM 0x09 /* Fan Speed Control and Monitor (FSCM) */
75 #define SIO_LDN_WDT 0x0A /* WATCHDOG Timer (WDT) */
76 #define SIO_LDN_GMP 0x0B /* Game Port (GMP) */
77 #define SIO_LDN_MIDI 0x0C /* Musical Instrument Digital Interface */
78 #define SIO_LDN_VLM 0x0D /* Voltage Level Monitor (VLM) */
79 #define SIO_LDN_TMS 0x0E /* Temperature Sensor (TMS) */
81 #define SIO_REG_ACTIVE 0x30 /* Logical Device Activate Register */
82 #define SIO_ACTIVE_EN 0x01 /* enabled */
84 #define SIO_REG_IO_MSB 0x60 /* I/O Port Base, bits 15-8 */
85 #define SIO_REG_IO_LSB 0x61 /* I/O Port Base, bits 7-0 */
87 #define SIO_LDNUM 15 /* total number of logical devices */
89 /* Supported logical devices description */
95 { "GPIO", SIO_LDN_GPIO, 16 },
96 { "VLM", SIO_LDN_VLM, 16 },
97 { "TMS", SIO_LDN_TMS, 16 },
101 #define SIO_GPIO_PINSEL 0xf0
102 #define SIO_GPIO_PINCFG 0xf1
103 #define SIO_GPIO_PINEV 0xf2
105 #define SIO_GPIO_CONF_OUTPUTEN (1 << 0)
106 #define SIO_GPIO_CONF_PUSHPULL (1 << 1)
107 #define SIO_GPIO_CONF_PULLUP (1 << 2)
109 #define SIO_GPDO0 0x00
110 #define SIO_GPDI0 0x01
111 #define SIO_GPEVEN0 0x02
112 #define SIO_GPEVST0 0x03
113 #define SIO_GPDO1 0x04
114 #define SIO_GPDI1 0x05
115 #define SIO_GPEVEN1 0x06
116 #define SIO_GPEVST1 0x07
117 #define SIO_GPDO2 0x08
118 #define SIO_GPDI2 0x09
119 #define SIO_GPDO3 0x0a
120 #define SIO_GPDI3 0x0b
122 #define SIO_GPIO_NPINS 29
125 #define SIO_TEVSTS 0x00 /* Temperature Event Status */
126 #define SIO_TEVSMI 0x02 /* Temperature Event to SMI */
127 #define SIO_TEVIRQ 0x04 /* Temperature Event to IRQ */
128 #define SIO_TMSCFG 0x08 /* TMS Configuration */
129 #define SIO_TMSBS 0x09 /* TMS Bank Select */
130 #define SIO_TCHCFST 0x0A /* Temperature Channel Config and Status */
131 #define SIO_RDCHT 0x0B /* Read Channel Temperature */
132 #define SIO_CHTH 0x0C /* Channel Temperature High Limit */
133 #define SIO_CHTL 0x0D /* Channel Temperature Low Limit */
134 #define SIO_CHOTL 0x0E /* Channel Overtemperature Limit */
137 #define SIO_VEVSTS0 0x00 /* Voltage Event Status 0 */
138 #define SIO_VEVSTS1 0x01 /* Voltage Event Status 1 */
139 #define SIO_VEVSMI0 0x02 /* Voltage Event to SMI 0 */
140 #define SIO_VEVSMI1 0x03 /* Voltage Event to SMI 1 */
141 #define SIO_VEVIRQ0 0x04 /* Voltage Event to IRQ 0 */
142 #define SIO_VEVIRQ1 0x05 /* Voltage Event to IRQ 1 */
143 #define SIO_VID 0x06 /* Voltage ID */
144 #define SIO_VCNVR 0x07 /* Voltage Conversion Rate */
145 #define SIO_VLMCFG 0x08 /* VLM Configuration */
146 #define SIO_VLMBS 0x09 /* VLM Bank Select */
147 #define SIO_VCHCFST 0x0A /* Voltage Channel Config and Status */
148 #define SIO_RDCHV 0x0B /* Read Channel Voltage */
149 #define SIO_CHVH 0x0C /* Channel Voltage High Limit */
150 #define SIO_CHVL 0x0D /* Channel Voltage Low Limit */
151 #define SIO_OTSL 0x0E /* Overtemperature Shutdown Limit */
153 #define SIO_REG_SIOCF1 0x21
154 #define SIO_REG_SIOCF2 0x22
155 #define SIO_REG_SIOCF3 0x23
156 #define SIO_REG_SIOCF4 0x24
157 #define SIO_REG_SIOCF5 0x25
158 #define SIO_REG_SIOCF8 0x28
159 #define SIO_REG_SIOCFA 0x2A
160 #define SIO_REG_SIOCFB 0x2B
161 #define SIO_REG_SIOCFC 0x2C
162 #define SIO_REG_SIOCFD 0x2D
164 #define SIO_NUM_SENSORS (3+14)
165 #define SIO_VLM_OFF 3
166 #define SIO_VREF 1235 /* 1000.0 * VREF */
168 struct nsclpcsio_softc {
169 struct device* sc_dev;
170 struct resource *sc_iores;
172 bus_space_tag_t sc_iot;
173 bus_space_handle_t sc_ioh;
175 bus_space_handle_t sc_ld_ioh[SIO_LDNUM];
176 int sc_ld_en[SIO_LDNUM];
179 struct gpio sc_gpio_gc;
180 struct gpio_pin sc_gpio_pins[SIO_GPIO_NPINS];
184 struct ksensor sensors[SIO_NUM_SENSORS];
185 struct ksensordev sensordev;
188 #define GPIO_READ(sc, reg) \
189 bus_space_read_1((sc)->sc_iot, \
190 (sc)->sc_ld_ioh[SIO_LDN_GPIO], (reg))
191 #define GPIO_WRITE(sc, reg, val) \
192 bus_space_write_1((sc)->sc_iot, \
193 (sc)->sc_ld_ioh[SIO_LDN_GPIO], (reg), (val))
194 #define TMS_WRITE(sc, reg, val) \
195 bus_space_write_1((sc)->sc_iot, \
196 (sc)->sc_ld_ioh[SIO_LDN_TMS], (reg), (val))
197 #define TMS_READ(sc, reg) \
198 bus_space_read_1((sc)->sc_iot, \
199 (sc)->sc_ld_ioh[SIO_LDN_TMS], (reg))
200 #define VLM_WRITE(sc, reg, val) \
201 bus_space_write_1((sc)->sc_iot, \
202 (sc)->sc_ld_ioh[SIO_LDN_VLM], (reg), (val))
203 #define VLM_READ(sc, reg) \
204 bus_space_read_1((sc)->sc_iot, \
205 (sc)->sc_ld_ioh[SIO_LDN_VLM], (reg))
207 int nsclpcsio_isa_probe(struct device *);
208 int nsclpcsio_isa_attach(struct device *);
211 static device_method_t nsclpcsio_isa_methods[] = {
212 DEVMETHOD(device_probe, nsclpcsio_isa_probe),
213 DEVMETHOD(device_attach, nsclpcsio_isa_attach),
217 static driver_t nsclpcsio_isa_driver = {
219 nsclpcsio_isa_methods,
220 sizeof (struct nsclpcsio_softc)
223 static devclass_t nsclpcsio_devclass;
225 DRIVER_MODULE(nsclpcsio_isa, isa, nsclpcsio_isa_driver, nsclpcsio_devclass, NULL, NULL);
229 static u_int8_t nsread(bus_space_tag_t, bus_space_handle_t, int);
230 static void nswrite(bus_space_tag_t, bus_space_handle_t, int, u_int8_t);
233 void nsclpcsio_gpio_init(struct nsclpcsio_softc *);
234 int nsclpcsio_gpio_pin_read(void *, int);
235 void nsclpcsio_gpio_pin_write(void *, int, int);
236 void nsclpcsio_gpio_pin_ctl(void *, int, int);
239 void nsclpcsio_tms_init(struct nsclpcsio_softc *);
240 void nsclpcsio_vlm_init(struct nsclpcsio_softc *);
241 void nsclpcsio_tms_update(struct nsclpcsio_softc *);
242 void nsclpcsio_vlm_update(struct nsclpcsio_softc *);
243 void nsclpcsio_refresh(void *);
246 nsread(bus_space_tag_t iot, bus_space_handle_t ioh, int idx)
248 bus_space_write_1(iot, ioh, 0, idx);
249 return (bus_space_read_1(iot, ioh, 1));
253 nswrite(bus_space_tag_t iot, bus_space_handle_t ioh, int idx, u_int8_t data)
255 bus_space_write_1(iot, ioh, 0, idx);
256 bus_space_write_1(iot, ioh, 1, data);
260 nsclpcsio_isa_probe(struct device *dev)
262 struct resource *iores;
265 bus_space_handle_t ioh;
268 iores = bus_alloc_resource(dev, SYS_RES_IOPORT, &iorid, 0ul, ~0ul, 8, RF_ACTIVE);
272 iot = rman_get_bustag(iores);
273 ioh = rman_get_bushandle(iores);
275 if (nsread(iot, ioh, SIO_REG_SID) == SIO_SID_PC87366)
278 bus_release_resource(dev, SYS_RES_IOPORT, iorid, iores);
287 nsclpcsio_isa_attach(struct device *dev)
290 struct nsclpcsio_softc *sc = device_get_softc(dev);
294 sc->sc_iores = bus_alloc_resource(dev, SYS_RES_IOPORT, &sc->sc_iorid, 0ul, ~0ul, 8, RF_ACTIVE);
295 if (sc->sc_iores == NULL) {
298 sc->sc_iot = rman_get_bustag(sc->sc_iores);
299 sc->sc_ioh = rman_get_bushandle(sc->sc_iores);
301 kprintf("%s: NSC PC87366 rev %d:", device_get_nameunit(sc->sc_dev),
302 nsread(sc->sc_iot, sc->sc_ioh, SIO_REG_SRID));
304 /* Configure all supported logical devices */
305 for (i = 0; i < NELEM(sio_ld); i++) {
306 sc->sc_ld_en[sio_ld[i].ld_num] = 0;
308 /* Select the device and check if it's activated */
309 nswrite(sc->sc_iot, sc->sc_ioh, SIO_REG_LDN, sio_ld[i].ld_num);
310 if ((nsread(sc->sc_iot, sc->sc_ioh,
311 SIO_REG_ACTIVE) & SIO_ACTIVE_EN) == 0)
314 /* Map I/O space if necessary */
315 if (sio_ld[i].ld_iosize != 0) {
317 iobase = (nsread(sc->sc_iot, sc->sc_ioh,
318 SIO_REG_IO_MSB) << 8);
320 iobase |= nsread(sc->sc_iot, sc->sc_ioh,
323 /* XXX: Not elegant without alloc_resource, but works */
324 kprintf("debugging: iobase = %x\n", iobase);
325 iores = bus_alloc_resource(dev, SYS_RES_IOPORT, &iorid,
326 iobase, sio_ld[i].ld_iosize, sio_ld[i].ld_iosize, RF_ACTIVE);
328 kprintf("messed up alloc3\n");
331 /* XXX: if implemented, also use the rman get handle stuff */
333 sc->sc_ld_ioh[sio_ld[i].ld_num] = iobase;
336 sc->sc_ld_en[sio_ld[i].ld_num] = 1;
337 kprintf(" %s", sio_ld[i].ld_name);
342 nsclpcsio_gpio_init(sc);
344 nsclpcsio_tms_init(sc);
345 nsclpcsio_vlm_init(sc);
347 /* Hook into hw.sensors sysctl */
348 strlcpy(sc->sensordev.xname, device_get_nameunit(sc->sc_dev),
349 sizeof(sc->sensordev.xname));
350 for (i = 0; i < SIO_NUM_SENSORS; i++) {
351 if (i < SIO_VLM_OFF && !sc->sc_ld_en[SIO_LDN_TMS])
353 if (i >= SIO_VLM_OFF && !sc->sc_ld_en[SIO_LDN_VLM])
355 sensor_attach(&sc->sensordev, &sc->sensors[i]);
357 sensordev_install(&sc->sensordev);
358 if (sc->sc_ld_en[SIO_LDN_TMS] || sc->sc_ld_en[SIO_LDN_VLM]) {
359 sensor_task_register(sc, nsclpcsio_refresh, 2);
363 /* Attach GPIO framework */
364 if (sc->sc_ld_en[SIO_LDN_GPIO]) {
365 sc->sc_gpio_gc.driver_name = "pc83766";
366 sc->sc_gpio_gc.arg = sc;
367 sc->sc_gpio_gc.pin_read = nsclpcsio_gpio_pin_read;
368 sc->sc_gpio_gc.pin_write = nsclpcsio_gpio_pin_write;
369 sc->sc_gpio_gc.pin_ctl = nsclpcsio_gpio_pin_ctl;
370 sc->sc_gpio_gc.pins = sc->sc_gpio_pins;
371 sc->sc_gpio_gc.npins = SIO_GPIO_NPINS;
372 gpio_register(&sc->sc_gpio_gc);
380 nsclpcsio_refresh(void *arg)
382 struct nsclpcsio_softc *sc = (struct nsclpcsio_softc *)arg;
384 if (sc->sc_ld_en[SIO_LDN_TMS])
385 nsclpcsio_tms_update(sc);
386 if (sc->sc_ld_en[SIO_LDN_VLM])
387 nsclpcsio_vlm_update(sc);
391 nsclpcsio_tms_init(struct nsclpcsio_softc *sc)
395 /* Initialisation, PC87366.pdf, page 208 */
396 TMS_WRITE(sc, 0x08, 0x00);
397 TMS_WRITE(sc, 0x09, 0x0f);
398 TMS_WRITE(sc, 0x0a, 0x08);
399 TMS_WRITE(sc, 0x0b, 0x04);
400 TMS_WRITE(sc, 0x0c, 0x35);
401 TMS_WRITE(sc, 0x0d, 0x05);
402 TMS_WRITE(sc, 0x0e, 0x05);
404 TMS_WRITE(sc, SIO_TMSCFG, 0x00);
406 /* Enable the sensors */
407 for (i = 0; i < 3; i++) {
408 TMS_WRITE(sc, SIO_TMSBS, i);
409 TMS_WRITE(sc, SIO_TCHCFST, 0x01);
411 sc->sensors[i].type = SENSOR_TEMP;
414 strlcpy(sc->sensors[0].desc, "Remote", sizeof(sc->sensors[0].desc));
415 strlcpy(sc->sensors[1].desc, "Remote", sizeof(sc->sensors[1].desc));
416 strlcpy(sc->sensors[2].desc, "Local", sizeof(sc->sensors[2].desc));
418 nsclpcsio_tms_update(sc);
422 nsclpcsio_tms_update(struct nsclpcsio_softc *sc)
428 for (i = 0; i < 3; i++) {
429 TMS_WRITE(sc, SIO_TMSBS, i);
430 status = TMS_READ(sc, SIO_TCHCFST);
431 if (!(status & 0x01)) {
432 DPRINTF(("%s: status %d: disabled\n",
433 sc->sensors[i].desc, status));
434 sc->sensors[i].value = 0;
437 sdata = TMS_READ(sc, SIO_RDCHT);
438 DPRINTF(("%s: status %d C %d\n", sc->sensors[i].desc,
440 sc->sensors[i].value = sdata * 1000000 + 273150000;
445 nsclpcsio_vlm_init(struct nsclpcsio_softc *sc)
450 VLM_WRITE(sc, SIO_VLMCFG, 0x00);
452 /* Enable the sensors */
453 for (i = 0; i < 14; i++) {
454 VLM_WRITE(sc, SIO_VLMBS, i);
455 VLM_WRITE(sc, SIO_VCHCFST, 0x01);
481 /* only init .desc if we have something meaningful to say */
483 strlcpy(sc->sensors[SIO_VLM_OFF + i].desc, desc,
484 sizeof(sc->sensors[SIO_VLM_OFF + i].desc));
485 sc->sensors[SIO_VLM_OFF + i].type = SENSOR_VOLTS_DC;
488 nsclpcsio_vlm_update(sc);
492 nsclpcsio_vlm_update(struct nsclpcsio_softc *sc)
498 for (i = 0; i < 14; i++) {
499 VLM_WRITE(sc, SIO_VLMBS, i);
500 status = VLM_READ(sc, SIO_VCHCFST);
501 if (!(status & 0x01)) {
502 DPRINTF(("%s: status %d: disabled\n",
503 sc->sensors[SIO_VLM_OFF + i].desc, status));
504 sc->sensors[SIO_VLM_OFF + i].value = 0;
507 data = VLM_READ(sc, SIO_RDCHV);
508 DPRINTF(("%s: status %d V %d\n",
509 sc->sensors[SIO_VLM_OFF + i].desc, status, data));
519 /* Vi = (2.45±0.05)*VREF *RDCHVi / 256 */
520 rfact = 10 * scale * ((245 * SIO_VREF) >> 8);
521 sc->sensors[SIO_VLM_OFF + i].value = data * rfact;
527 nsclpcsio_gpio_pin_select(struct nsclpcsio_softc *sc, int pin)
534 data = (port << 4) | shift;
536 nswrite(sc->sc_iot, sc->sc_ioh, SIO_REG_LDN, SIO_LDN_GPIO);
537 nswrite(sc->sc_iot, sc->sc_ioh, SIO_GPIO_PINSEL, data);
541 nsclpcsio_gpio_init(struct nsclpcsio_softc *sc)
545 for (i = 0; i < SIO_GPIO_NPINS; i++) {
546 sc->sc_gpio_pins[i].pin_num = i;
547 sc->sc_gpio_pins[i].pin_caps = GPIO_PIN_INPUT |
548 GPIO_PIN_OUTPUT | GPIO_PIN_OPENDRAIN |
549 GPIO_PIN_PUSHPULL | GPIO_PIN_TRISTATE |
552 /* Read initial state */
553 sc->sc_gpio_pins[i].pin_state = nsclpcsio_gpio_pin_read(sc,
554 i) ? GPIO_PIN_HIGH : GPIO_PIN_LOW;
559 nsclpcsio_gpio_pin_read(void *arg, int pin)
561 struct nsclpcsio_softc *sc = arg;
562 int port, shift, reg;
585 data = GPIO_READ(sc, reg);
587 return ((data >> shift) & 0x1);
591 nsclpcsio_gpio_pin_write(void *arg, int pin, int value)
593 struct nsclpcsio_softc *sc = arg;
594 int port, shift, reg;
617 data = GPIO_READ(sc, reg);
619 data &= ~(1 << shift);
621 data |= (1 << shift);
623 GPIO_WRITE(sc, reg, data);
627 nsclpcsio_gpio_pin_ctl(void *arg, int pin, int flags)
629 struct nsclpcsio_softc *sc = arg;
632 nswrite(sc->sc_iot, sc->sc_ioh, SIO_REG_LDN, SIO_LDN_GPIO);
633 nsclpcsio_gpio_pin_select(sc, pin);
634 conf = nsread(sc->sc_iot, sc->sc_ioh, SIO_GPIO_PINCFG);
636 conf &= ~(SIO_GPIO_CONF_OUTPUTEN | SIO_GPIO_CONF_PUSHPULL |
637 SIO_GPIO_CONF_PULLUP);
638 if ((flags & GPIO_PIN_TRISTATE) == 0)
639 conf |= SIO_GPIO_CONF_OUTPUTEN;
640 if (flags & GPIO_PIN_PUSHPULL)
641 conf |= SIO_GPIO_CONF_PUSHPULL;
642 if (flags & GPIO_PIN_PULLUP)
643 conf |= SIO_GPIO_CONF_PULLUP;
645 nswrite(sc->sc_iot, sc->sc_ioh, SIO_GPIO_PINCFG, conf);