1/*	$NetBSD: adbsys.h,v 1.13 2000/02/14 07:01:48 scottr Exp $	*/
  2
  3/*-
  4 * Copyright (C) 1993, 1994	Allen K. Briggs, Chris P. Caputo,
  5 *			Michael L. Finch, Bradley A. Grantham, and
  6 *			Lawrence A. Kesteloot
  7 * All rights reserved.
  8 *
  9 * Redistribution and use in source and binary forms, with or without
 10 * modification, are permitted provided that the following conditions
 11 * are met:
 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.
 17 * 3. All advertising materials mentioning features or use of this software
 18 *    must display the following acknowledgement:
 19 *	This product includes software developed by the Alice Group.
 20 * 4. The names of the Alice Group or any of its members may not be used
 21 *    to endorse or promote products derived from this software without
 22 *    specific prior written permission.
 23 *
 24 * THIS SOFTWARE IS PROVIDED BY THE ALICE GROUP ``AS IS'' AND ANY EXPRESS OR
 25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 26 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 27 * IN NO EVENT SHALL THE ALICE GROUP BE LIABLE FOR ANY DIRECT, INDIRECT,
 28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 29 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 34 */
 35
 36#ifndef _ADBSYS_MACHINE_
 37#define _ADBSYS_MACHINE_
 38
 39#include <sys/time.h>	/* timeval stuff */
 40#include <sys/ioctl.h>	/* ioctls */
 41
 42
 43/* Handy visual constants */
 44#define ADB_MAX_HANDLERS	256
 45#define ADB_MAX_DEVS	16
 46
 47
 48/* Different ADB system types */
 49enum adb_system_e {
 50	MacIIADB,
 51	MacIIsiADB,
 52	MacPBADB};
 53extern enum adb_system_e adb_system_type;
 54
 55
 56/* an ADB event */
 57typedef struct adb_event_s {
 58	int addr;			/* device address */
 59	int hand_id;			/* handler id */
 60	int def_addr;			/* default address */
 61	int byte_count;			/* number of bytes */
 62	unsigned char bytes[8];		/* bytes from register 0 */
 63	struct timeval timestamp;	/* time event was acquired */
 64	union {
 65		struct adb_keydata_s{
 66			int key;	/* ADB key code */
 67		} k;
 68		struct adb_mousedata_s{
 69			int dx;		/* mouse delta x */
 70			int dy;		/* mouse delta y */
 71			int buttons;	/* buttons (down << (buttonnum)) */
 72		} m;
 73	} u;				/* courtesy interpretation */
 74} adb_event_t;
 75
 76
 77/* a device on the ADB */
 78typedef struct adb_dev_s{
 79	int		addr;		/* current address */
 80	int		default_addr;	/* startup address */
 81	int		handler_id;	/* handler ID */
 82} adb_dev_t;
 83
 84
 85	/* Interesting default addresses */
 86#define	ADBADDR_SECURE	1		/* Security dongles */
 87#define ADBADDR_MAP	2		/* Mapped devices (keyboards/pads) */
 88#define ADBADDR_REL	3		/* Relative positioning devices
 89					   (mice, trackballs/pads) */
 90#define ADBADDR_ABS	4		/* Absolute positioning devices
 91					   (graphics tablets) */
 92#define ADBADDR_DATATX	5
 93#define ADBADDR_RSRVD	6		/* Reserved by Apple */
 94#define ADBADDR_MISC	7		/* Miscellaneous appliances */
 95#define ADBADDR_DONGLE	ADBADDR_SECURE
 96#define ADBADDR_KBD	ADBADDR_MAP
 97#define ADBADDR_MS	ADBADDR_REL
 98#define ADBADDR_TABLET	ADBADDR_ABS
 99#define ADBADDR_MODEM	ADBADDR_DATATX
100
101
102	/* Interesting keyboard handler IDs */
103#define ADB_STDKBD	1
104#define ADB_EXTKBD	2
105#define ADB_ISOKBD	4
106#define ADB_EXTISOKBD	5
107#define ADB_KBDII	8
108#define ADB_ISOKBDII	9
109#define ADB_PBKBD	12
110#define ADB_PBISOKBD	13
111#define ADB_ADJKPD	14
112#define ADB_ADJKBD	16
113#define ADB_ADJISOKBD	17
114#define ADB_ADJJAPKBD	18
115#define ADB_PBEXTISOKBD	20
116#define ADB_PBEXTJAPKBD	21
117#define ADB_JPKBDII	22
118#define ADB_PBEXTKBD	24
119#define ADB_DESIGNKBD	27	/* XXX Needs to be verified XXX */
120#define ADB_PBJPKBD	30
121
122	/* Interesting mouse handler IDs */
123#define ADBMS_100DPI	1
124#define ADBMS_200DPI	2
125#define ADBMS_MSA3	3	/* Mouse Systems A3 Mouse */
126#define ADBMS_EXTENDED	4	/* Extended mouse protocol */
127#define ADBMS_USPEED    0x2f	/* MicroSpeed mouse */
128#define ADBMS_UCONTOUR  0x66	/* Contour mouse */
129
130	/* Interesting tablet handler ID */
131#define ADB_ARTPAD	58	/* WACOM ArtPad II tablet */
132
133	/* Interesting miscellaneous handler ID */
134#define ADB_POWERKEY	34	/* Sophisticated Circuits PowerKey */
135				/* (intelligent power tap) */
136
137	/* Get device info from ADB system */
138typedef struct adb_devinfo_s{
139	adb_dev_t	dev[ADB_MAX_DEVS];
140		/* [addr].addr == -1 if none */ 
141} adb_devinfo_t;
142#define ADBIOC_DEVSINFO	_IOR('A', 128, adb_devinfo_t)
143
144
145	/* Event auto-repeat */
146typedef struct adb_rptinfo_s{
147	int delay_ticks;	/* ticks before repeat */
148	int interval_ticks;	/* ticks between repeats */
149} adb_rptinfo_t;
150#define ADBIOC_GETREPEAT	_IOR('A', 130, adb_rptinfo_t)
151#define ADBIOC_SETREPEAT	_IOW('A', 131, adb_rptinfo_t)
152
153
154	/* Reset and reinitialize */
155#define ADBIOC_RESET		_IO('A', 132)
156
157
158typedef struct adb_listencmd_s{
159	int address;		/* device address */
160	int reg;		/* register to which to send bytes */
161	int bytecnt;		/* number of bytes */
162	u_char bytes[8];	/* bytes */
163} adb_listencmd_t;
164#define ADBIOC_LISTENCMD	_IOW('A', 133, adb_listencmd_t)
165
166#endif /* _ADBSYS_MACHINE_ */