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