sys/dev/misc/spigot/spigot.c

   1 /*
   2  * Video spigot capture driver.
   3  *
   4  * Copyright (c) 1995, Jim Lowe.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: 1. Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer. 2.
  10  * Redistributions in binary form must reproduce the above copyright notice,
  11  * this list of conditions and the following disclaimer in the documentation
  12  * and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  18  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  20  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  21  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * This is the minimum driver code required to make a spigot work.
  27  * Unfortunatly, I can't include a real driver since the information
  28  * on the spigot is under non-disclosure.  You can pick up a library
  29  * that will work with this driver from
  30  * ftp://ftp.cs.uwm.edu/pub/FreeBSD-UWM.  The library contains the
  31  * source that I can release as well as several object modules and
  32  * functions that allows one to read spigot data.  See the code for
  33  * spigot_grab.c that is included with the library data.
  34  *
  35  * The vendor will not allow me to release the spigot library code.
  36  * Please don't ask me for it.
  37  *
  38  * To use this driver you will need the spigot library.  The library is
  39  * available from:
  40  *
  41  *      ftp.cs.uwm.edu://pub/FreeBSD-UWM/spigot/spigot.tar.gz
  42  *
  43  * Version 1.7, December 1995.
  44  *
  45  * $FreeBSD: src/sys/i386/isa/spigot.c,v 1.44 2000/01/29 16:17:36 peter Exp $
  46  * $DragonFly: src/sys/dev/misc/spigot/spigot.c,v 1.15 2007/02/03 17:05:57 corecode Exp $
  47  *
  48  */
  49
  50 #include        "use_spigot.h"
  51
  52 #if NSPIGOT > 1
  53 error "Can only have 1 spigot configured."
  54 #endif
  55
  56 #include        "opt_spigot.h"
  57
  58 #include        <sys/param.h>
  59 #include        <sys/systm.h>
  60 #include        <sys/conf.h>
  61 #include        <sys/device.h>
  62 #include        <sys/proc.h>
  63 #include        <sys/signalvar.h>
  64 #include        <sys/mman.h>
  65
  66 #include        <machine/frame.h>
  67 #include        <machine/md_var.h>
  68 #include        <machine/spigot.h>
  69 #include        <machine/psl.h>
  70
  71 #include        <bus/isa/i386/isa_device.h>
  72
  73 static struct spigot_softc {
  74         u_long          flags;
  75         u_long          maddr;
  76         struct proc     *p;
  77         u_long          signal_num;
  78         u_short         irq;
  79 } spigot_softc[NSPIGOT];
  80
  81 /* flags in softc */
  82 #define OPEN            0x01
  83 #define ALIVE           0x02
  84
  85 #define UNIT(dev) minor(dev)
  86
  87 static int      spigot_probe(struct isa_device *id);
  88 static int      spigot_attach(struct isa_device *id);
  89
  90 struct isa_driver       spigotdriver = {spigot_probe, spigot_attach, "spigot"};
  91
  92 static  d_open_t        spigot_open;
  93 static  d_close_t       spigot_close;
  94 static  d_read_t        spigot_read;
  95 static  d_write_t       spigot_write;
  96 static  d_ioctl_t       spigot_ioctl;
  97 static  d_mmap_t        spigot_mmap;
  98
  99 #define CDEV_MAJOR 11
 100 static struct dev_ops spigot_ops = {
 101         { "spigot", CDEV_MAJOR, 0 },
 102         .d_open =       spigot_open,
 103         .d_close =      spigot_close,
 104         .d_read =       spigot_read,
 105         .d_write =      spigot_write,
 106         .d_ioctl =      spigot_ioctl,
 107         .d_mmap =       spigot_mmap,
 108 };
 109
 110 static void     spigintr(void *);
 111
 112 static int
 113 spigot_probe(struct isa_device *devp)
 114 {
 115         struct spigot_softc *ss;
 116         int status;
 117
 118         ss = (struct spigot_softc *)&spigot_softc[devp->id_unit];
 119         ss->flags = 0;
 120         ss->maddr = 0;
 121         ss->irq = 0;
 122
 123         if(devp->id_iobase != 0xad6 || inb(0xad9) == 0xff)
 124                 status = 0;     /* not found */
 125         else {
 126                 status = 1;     /* found */
 127                 ss->flags |= ALIVE;
 128         }
 129
 130         return(status);
 131 }
 132
 133 static int
 134 spigot_attach(struct isa_device *devp)
 135 {
 136         int     unit;
 137         struct  spigot_softc    *ss= &spigot_softc[unit = devp->id_unit];
 138
 139         devp->id_intr = (inthand2_t *)spigintr;
 140         ss->maddr = kvtop(devp->id_maddr);
 141         ss->irq = devp->id_irq;
 142         dev_ops_add(&spigot_ops, -1, unit);
 143         make_dev(&spigot_ops, unit, 0, 0, 0644, "spigot%d", unit);
 144         return 1;
 145 }
 146
 147 static  int
 148 spigot_open(struct dev_open_args *ap)
 149 {
 150         cdev_t dev = ap->a_head.a_dev;
 151         int error;
 152         struct spigot_softc *ss;
 153
 154         ss = (struct spigot_softc *)&spigot_softc[UNIT(dev)];
 155
 156         if((ss->flags & ALIVE) == 0)
 157                 return ENXIO;
 158
 159         if(ss->flags & OPEN)
 160                 return EBUSY;
 161
 162 #if !defined(SPIGOT_UNSECURE)
 163         /*
 164          * Don't allow open() unless the process has sufficient privileges,
 165          * since mapping the i/o page and granting i/o privilege would
 166          * require sufficient privilege soon and nothing much can be done
 167          * without them.
 168          */
 169         error = suser_cred(ap->a_cred, 0);
 170         if (error != 0)
 171                 return error;
 172         if (securelevel > 0)
 173                 return EPERM;
 174 #endif
 175
 176         ss->flags |= OPEN;
 177         ss->p = 0;
 178         ss->signal_num = 0;
 179
 180         return 0;
 181 }
 182
 183 static  int
 184 spigot_close(struct dev_close_args *ap)
 185 {
 186         cdev_t dev = ap->a_head.a_dev;
 187         struct spigot_softc *ss;
 188
 189         ss = (struct spigot_softc *)&spigot_softc[UNIT(dev)];
 190         ss->flags &= ~OPEN;
 191         ss->p = 0;
 192         ss->signal_num = 0;
 193
 194         outb(0xad6, 0);
 195
 196         return 0;
 197 }
 198
 199 static  int
 200 spigot_write(struct dev_write_args *ap)
 201 {
 202         return ENXIO;
 203 }
 204
 205 static  int
 206 spigot_read(struct dev_read_args *ap)
 207 {
 208         return ENXIO;
 209 }
 210
 211
 212 static  int
 213 spigot_ioctl(struct dev_ioctl_args *ap)
 214 {
 215         cdev_t dev = ap->a_head.a_dev;
 216         caddr_t data = ap->a_data;
 217         int error;
 218         struct spigot_softc *ss;
 219         struct spigot_info *info;
 220
 221         ss = (struct spigot_softc *)&spigot_softc[UNIT(dev)];
 222         if (data == NULL)
 223                 return(EINVAL);
 224
 225         switch(ap->a_cmd){
 226         case    SPIGOT_SETINT:
 227                 if (*(int *)data < 0 || *(int *)data > _SIG_MAXSIG)
 228                         return (EINVAL);
 229                 ss->p = curproc;
 230                 ss->signal_num = *((int *)data);
 231                 break;
 232         case    SPIGOT_IOPL_ON: /* allow access to the IO PAGE */
 233 #if !defined(SPIGOT_UNSECURE)
 234                 error = suser_cred(ap->a_cred, 0);
 235                 if (error != 0)
 236                         return error;
 237                 if (securelevel > 0)
 238                         return EPERM;
 239 #endif
 240                 curthread->td_lwp->lwp_md.md_regs->tf_eflags |= PSL_IOPL;
 241                 break;
 242         case    SPIGOT_IOPL_OFF: /* deny access to the IO PAGE */
 243                 curthread->td_lwp->lwp_md.md_regs->tf_eflags &= ~PSL_IOPL;
 244                 break;
 245         case    SPIGOT_GET_INFO:
 246                 info = (struct spigot_info *)data;
 247                 info->maddr  = ss->maddr;
 248                 info->irq = ss->irq;
 249                 break;
 250         default:
 251                 return ENOTTY;
 252         }
 253
 254         return 0;
 255 }
 256
 257 /*
 258  * Interrupt procedure.
 259  * Just call a user level interrupt routine.
 260  */
 261 static void
 262 spigintr(void *arg)
 263 {
 264         int unit = (int)arg;
 265         struct spigot_softc *ss;
 266
 267         ss = (struct spigot_softc *)&spigot_softc[unit];
 268         if(ss->p && ss->signal_num)
 269                 ksignal(ss->p, ss->signal_num);
 270 }
 271
 272 static  int
 273 spigot_mmap(struct dev_mmap_args *ap)
 274 {
 275         struct spigot_softc *ss;
 276
 277         ss = (struct spigot_softc *)&spigot_softc[0];
 278         if (ap->a_offset != 0)
 279                 return EINVAL;
 280         if (ap->a_nprot & PROT_EXEC)
 281                 return EINVAL;
 282         ap->a_result = i386_btop(ss->maddr);
 283         return(0);
 284 }