/*      $OpenBSD: adb.h,v 1.6 2022/10/21 22:42:36 gkoehler Exp $        */
/*      $NetBSD: adbsys.h,v 1.4 2000/12/19 02:59:24 tsubai Exp $        */

/*-
 * Copyright (C) 1993, 1994     Allen K. Briggs, Chris P. Caputo,
 *                      Michael L. Finch, Bradley A. Grantham, and
 *                      Lawrence A. Kesteloot
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the Alice Group.
 * 4. The names of the Alice Group or any of its members may not be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE ALICE GROUP ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE ALICE GROUP BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _ADB_H_
#define _ADB_H_

#ifdef _KERNEL

/*
 * Arguments used to attach a device to the Apple Desktop Bus
 */
struct adb_attach_args {
        const char      *name;          /* adb_device_name if real adb device */
        int              origaddr;
        int              adbaddr;
        int              handler_id;
};

extern const char adb_device_name[];

#define ADB_CMDADDR(cmd)        ((u_int8_t)(cmd & 0xf0) >> 4)
#define ADBFLUSH(dev)           ((((u_int8_t)dev & 0x0f) << 4) | 0x01)
#define ADBLISTEN(dev, reg)     ((((u_int8_t)dev & 0x0f) << 4) | 0x08 | reg)
#define ADBTALK(dev, reg)       ((((u_int8_t)dev & 0x0f) << 4) | 0x0c | reg)

/* an ADB event */
typedef struct adb_event_s {
        int byte_count;                 /* number of bytes */
        unsigned char bytes[8];         /* bytes from register 0 */
} adb_event_t;

        /* Interesting default addresses */
#define ADBADDR_SECURE  1               /* Security dongles */
#define ADBADDR_MAP     2               /* Mapped devices (keyboards/pads) */
#define ADBADDR_REL     3               /* Relative positioning devices
                                           (mice, trackballs/pads) */
#define ADBADDR_ABS     4               /* Absolute positioning devices
                                           (graphics tablets) */
#define ADBADDR_DATATX  5
#define ADBADDR_RSRVD   6               /* Reserved by Apple */
#define ADBADDR_MISC    7               /* Miscellaneous appliances */
#define ADBADDR_DONGLE  ADBADDR_SECURE
#define ADBADDR_KBD     ADBADDR_MAP
#define ADBADDR_MS      ADBADDR_REL
#define ADBADDR_TABLET  ADBADDR_ABS
#define ADBADDR_MODEM   ADBADDR_DATATX

        /* Interesting keyboard handler IDs */
#define ADB_STDKBD      1
#define ADB_EXTKBD      2
#define ADB_ISOKBD      4
#define ADB_EXTISOKBD   5
#define ADB_KBDII       8
#define ADB_ISOKBDII    9
#define ADB_PBKBD       12
#define ADB_PBISOKBD    13
#define ADB_ADJKPD      14
#define ADB_ADJKBD      16
#define ADB_ADJISOKBD   17
#define ADB_ADJJAPKBD   18
#define ADB_PBEXTISOKBD 20
#define ADB_PBEXTJAPKBD 21
#define ADB_JPKBDII     22
#define ADB_PBEXTKBD    24
#define ADB_DESIGNKBD   27      /* XXX Needs to be verified XXX */
#define ADB_PBJPKBD     30
#define ADB_PBG4KBD     195
#define ADB_IBITISOKBD  196
#define ADB_PBG3JPKBD   201

        /* Interesting mouse handler IDs */
#define ADBMS_100DPI    1
#define ADBMS_200DPI    2
#define ADBMS_MSA3      3       /* Mouse Systems A3 Mouse */
#define ADBMS_EXTENDED  4       /* Extended mouse protocol */
#define ADBMS_USPEED    0x2f    /* MicroSpeed mouse */
#define ADBMS_UCONTOUR  0x66    /* Contour mouse */
#define ADBMS_TURBO     50      /* Kensington Turbo Mouse */

        /* Interesting tablet handler ID */
#define ADB_ARTPAD      58      /* WACOM ArtPad II tablet */

        /* Interesting miscellaneous handler ID */
#define ADB_POWERKEY    34      /* Sophisticated Circuits PowerKey */
                                /* (intelligent power tap) */

extern int      adb_polling;
#ifdef ADB_DEBUG
extern int      adb_debug;
#endif

/* ADB Manager */

typedef caddr_t Ptr;

typedef struct {
        Ptr siServiceRtPtr;
        Ptr siDataAreaAddr;
} ADBSetInfoBlock;

typedef struct {
        unsigned char   devType;
        unsigned char   origADBAddr;
        Ptr             dbServiceRtPtr;
        Ptr             dbDataAreaAddr;
} ADBDataBlock;

int     adbprint(void *, const char *);
void    adb_lid_closed_intr(void);
void    adb_power_button_intr(void);
int     adb_op_sync(Ptr, short);
int     set_adb_info(ADBSetInfoBlock *, int);

#endif  /* _KERNEL */

#endif /* _ADB_H_ */