Home | History | Annotate | Line # | Download | only in dev
adb.c revision 1.60
      1 /*	$NetBSD: adb.c,v 1.60 2024/09/14 20:56:50 nat Exp $	*/
      2 
      3 /*
      4  * Copyright (C) 1994	Bradley A. Grantham
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     26  */
     27 
     28 #include <sys/cdefs.h>
     29 __KERNEL_RCSID(0, "$NetBSD: adb.c,v 1.60 2024/09/14 20:56:50 nat Exp $");
     30 
     31 #include "opt_adb.h"
     32 
     33 #include <sys/param.h>
     34 #include <sys/device.h>
     35 #include <sys/fcntl.h>
     36 #include <sys/poll.h>
     37 #include <sys/select.h>
     38 #include <sys/proc.h>
     39 #include <sys/signalvar.h>
     40 #include <sys/systm.h>
     41 #include <sys/cpu.h>
     42 #include <sys/intr.h>
     43 
     44 #include <machine/autoconf.h>
     45 
     46 #include <mac68k/mac68k/macrom.h>
     47 #include <mac68k/dev/adbvar.h>
     48 #include <mac68k/dev/akbdvar.h>
     49 
     50 #include "aed.h"		/* ADB Event Device for compatibility */
     51 
     52 /*
     53  * Function declarations.
     54  */
     55 static int	adbmatch(device_t, cfdata_t, void *);
     56 static void	adbattach(device_t, device_t, void *);
     57 static int	adbprint(void *, const char *);
     58 void		adb_config_interrupts(device_t);
     59 
     60 extern void	adb_jadbproc(void);
     61 
     62 /*
     63  * Global variables.
     64  */
     65 int	adb_polling = 0;	/* Are we polling?  (Debugger mode) */
     66 #ifdef ADB_DEBUG
     67 int	adb_debug = 0;		/* Output debugging messages */
     68 #endif /* ADB_DEBUG */
     69 
     70 extern struct	mac68k_machine_S mac68k_machine;
     71 extern int	adbHardware;
     72 extern char	*adbHardwareDescr[];
     73 
     74 /*
     75  * Driver definition.
     76  */
     77 CFATTACH_DECL_NEW(adb, 0,
     78     adbmatch, adbattach, NULL, NULL);
     79 
     80 static int
     81 adbmatch(device_t parent, cfdata_t cf, void *aux)
     82 {
     83 	static bool adb_matched;
     84 
     85 	/* Allow only one instance. */
     86 	if (adb_matched)
     87 		return (0);
     88 
     89 	adb_matched = true;
     90 	return (1);
     91 }
     92 
     93 static void
     94 adbattach(device_t parent, device_t self, void *aux)
     95 {
     96 
     97 	printf("...  Waiting 5 seconds for adb devices to settle.");
     98 	kpause("adb-slp", false, mstohz(5000), NULL);
     99 
    100 	adb_softintr_cookie = softint_establish(SOFTINT_SERIAL,
    101 	    (void (*)(void *))adb_soft_intr, NULL);
    102 	printf("\n");
    103 
    104 	/*
    105 	 * Defer configuration until interrupts are enabled.
    106 	 */
    107 	config_interrupts(self, adb_config_interrupts);
    108 }
    109 
    110 void
    111 adb_config_interrupts(device_t self)
    112 {
    113 	ADBDataBlock adbdata;
    114 	struct adb_attach_args aa_args;
    115 	int totaladbs;
    116 	int adbindex, adbaddr;
    117 
    118 	printf("%s", device_xname(self));
    119 	adb_polling = 1;
    120 
    121 #ifdef MRG_ADB
    122 	if (!mrg_romready()) {
    123 		printf(": no ROM ADB driver in this kernel for this machine\n");
    124 		return;
    125 	}
    126 
    127 #ifdef ADB_DEBUG
    128 	if (adb_debug)
    129 		printf("adb: call mrg_initadbintr\n");
    130 #endif
    131 
    132 	mrg_initadbintr();	/* Mac ROM Glue okay to do ROM intr */
    133 #ifdef ADB_DEBUG
    134 	if (adb_debug)
    135 		printf("adb: returned from mrg_initadbintr\n");
    136 #endif
    137 
    138 	/* ADBReInit pre/post-processing */
    139 	JADBProc = adb_jadbproc;
    140 
    141 	/* Initialize ADB */
    142 #ifdef ADB_DEBUG
    143 	if (adb_debug)
    144 		printf("adb: calling ADBAlternateInit.\n");
    145 #endif
    146 
    147 	printf(" (mrg)");
    148 	ADBAlternateInit();
    149 #else
    150 	ADBReInit();
    151 	printf(" (direct, %s)", adbHardwareDescr[adbHardware]);
    152 #endif /* MRG_ADB */
    153 
    154 #ifdef ADB_DEBUG
    155 	if (adb_debug)
    156 		printf("adb: done with ADBReInit\n");
    157 #endif
    158 
    159 	totaladbs = CountADBs();
    160 
    161 	printf(": %d target%s\n", totaladbs, (totaladbs == 1) ? "" : "s");
    162 
    163 #if NAED > 0
    164 	/* ADB event device for compatibility */
    165 	aa_args.origaddr = 0;
    166 	aa_args.adbaddr = 0;
    167 	aa_args.handler_id = 0;
    168 	(void)config_found(self, &aa_args, adbprint, CFARGS_NONE);
    169 #endif
    170 
    171 	/* for each ADB device */
    172 	for (adbindex = 1; adbindex <= totaladbs; adbindex++) {
    173 		/* Get the ADB information */
    174 		adbaddr = GetIndADB(&adbdata, adbindex);
    175 
    176 		aa_args.origaddr = (int)(adbdata.origADBAddr);
    177 		aa_args.adbaddr = adbaddr;
    178 		aa_args.handler_id = (int)(adbdata.devType);
    179 
    180 		(void)config_found(self, &aa_args, adbprint, CFARGS_NONE);
    181 	}
    182 	adb_polling = 0;
    183 }
    184 
    185 
    186 int
    187 adbprint(void *args, const char *name)
    188 {
    189 	struct adb_attach_args *aa_args = (struct adb_attach_args *)args;
    190 	int rv = UNCONF;
    191 
    192 	if (name) {	/* no configured device matched */
    193 		rv = UNSUPP; /* most ADB device types are unsupported */
    194 
    195 		/* print out what kind of ADB device we have found */
    196 		aprint_normal("%s addr %d: ", name, aa_args->adbaddr);
    197 		switch(aa_args->origaddr) {
    198 		case 0:
    199 #ifdef DIAGNOSTIC
    200 			aprint_normal("ADB event device");
    201 #endif
    202 			rv = UNCONF;
    203 			break;
    204 #ifdef DIAGNOSTIC
    205 		case ADBADDR_SECURE:
    206 			aprint_normal("security dongle (%d)",
    207 			    aa_args->handler_id);
    208 			break;
    209 #endif
    210 		case ADBADDR_MAP:
    211 			aprint_normal("mapped device (%d)",
    212 			    aa_args->handler_id);
    213 			rv = UNCONF;
    214 			break;
    215 		case ADBADDR_REL:
    216 			aprint_normal("relative positioning device (%d)",
    217 			    aa_args->handler_id);
    218 			rv = UNCONF;
    219 			break;
    220 #ifdef DIAGNOSTIC
    221 		case ADBADDR_ABS:
    222 			switch (aa_args->handler_id) {
    223 			case ADB_ARTPAD:
    224 				aprint_normal("WACOM ArtPad II");
    225 				break;
    226 			default:
    227 				aprint_normal("absolute positioning device (%d)",
    228 				    aa_args->handler_id);
    229 				break;
    230 			}
    231 			break;
    232 		case ADBADDR_DATATX:
    233 			aprint_normal("data transfer device (modem?) (%d)",
    234 			    aa_args->handler_id);
    235 			break;
    236 		case ADBADDR_MISC:
    237 			switch (aa_args->handler_id) {
    238 			case ADB_POWERKEY:
    239 				aprint_normal("Sophisticated Circuits PowerKey");
    240 				break;
    241 			default:
    242 				aprint_normal("misc. device (remote control?) (%d)",
    243 				    aa_args->handler_id);
    244 				break;
    245 			}
    246 			break;
    247 		default:
    248 			aprint_normal("unknown type device, (handler %d)",
    249 			    aa_args->handler_id);
    250 			break;
    251 #endif /* DIAGNOSTIC */
    252 		}
    253 	} else		/* a device matched and was configured */
    254 		aprint_normal(" addr %d: ", aa_args->adbaddr);
    255 
    256 	return (rv);
    257 }
    258 
    259 
    260 /*
    261  * adb_op_sync
    262  *
    263  * This routine does exactly what the adb_op routine does, except that after
    264  * the adb_op is called, it waits until the return value is present before
    265  * returning.
    266  *
    267  * NOTE: The user specified compRout is ignored, since this routine specifies
    268  * its own to adb_op, which is why you really called this in the first place
    269  * anyway.
    270  */
    271 int
    272 adb_op_sync(Ptr buffer, Ptr compRout, Ptr data, short command)
    273 {
    274 	int result;
    275 	volatile int flag = 0;
    276 
    277 	result = ADBOp(buffer, (void *)adb_op_comprout, __UNVOLATILE(&flag),
    278 	    command);	/* send command */
    279 	if (result == 0) {		/* send ok? */
    280 		adb_spin(&flag);
    281 		if (!flag)
    282 			result = -2;
    283 	}
    284 
    285 	return result;
    286 }
    287 
    288 /*
    289  * adb_spin
    290  *
    291  * Implements a spin-wait with timeout to be used for synchronous
    292  * operations on the ADB bus.
    293  *
    294  * Total time to wait is calculated as follows:
    295  *  - Tlt (stop to start time): 260 usec
    296  *  - start bit: 100 usec
    297  *  - up to 8 data bytes: 64 * 100 usec = 6400 usec
    298  *  - stop bit (with SRQ): 140 usec
    299  * Total: 6900 usec
    300  *
    301  * This is the total time allowed by the specification.  Any device that
    302  * doesn't conform to this will fail to operate properly on some Apple
    303  * systems.  In spite of this we double the time to wait; Cuda-based
    304  * systems apparently queue commands and allow the main CPU to continue
    305  * processing (how radical!).  To be safe, allow time for two complete
    306  * ADB transactions to occur.
    307  */
    308 void
    309 adb_spin(volatile int *fp)
    310 {
    311 	int tmout;
    312 
    313 	for (tmout = 13800; *fp == 0 && tmout >= 10; tmout -= 10)
    314 		delay(10);
    315 	if (*fp == 0 && tmout > 0)
    316 		delay(tmout);
    317 }
    318 
    319 
    320 /*
    321  * adb_op_comprout
    322  *
    323  * This function is used by the adb_op_sync routine so it knows when the
    324  * function is done.
    325  */
    326 void
    327 adb_op_comprout(void)
    328 {
    329 	__asm("movw	#1,%a2@			| update flag value");
    330 }
    331