usr/src/sys/kern/tty_tb.c

/*-
 * Copyright (c) 1982, 1986, 1991 The Regents of the University of California.
 * 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 University of
 *      California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.
 *
 *      @(#)tty_tb.c    7.7 (Berkeley) 5/9/91
 */

#include "tb.h"
#if NTB > 0

/*
 * Line discipline for RS232 tablets;
 * supplies binary coordinate data.
 */
#include "param.h"
#include "tablet.h"
#include "tty.h"

/*
 * Tablet configuration table.
 */
struct  tbconf {
        short   tbc_recsize;    /* input record size in bytes */
        short   tbc_uiosize;    /* size of data record returned user */
        int     tbc_sync;       /* mask for finding sync byte/bit */
        int     (*tbc_decode)();/* decoding routine */
        char    *tbc_run;       /* enter run mode sequence */
        char    *tbc_point;     /* enter point mode sequence */
        char    *tbc_stop;      /* stop sequence */
        char    *tbc_start;     /* start/restart sequence */
        int     tbc_flags;
#define TBF_POL         0x1     /* polhemus hack */
#define TBF_INPROX      0x2     /* tablet has proximity info */
};

static  int tbdecode(), gtcodecode(), poldecode();
static  int tblresdecode(), tbhresdecode();

struct  tbconf tbconf[TBTYPE] = {
{ 0 },
{ 5, sizeof (struct tbpos), 0200, tbdecode, "6", "4" },
{ 5, sizeof (struct tbpos), 0200, tbdecode, "\1CN", "\1RT", "\2", "\4" },
{ 8, sizeof (struct gtcopos), 0200, gtcodecode },
{17, sizeof (struct polpos), 0200, poldecode, 0, 0, "\21", "\5\22\2\23",
  TBF_POL },
{ 5, sizeof (struct tbpos), 0100, tblresdecode, "\1CN", "\1PT", "\2", "\4",
  TBF_INPROX },
{ 6, sizeof (struct tbpos), 0200, tbhresdecode, "\1CN", "\1PT", "\2", "\4",
  TBF_INPROX },
{ 5, sizeof (struct tbpos), 0100, tblresdecode, "\1CL\33", "\1PT\33", 0, 0},
{ 6, sizeof (struct tbpos), 0200, tbhresdecode, "\1CL\33", "\1PT\33", 0, 0},
};

/*
 * Tablet state
 */
struct tb {
        int     tbflags;                /* mode & type bits */
#define TBMAXREC        17      /* max input record size */
        char    cbuf[TBMAXREC];         /* input buffer */
        union {
                struct  tbpos tbpos;
                struct  gtcopos gtcopos;
                struct  polpos polpos;
        } rets;                         /* processed state */
#define NTBS    16
} tb[NTBS];

/*
 * Open as tablet discipline; called on discipline change.
 */
/*ARGSUSED*/
tbopen(dev, tp)
        dev_t dev;
        register struct tty *tp;
{
        register struct tb *tbp;

        if (tp->t_line == TABLDISC)
                return (ENODEV);
        ttywflush(tp);
        for (tbp = tb; tbp < &tb[NTBS]; tbp++)
                if (tbp->tbflags == 0)
                        break;
        if (tbp >= &tb[NTBS])
                return (EBUSY);
        tbp->tbflags = TBTIGER|TBPOINT;         /* default */
        tp->t_cp = tbp->cbuf;
        tp->t_inbuf = 0;
        bzero((caddr_t)&tbp->rets, sizeof (tbp->rets));
        tp->T_LINEP = (caddr_t)tbp;
        tp->t_flags |= LITOUT;
        return (0);
}

/*
 * Line discipline change or last device close.
 */
