share/examples/kld/cdev/module/cdev.c

   1 /* 08 Nov 1998*/
   2 /*
   3  * cdev.c
   4  *
   5  * 08 Nov 1998  Rajesh Vaidheeswarran
   6  *
   7  * Copyright (c) 1998 Rajesh Vaidheeswarran
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by Rajesh Vaidheeswarran.
  21  * 4. The name Rajesh Vaidheeswarran may not be used to endorse or promote
  22  *    products derived from this software without specific prior written
  23  *    permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY RAJESH VAIDHEESWARRAN ``AS IS'' AND ANY
  26  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE RAJESH VAIDHEESWARRAN BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37   * Copyright (c) 1993 Terrence R. Lambert.
  38  * All rights reserved.
  39  *
  40  * Redistribution and use in source and binary forms, with or without
  41  * modification, are permitted provided that the following conditions
  42  * are met:
  43  * 1. Redistributions of source code must retain the above copyright
  44  *    notice, this list of conditions and the following disclaimer.
  45  * 2. Redistributions in binary form must reproduce the above copyright
  46  *    notice, this list of conditions and the following disclaimer in the
  47  *    documentation and/or other materials provided with the distribution.
  48  * 3. All advertising materials mentioning features or use of this software
  49  *    must display the following acknowledgement:
  50  *      This product includes software developed by Terrence R. Lambert.
  51  * 4. The name Terrence R. Lambert may not be used to endorse or promote
  52  *    products derived from this software without specific prior written
  53  *    permission.
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY TERRENCE R. LAMBERT ``AS IS'' AND ANY
  56  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE TERRENCE R. LAMBERT BE LIABLE
  59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  65  * SUCH DAMAGE.
  66  *
  67  *
  68  * $FreeBSD: src/share/examples/kld/cdev/module/cdev.c,v 1.3.2.1 2000/10/25 09:02:34 sobomax Exp $
  69  * $DragonFly: src/share/examples/kld/cdev/module/cdev.c,v 1.3 2006/10/18 21:38:23 victor Exp $
  70  */
  71 #include <sys/types.h>
  72 #include <sys/uio.h>
  73 #include <sys/param.h>
  74 #include <sys/systm.h>
  75 #include <sys/ioccom.h>
  76 #include <sys/systm.h>
  77 #include <sys/conf.h>
  78 #include <sys/device.h>
  79
  80 #include "cdev.h"
  81
  82 /*
  83  * This is the actual code for the system call... it can't be static because
  84  * it is exported to another part of the module... the only place it needs
  85  * to be referenced is the sysent we are interested in.
  86  *
  87  * To write your own system call using this as a template, you could strip
  88  * out this code and use the rest as a prototype module, changing only the
  89  * function names and the number of arguments to the call in the module
  90  * specific "sysent".
  91  *
  92  * You would have to use the "-R" option of "ld" to ensure a linkable file
  93  * if you were to do this, since you would need to combine multiple ".o"
  94  * files into a single ".o" file for use by "modload".
  95  */
  96
  97 #define CDEV_IOCTL1         _IOR('C', 1, u_int)
  98
  99 /* Stores string recv'd by _write() */
 100 static char buf[512+1];
 101 static int len;
 102
 103 int
 104 mydev_open(struct dev_open_args *args)
 105 {
 106     printf("mydev_open: dev_t=%d, flags=%x, type=%x\n",
 107            dev2udev(args->a_head.a_dev), args->a_oflags, args->a_devtype);
 108     memset(&buf, '\0', 513);
 109     len = 0;
 110     return (0);
 111 }
 112
 113 int
 114 mydev_close(struct dev_close_args *args)
 115 {
 116   printf("mydev_close: dev_t=%d, flags=%x, type=%x\n",
 117          dev2udev(args->a_head.a_dev), args->a_fflag, args->a_devtype);
 118   return (0);
 119 }
 120
 121 int
 122 mydev_ioctl(struct dev_ioctl_args *args)
 123 {
 124     int error = 0;
 125
 126     printf("mydev_ioctl: dev_t=%d, cmd=%lx, arg=%p, mode=%x\n",
 127            dev2udev(args->a_head.a_dev), args->a_cmd, args->a_data, args->a_fflag);
 128
 129     switch(args->a_cmd) {
 130     case CDEV_IOCTL1:
 131         printf("you called mydev_ioctl CDEV_IOCTL1\n");
 132         break;
 133     default:
 134         printf("No such ioctl for me!\n");
 135         error = EINVAL;
 136         break;
 137     }
 138     return error;
 139 }
 140
 141 /*
 142  * mydev_write takes in a character string and saves it
 143  * to buf for later accessing.
 144  */
 145 int
 146 mydev_write(struct dev_write_args *args)
 147 {
 148     int err = 0;
 149
 150     printf("mydev_write: dev_t=%d, uio=%p, ioflag=%d\n",
 151         dev2udev(args->a_head.a_dev), args->a_uio, args->a_ioflag);
 152
 153     err = copyinstr(args->a_uio->uio_iov->iov_base, &buf, 512, &len);
 154     if (err != 0) {
 155         printf("Write to \"cdev\" failed.\n");
 156     }
 157     return(err);
 158 }
 159
 160 /*
 161  * The mydev_read function just takes the buf that was saved
 162  * via mydev_write() and returns it to userland for
 163  * accessing.
 164  */
 165 int
 166 mydev_read(struct dev_read_args *args)
 167 {
 168     int err = 0;
 169
 170     printf("mydev_read: dev_t=%d, uio=%p, ioflag=%d\n",
 171         dev2udev(args->a_head.a_dev), args->a_uio, args->a_ioflag);
 172
 173     if (len <= 0) {
 174         err = -1;
 175     } else {    /* copy buf to userland */
 176         copystr(&buf, args->a_uio->uio_iov->iov_base, 513, &len);
 177     }
 178     return(err);
 179 }