xref: /dragonfly/share/examples/kld/cdev/module/cdev.c (revision 31524921)
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 size_t len;
102 
103 int
104 mydev_open(struct dev_open_args *args)
105 {
106 	kprintf("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 
111 	return (0);
112 }
113 
114 int
115 mydev_close(struct dev_close_args *args)
116 {
117 	kprintf("mydev_close: dev_t=%d, flags=%x, type=%x\n",
118 	    dev2udev(args->a_head.a_dev), args->a_fflag, args->a_devtype);
119 
120 	return (0);
121 }
122 
123 int
124 mydev_ioctl(struct dev_ioctl_args *args)
125 {
126 	int error = 0;
127 
128 	kprintf("mydev_ioctl: dev_t=%d, cmd=%lx, arg=%p, mode=%x\n",
129 	    dev2udev(args->a_head.a_dev), args->a_cmd, args->a_data,
130 	    args->a_fflag);
131 
132 	switch(args->a_cmd) {
133 	case CDEV_IOCTL1:
134 		kprintf("you called mydev_ioctl CDEV_IOCTL1\n");
135 		break;
136 	default:
137 		kprintf("No such ioctl for me!\n");
138 		error = EINVAL;
139 		break;
140 	}
141 
142 	return (error);
143 }
144 
145 /*
146  * mydev_write takes in a character string and saves it
147  * to buf for later accessing.
148  */
149 int
150 mydev_write(struct dev_write_args *args)
151 {
152 	int err = 0;
153 
154 	kprintf("mydev_write: dev_t=%d, uio=%p, ioflag=%d\n",
155 	    dev2udev(args->a_head.a_dev), args->a_uio, args->a_ioflag);
156 
157 	err = copyinstr(args->a_uio->uio_iov->iov_base, &buf, 512, &len);
158 	if (err != 0) {
159 		kprintf("Write to \"cdev\" failed.\n");
160 	}
161 
162     return (err);
163 }
164 
165 /*
166  * The mydev_read function just takes the buf that was saved
167  * via mydev_write() and returns it to userland for
168  * accessing.
169  */
170 int
171 mydev_read(struct dev_read_args *args)
172 {
173 	int err = 0;
174 
175 	kprintf("mydev_read: dev_t=%d, uio=%p, ioflag=%d\n",
176 	    dev2udev(args->a_head.a_dev), args->a_uio, args->a_ioflag);
177 
178 	if (len <= 0) {
179 		err = -1;
180 	}
181 	else {
182 		/* copy buf to userland */
183 		copystr(&buf, args->a_uio->uio_iov->iov_base, 513, &len);
184 	}
185 
186 	return (err);
187 }
188