freebsd-dev

History

Bruce Evans 9463bb149a Updated lkm examples to work with prototype-related changes to the MOD_MISC() and DISPATCH() macros. Renamed new_syscall module as new_syscall_mod. It seems to be standard to have module names ending with _mod, and this may be forced when MOD_SYSCALL() and MOD_VFS() are updated to match MOD_MISC(). Cleaned up lkm examples a little.		1995-12-25 07:19:32 +00:00
..
module	Updated lkm examples to work with prototype-related changes to the	1995-12-25 07:19:32 +00:00
test	Updated lkm examples to work with prototype-related changes to the	1995-12-25 07:19:32 +00:00
Makefile	Updated lkm examples to work with prototype-related changes to the	1995-12-25 07:19:32 +00:00
README	Terry Lambert's loadable kernel module support - example modules.	1994-08-19 12:42:13 +00:00

README

# Copyright (c) 1993 Terrence R. Lambert.
# 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 Terrence R. Lambert.
# 4. The name Terrence R. Lambert may not be used to endorse or promote
#    products derived from this software without specific prior written
#    permission.
#
# THIS SOFTWARE IS PROVIDED BY TERRENCE R. LAMBERT ``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 TERRENCE R. LAMBERT 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.

1.0	Overview

	This is the README file for the sample loaded system call.


2.0	Directions

	To test the module, do the following:

		cd module
		make load

	A load message (the copyright) will be printed on the console.

		cd ../test
		make load

	The system call prints a message on the console when called.
	This message will be preinted when running "make load" in
	the "test" subdirectory.


3.0	Recovering resources

	The system call consumes 8 pages of memory when loaded; it
	can be freed up by unloading it.  To unload it, type the
	following from the directory this file is in:

		cd module
		make unload

	The system call will be unloaded by name.


4.0	END OF DOCUMENT