tbclose(tp)
        register struct tty *tp;
{
        register int s;
        int modebits = TBPOINT|TBSTOP;

        tbioctl(tp, BIOSMODE, &modebits, 0);
        s = spltty();
        ((struct tb *)tp->T_LINEP)->tbflags = 0;
        tp->t_cp = 0;
        tp->t_inbuf = 0;
        tp->t_rawq.c_cc = 0;            /* clear queues -- paranoid */
        tp->t_canq.c_cc = 0;
        tp->t_line = 0;                 /* paranoid: avoid races */
        splx(s);
}

/*
 * Read from a tablet line.
 * Characters have been buffered in a buffer and decoded.
 */
tbread(tp, uio)
        register struct tty *tp;
        struct uio *uio;
{
        register struct tb *tbp = (struct tb *)tp->T_LINEP;
        register struct tbconf *tc = &tbconf[tbp->tbflags & TBTYPE];
        int ret;

        if ((tp->t_state&TS_CARR_ON) == 0)
                return (EIO);
        ret = uiomove(&tbp->rets, tc->tbc_uiosize, uio);
        if (tc->tbc_flags&TBF_POL)
                tbp->rets.polpos.p_key = ' ';
        return (ret);
}

/*
 * Low level character input routine.
 * Stuff the character in the buffer, and decode
 * if all the chars are there.
 *
 * This routine could be expanded in-line in the receiver
 * interrupt routine to make it run as fast as possible.
 */
tbinput(c, tp)
        register int c;
        register struct tty *tp;
{
        register struct tb *tbp = (struct tb *)tp->T_LINEP;
        register struct tbconf *tc = &tbconf[tbp->tbflags & TBTYPE];

        if (tc->tbc_recsize == 0 || tc->tbc_decode == 0)        /* paranoid? */
                return;
        /*
         * Locate sync bit/byte or reset input buffer.
         */
        if (c&tc->tbc_sync || tp->t_inbuf == tc->tbc_recsize) {
                tp->t_cp = tbp->cbuf;
                tp->t_inbuf = 0;
        }
        *tp->t_cp++ = c&0177;
        /*
         * Call decode routine only if a full record has been collected.
         */
        if (++tp->t_inbuf == tc->tbc_recsize)
                (*tc->tbc_decode)(tc, tbp->cbuf, &tbp->rets);
}

/*
 * Decode GTCO 8 byte format (high res, tilt, and pressure).
 */
static
gtcodecode(tc, cp, tbpos)
        struct tbconf *tc;
        register char *cp;
        register struct gtcopos *tbpos;
{

        tbpos->pressure = *cp >> 2;
        tbpos->status = (tbpos->pressure > 16) | TBINPROX; /* half way down */
        tbpos->xpos = (*cp++ & 03) << 14;
        tbpos->xpos |= *cp++ << 7;
        tbpos->xpos |= *cp++;
        tbpos->ypos = (*cp++ & 03) << 14;
        tbpos->ypos |= *cp++ << 7;
        tbpos->ypos |= *cp++;
        tbpos->xtilt = *cp++;
        tbpos->ytilt = *cp++;
        tbpos->scount++;
}

/*
 * Decode old Hitachi 5 byte format (low res).
 */
static
tbdecode(tc, cp, tbpos)
        struct tbconf *tc;
        register char *cp;
        register struct tbpos *tbpos;
{
        register char byte;

        byte = *cp++;
        tbpos->status = (byte&0100) ? TBINPROX : 0;
        byte &= ~0100;
        if (byte > 036)
                tbpos->status |= 1 << ((byte-040)/2);
        tbpos->xpos = *cp++ << 7;
        tbpos->xpos |= *cp++;
        if (tbpos->xpos < 256)                  /* tablet wraps around at 256 */
                tbpos->status &= ~TBINPROX;     /* make it out of proximity */
        tbpos->ypos = *cp++ << 7;
        tbpos->ypos |= *cp++;
        tbpos->scount++;
}

/*
 * Decode new Hitach 5-byte format (low res).
 */
