2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2006 Michael Lorenz
5 * Copyright 2008 by Nathan Whitehorn
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/module.h>
41 #include <sys/eventhandler.h>
42 #include <sys/kernel.h>
44 #include <sys/mutex.h>
45 #include <sys/clock.h>
46 #include <sys/reboot.h>
48 #include <dev/ofw/ofw_bus.h>
49 #include <dev/ofw/openfirm.h>
51 #include <machine/bus.h>
52 #include <machine/intr_machdep.h>
53 #include <machine/md_var.h>
54 #include <machine/pio.h>
55 #include <machine/resource.h>
62 #include <dev/adb/adb.h>
71 static int cuda_probe(device_t);
72 static int cuda_attach(device_t);
73 static int cuda_detach(device_t);
75 static u_int cuda_adb_send(device_t dev, u_char command_byte, int len,
76 u_char *data, u_char poll);
77 static u_int cuda_adb_autopoll(device_t dev, uint16_t mask);
78 static u_int cuda_poll(device_t dev);
79 static void cuda_send_inbound(struct cuda_softc *sc);
80 static void cuda_send_outbound(struct cuda_softc *sc);
81 static void cuda_shutdown(void *xsc, int howto);
86 static int cuda_gettime(device_t dev, struct timespec *ts);
87 static int cuda_settime(device_t dev, struct timespec *ts);
89 static device_method_t cuda_methods[] = {
90 /* Device interface */
91 DEVMETHOD(device_probe, cuda_probe),
92 DEVMETHOD(device_attach, cuda_attach),
93 DEVMETHOD(device_detach, cuda_detach),
94 DEVMETHOD(device_shutdown, bus_generic_shutdown),
95 DEVMETHOD(device_suspend, bus_generic_suspend),
96 DEVMETHOD(device_resume, bus_generic_resume),
98 /* ADB bus interface */
99 DEVMETHOD(adb_hb_send_raw_packet, cuda_adb_send),
100 DEVMETHOD(adb_hb_controller_poll, cuda_poll),
101 DEVMETHOD(adb_hb_set_autopoll_mask, cuda_adb_autopoll),
103 /* Clock interface */
104 DEVMETHOD(clock_gettime, cuda_gettime),
105 DEVMETHOD(clock_settime, cuda_settime),
110 static driver_t cuda_driver = {
113 sizeof(struct cuda_softc),
116 DRIVER_MODULE(cuda, macio, cuda_driver, 0, 0);
117 DRIVER_MODULE(adb, cuda, adb_driver, 0, 0);
119 static void cuda_intr(void *arg);
120 static uint8_t cuda_read_reg(struct cuda_softc *sc, u_int offset);
121 static void cuda_write_reg(struct cuda_softc *sc, u_int offset, uint8_t value);
122 static void cuda_idle(struct cuda_softc *);
123 static void cuda_tip(struct cuda_softc *);
124 static void cuda_clear_tip(struct cuda_softc *);
125 static void cuda_in(struct cuda_softc *);
126 static void cuda_out(struct cuda_softc *);
127 static void cuda_toggle_ack(struct cuda_softc *);
128 static void cuda_ack_off(struct cuda_softc *);
129 static int cuda_intr_state(struct cuda_softc *);
132 cuda_probe(device_t dev)
134 const char *type = ofw_bus_get_type(dev);
136 if (strcmp(type, "via-cuda") != 0)
139 device_set_desc(dev, CUDA_DEVSTR);
144 cuda_attach(device_t dev)
146 struct cuda_softc *sc;
150 phandle_t node,child;
152 sc = device_get_softc(dev);
156 sc->sc_memr = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
157 &sc->sc_memrid, RF_ACTIVE);
159 if (sc->sc_memr == NULL) {
160 device_printf(dev, "Could not alloc mem resource!\n");
165 sc->sc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->sc_irqrid,
167 if (sc->sc_irq == NULL) {
168 device_printf(dev, "could not allocate interrupt\n");
169 bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_memrid,
174 if (bus_setup_intr(dev, sc->sc_irq, INTR_TYPE_MISC | INTR_MPSAFE
175 | INTR_ENTROPY, NULL, cuda_intr, dev, &sc->sc_ih) != 0) {
176 device_printf(dev, "could not setup interrupt\n");
177 bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_memrid,
179 bus_release_resource(dev, SYS_RES_IRQ, sc->sc_irqrid,
184 mtx_init(&sc->sc_mutex,"cuda",NULL,MTX_DEF | MTX_RECURSE);
190 sc->sc_state = CUDA_NOTREADY;
194 STAILQ_INIT(&sc->sc_inq);
195 STAILQ_INIT(&sc->sc_outq);
196 STAILQ_INIT(&sc->sc_freeq);
198 for (i = 0; i < CUDA_MAXPACKETS; i++)
199 STAILQ_INSERT_TAIL(&sc->sc_freeq, &sc->sc_pkts[i], pkt_q);
203 reg = cuda_read_reg(sc, vDirB);
204 reg |= 0x30; /* register B bits 4 and 5: outputs */
205 cuda_write_reg(sc, vDirB, reg);
207 reg = cuda_read_reg(sc, vDirB);
208 reg &= 0xf7; /* register B bit 3: input */
209 cuda_write_reg(sc, vDirB, reg);
211 reg = cuda_read_reg(sc, vACR);
212 reg &= ~vSR_OUT; /* make sure SR is set to IN */
213 cuda_write_reg(sc, vACR, reg);
215 cuda_write_reg(sc, vACR, (cuda_read_reg(sc, vACR) | 0x0c) & ~0x10);
217 sc->sc_state = CUDA_IDLE; /* used by all types of hardware */
219 cuda_write_reg(sc, vIER, 0x84); /* make sure VIA interrupts are on */
221 cuda_idle(sc); /* reset ADB */
225 i = cuda_read_reg(sc, vSR); /* clear interrupt */
226 cuda_write_reg(sc, vIER, 0x04); /* no interrupts while clearing */
227 cuda_idle(sc); /* reset state to idle */
229 cuda_tip(sc); /* signal start of frame */
235 cuda_idle(sc); /* back to idle state */
236 i = cuda_read_reg(sc, vSR); /* clear interrupt */
237 cuda_write_reg(sc, vIER, 0x84); /* ints ok now */
239 /* Initialize child buses (ADB) */
240 node = ofw_bus_get_node(dev);
242 for (child = OF_child(node); child != 0; child = OF_peer(child)) {
245 memset(name, 0, sizeof(name));
246 OF_getprop(child, "name", name, sizeof(name));
249 device_printf(dev, "CUDA child <%s>\n",name);
251 if (strncmp(name, "adb", 4) == 0) {
252 sc->adb_bus = device_add_child(dev,"adb",-1);
256 clock_register(dev, 1000);
257 EVENTHANDLER_REGISTER(shutdown_final, cuda_shutdown, sc,
260 return (bus_generic_attach(dev));
263 static int cuda_detach(device_t dev) {
264 struct cuda_softc *sc;
266 sc = device_get_softc(dev);
268 bus_teardown_intr(dev, sc->sc_irq, sc->sc_ih);
269 bus_release_resource(dev, SYS_RES_IRQ, sc->sc_irqrid, sc->sc_irq);
270 bus_release_resource(dev, SYS_RES_MEMORY, sc->sc_memrid, sc->sc_memr);
271 mtx_destroy(&sc->sc_mutex);
273 return (bus_generic_detach(dev));
277 cuda_read_reg(struct cuda_softc *sc, u_int offset) {
278 return (bus_read_1(sc->sc_memr, offset));
282 cuda_write_reg(struct cuda_softc *sc, u_int offset, uint8_t value) {
283 bus_write_1(sc->sc_memr, offset, value);
287 cuda_idle(struct cuda_softc *sc)
291 reg = cuda_read_reg(sc, vBufB);
292 reg |= (vPB4 | vPB5);
293 cuda_write_reg(sc, vBufB, reg);
297 cuda_tip(struct cuda_softc *sc)
301 reg = cuda_read_reg(sc, vBufB);
303 cuda_write_reg(sc, vBufB, reg);
307 cuda_clear_tip(struct cuda_softc *sc)
311 reg = cuda_read_reg(sc, vBufB);
313 cuda_write_reg(sc, vBufB, reg);
317 cuda_in(struct cuda_softc *sc)
321 reg = cuda_read_reg(sc, vACR);
323 cuda_write_reg(sc, vACR, reg);
327 cuda_out(struct cuda_softc *sc)
331 reg = cuda_read_reg(sc, vACR);
333 cuda_write_reg(sc, vACR, reg);
337 cuda_toggle_ack(struct cuda_softc *sc)
341 reg = cuda_read_reg(sc, vBufB);
343 cuda_write_reg(sc, vBufB, reg);
347 cuda_ack_off(struct cuda_softc *sc)
351 reg = cuda_read_reg(sc, vBufB);
353 cuda_write_reg(sc, vBufB, reg);
357 cuda_intr_state(struct cuda_softc *sc)
359 return ((cuda_read_reg(sc, vBufB) & vPB3) == 0);
363 cuda_send(void *cookie, int poll, int length, uint8_t *msg)
365 struct cuda_softc *sc = cookie;
366 device_t dev = sc->sc_dev;
367 struct cuda_packet *pkt;
369 if (sc->sc_state == CUDA_NOTREADY)
372 mtx_lock(&sc->sc_mutex);
374 pkt = STAILQ_FIRST(&sc->sc_freeq);
376 mtx_unlock(&sc->sc_mutex);
380 pkt->len = length - 1;
382 memcpy(pkt->data, &msg[1], pkt->len);
384 STAILQ_REMOVE_HEAD(&sc->sc_freeq, pkt_q);
385 STAILQ_INSERT_TAIL(&sc->sc_outq, pkt, pkt_q);
388 * If we already are sending a packet, we should bail now that this
389 * one has been added to the queue.
392 if (sc->sc_waiting) {
393 mtx_unlock(&sc->sc_mutex);
397 cuda_send_outbound(sc);
398 mtx_unlock(&sc->sc_mutex);
400 if (sc->sc_polling || poll || cold)
407 cuda_send_outbound(struct cuda_softc *sc)
409 struct cuda_packet *pkt;
411 mtx_assert(&sc->sc_mutex, MA_OWNED);
413 pkt = STAILQ_FIRST(&sc->sc_outq);
417 sc->sc_out_length = pkt->len + 1;
418 memcpy(sc->sc_out, &pkt->type, pkt->len + 1);
421 STAILQ_REMOVE_HEAD(&sc->sc_outq, pkt_q);
422 STAILQ_INSERT_TAIL(&sc->sc_freeq, pkt, pkt_q);
426 cuda_poll(sc->sc_dev);
430 if (sc->sc_state == CUDA_IDLE && !cuda_intr_state(sc)) {
431 sc->sc_state = CUDA_OUT;
433 cuda_write_reg(sc, vSR, sc->sc_out[0]);
440 cuda_send_inbound(struct cuda_softc *sc)
443 struct cuda_packet *pkt;
447 mtx_lock(&sc->sc_mutex);
449 while ((pkt = STAILQ_FIRST(&sc->sc_inq)) != NULL) {
450 STAILQ_REMOVE_HEAD(&sc->sc_inq, pkt_q);
452 mtx_unlock(&sc->sc_mutex);
454 /* check if we have a handler for this message */
458 adb_receive_raw_packet(sc->adb_bus,
459 pkt->data[0],pkt->data[1],
460 pkt->len - 2,&pkt->data[2]);
462 adb_receive_raw_packet(sc->adb_bus,
463 pkt->data[0],pkt->data[1],0,NULL);
467 mtx_lock(&sc->sc_mutex);
468 switch (pkt->data[1]) {
473 memcpy(&sc->sc_rtc, &pkt->data[2],
480 mtx_unlock(&sc->sc_mutex);
484 * CUDA will throw errors if we miss a race between
485 * sending and receiving packets. This is already
486 * handled when we abort packet output to handle
487 * this packet in cuda_intr(). Thus, we ignore
492 device_printf(dev,"unknown CUDA command %d\n",
497 mtx_lock(&sc->sc_mutex);
499 STAILQ_INSERT_TAIL(&sc->sc_freeq, pkt, pkt_q);
502 mtx_unlock(&sc->sc_mutex);
506 cuda_poll(device_t dev)
508 struct cuda_softc *sc = device_get_softc(dev);
510 if (sc->sc_state == CUDA_IDLE && !cuda_intr_state(sc) &&
522 struct cuda_softc *sc;
523 int ending, process_inbound;
527 sc = device_get_softc(dev);
529 mtx_lock(&sc->sc_mutex);
532 reg = cuda_read_reg(sc, vIFR);
533 if ((reg & vSR_INT) != vSR_INT) {
534 mtx_unlock(&sc->sc_mutex);
538 cuda_write_reg(sc, vIFR, 0x7f); /* Clear interrupt */
541 switch (sc->sc_state) {
544 * This is an unexpected packet, so grab the first (dummy)
545 * byte, set up the proper vars, and tell the chip we are
546 * starting to receive the packet by setting the TIP bit.
548 sc->sc_in[1] = cuda_read_reg(sc, vSR);
550 if (cuda_intr_state(sc) == 0) {
551 /* must have been a fake start */
553 if (sc->sc_waiting) {
556 sc->sc_state = CUDA_OUT;
559 cuda_write_reg(sc, vSR, sc->sc_out[1]);
570 sc->sc_state = CUDA_IN;
574 sc->sc_in[sc->sc_received] = cuda_read_reg(sc, vSR);
577 if (sc->sc_received > 255) {
578 /* bitch only once */
579 if (sc->sc_received == 256) {
580 device_printf(dev,"input overflow\n");
586 /* intr off means this is the last byte (end of frame) */
587 if (cuda_intr_state(sc) == 0) {
593 if (ending == 1) { /* end of message? */
594 struct cuda_packet *pkt;
596 /* reset vars and signal the end of this frame */
599 /* Queue up the packet */
600 pkt = STAILQ_FIRST(&sc->sc_freeq);
602 /* If we have a free packet, process it */
604 pkt->len = sc->sc_received - 2;
605 pkt->type = sc->sc_in[1];
606 memcpy(pkt->data, &sc->sc_in[2], pkt->len);
608 STAILQ_REMOVE_HEAD(&sc->sc_freeq, pkt_q);
609 STAILQ_INSERT_TAIL(&sc->sc_inq, pkt, pkt_q);
614 sc->sc_state = CUDA_IDLE;
618 * If there is something waiting to be sent out,
619 * set everything up and send the first byte.
621 if (sc->sc_waiting == 1) {
622 DELAY(1500); /* required */
624 sc->sc_state = CUDA_OUT;
627 * If the interrupt is on, we were too slow
628 * and the chip has already started to send
629 * something to us, so back out of the write
630 * and start a read cycle.
632 if (cuda_intr_state(sc)) {
636 sc->sc_state = CUDA_IDLE;
643 * If we got here, it's ok to start sending
644 * so load the first byte and tell the chip
648 cuda_write_reg(sc, vSR,
649 sc->sc_out[sc->sc_sent]);
657 cuda_read_reg(sc, vSR); /* reset SR-intr in IFR */
660 if (cuda_intr_state(sc)) { /* ADB intr low during write */
661 cuda_in(sc); /* make sure SR is set to IN */
663 sc->sc_sent = 0; /* must start all over */
664 sc->sc_state = CUDA_IDLE; /* new state */
666 sc->sc_waiting = 1; /* must retry when done with
669 goto switch_start; /* process next state right
673 if (sc->sc_out_length == sc->sc_sent) { /* check for done */
674 sc->sc_waiting = 0; /* done writing */
675 sc->sc_state = CUDA_IDLE; /* signal bus is idle */
680 cuda_write_reg(sc, vSR, sc->sc_out[sc->sc_sent]);
681 cuda_toggle_ack(sc); /* signal byte ready to
693 mtx_unlock(&sc->sc_mutex);
696 cuda_send_inbound(sc);
698 mtx_lock(&sc->sc_mutex);
699 /* If we have another packet waiting, set it up */
700 if (!sc->sc_waiting && sc->sc_state == CUDA_IDLE)
701 cuda_send_outbound(sc);
703 mtx_unlock(&sc->sc_mutex);
708 cuda_adb_send(device_t dev, u_char command_byte, int len, u_char *data,
711 struct cuda_softc *sc = device_get_softc(dev);
715 /* construct an ADB command packet and send it */
716 packet[0] = CUDA_ADB;
717 packet[1] = command_byte;
718 for (i = 0; i < len; i++)
719 packet[i + 2] = data[i];
721 cuda_send(sc, poll, len + 2, packet);
727 cuda_adb_autopoll(device_t dev, uint16_t mask) {
728 struct cuda_softc *sc = device_get_softc(dev);
730 uint8_t cmd[] = {CUDA_PSEUDO, CMD_AUTOPOLL, mask != 0};
732 mtx_lock(&sc->sc_mutex);
734 if (cmd[2] == sc->sc_autopoll) {
735 mtx_unlock(&sc->sc_mutex);
739 sc->sc_autopoll = -1;
740 cuda_send(sc, 1, 3, cmd);
742 mtx_unlock(&sc->sc_mutex);
748 cuda_shutdown(void *xsc, int howto)
750 struct cuda_softc *sc = xsc;
751 uint8_t cmd[] = {CUDA_PSEUDO, 0};
753 cmd[1] = (howto & RB_HALT) ? CMD_POWEROFF : CMD_RESET;
754 cuda_poll(sc->sc_dev);
755 cuda_send(sc, 1, 2, cmd);
758 cuda_poll(sc->sc_dev);
761 #define DIFF19041970 2082844800
764 cuda_gettime(device_t dev, struct timespec *ts)
766 struct cuda_softc *sc = device_get_softc(dev);
767 uint8_t cmd[] = {CUDA_PSEUDO, CMD_READ_RTC};
769 mtx_lock(&sc->sc_mutex);
771 cuda_send(sc, 1, 2, cmd);
772 if (sc->sc_rtc == -1)
773 mtx_sleep(&sc->sc_rtc, &sc->sc_mutex, 0, "rtc", 100);
775 ts->tv_sec = sc->sc_rtc - DIFF19041970;
777 mtx_unlock(&sc->sc_mutex);
783 cuda_settime(device_t dev, struct timespec *ts)
785 struct cuda_softc *sc = device_get_softc(dev);
786 uint8_t cmd[] = {CUDA_PSEUDO, CMD_WRITE_RTC, 0, 0, 0, 0};
789 sec = ts->tv_sec + DIFF19041970;
790 memcpy(&cmd[2], &sec, sizeof(sec));
792 mtx_lock(&sc->sc_mutex);
793 cuda_send(sc, 0, 6, cmd);
794 mtx_unlock(&sc->sc_mutex);