static
tblresdecode(tc, cp, tbpos)
        struct tbconf *tc;
        register char *cp;
        register struct tbpos *tbpos;
{

        *cp &= ~0100;           /* mask sync bit */
        tbpos->status = (*cp++ >> 2) | TBINPROX;
        if (tc->tbc_flags&TBF_INPROX && tbpos->status&020)
                tbpos->status &= ~(020|TBINPROX);
        tbpos->xpos = *cp++;
        tbpos->xpos |= *cp++ << 6;
        tbpos->ypos = *cp++;
        tbpos->ypos |= *cp++ << 6;
        tbpos->scount++;
}

/*
 * Decode new Hitach 6-byte format (high res).
 */
static
tbhresdecode(tc, cp, tbpos)
        struct tbconf *tc;
        register char *cp;
        register struct tbpos *tbpos;
{
        char byte;

        byte = *cp++;
        tbpos->xpos = (byte & 03) << 14;
        tbpos->xpos |= *cp++ << 7;
        tbpos->xpos |= *cp++;
        tbpos->ypos = *cp++ << 14;
        tbpos->ypos |= *cp++ << 7;
        tbpos->ypos |= *cp++;
        tbpos->status = (byte >> 2) | TBINPROX;
        if (tc->tbc_flags&TBF_INPROX && tbpos->status&020)
                tbpos->status &= ~(020|TBINPROX);
        tbpos->scount++;
}

/*
 * Polhemus decode.
 */
static
poldecode(tc, cp, polpos)
        struct tbconf *tc;
        register char *cp;
        register struct polpos *polpos;
{

        polpos->p_x = cp[4] | cp[3]<<7 | (cp[9] & 0x03) << 14;
        polpos->p_y = cp[6] | cp[5]<<7 | (cp[9] & 0x0c) << 12;
        polpos->p_z = cp[8] | cp[7]<<7 | (cp[9] & 0x30) << 10;
        polpos->p_azi = cp[11] | cp[10]<<7 | (cp[16] & 0x03) << 14;
        polpos->p_pit = cp[13] | cp[12]<<7 | (cp[16] & 0x0c) << 12;
        polpos->p_rol = cp[15] | cp[14]<<7 | (cp[16] & 0x30) << 10;
        polpos->p_stat = cp[1] | cp[0]<<7;
        if (cp[2] != ' ')
                polpos->p_key = cp[2];
}

/*ARGSUSED*/
tbioctl(tp, cmd, data, flag)
        struct tty *tp;
        caddr_t data;
{
        register struct tb *tbp = (struct tb *)tp->T_LINEP;

        switch (cmd) {

        case BIOGMODE:
                *(int *)data = tbp->tbflags & TBMODE;
                break;

        case BIOSTYPE:
                if (tbconf[*(int *)data & TBTYPE].tbc_recsize == 0 ||
                    tbconf[*(int *)data & TBTYPE].tbc_decode == 0)
                        return (EINVAL);
                tbp->tbflags &= ~TBTYPE;
                tbp->tbflags |= *(int *)data & TBTYPE;
                /* fall thru... to set mode bits */

        case BIOSMODE: {
                register struct tbconf *tc;

                tbp->tbflags &= ~TBMODE;
                tbp->tbflags |= *(int *)data & TBMODE;
                tc = &tbconf[tbp->tbflags & TBTYPE];
                if (tbp->tbflags&TBSTOP) {
                        if (tc->tbc_stop)
                                ttyout(tc->tbc_stop, tp);
                } else if (tc->tbc_start)
                        ttyout(tc->tbc_start, tp);
                if (tbp->tbflags&TBPOINT) {
                        if (tc->tbc_point)
                                ttyout(tc->tbc_point, tp);
                } else if (tc->tbc_run)
                        ttyout(tc->tbc_run, tp);
                ttstart(tp);
                break;
        }

        case BIOGTYPE:
                *(int *)data = tbp->tbflags & TBTYPE;
                break;

        case TIOCSETD:
        case TIOCGETD:
        case TIOCGETP:
        case TIOCGETC:
                return (-1);            /* pass thru... */

        default:
                return (ENOTTY);
        }
        return (0);
}
#endif