[apple/xnu.git] / bsd / miscfs / devfs / devfs.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright 1997,1998 Julian Elischer.  All rights reserved.
 * julian@freebsd.org
 * 
 * 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.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``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 HOLDER 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.
 * 
 * miscfs/devfs/devfs.h
 */

#ifndef _MISCFS_DEVFS_DEVFS_H_
#define	_MISCFS_DEVFS_DEVFS_H_

#include <sys/appleapiopts.h>

#define DEVFS_CHAR 	0
#define DEVFS_BLOCK 	1

/*
 * Argument to clone callback after dev
 */
#define	DEVFS_CLONE_ALLOC	1	/* Allocate minor number slot */
#define	DEVFS_CLONE_FREE	0	/* Free minor number slot */

__BEGIN_DECLS

/*
 * Function: devfs_make_node_clone
 *
 * Purpose
 *   Create a device node with the given pathname in the devfs namespace;
 *   before returning a dev_t value for an open instance, the dev_t has
 *   it's minor number updated by calling the supplied clone function on
 *   the supplied dev..
 *
 * Parameters:
 *   dev 	- the dev_t value to associate
 *   chrblk	- block or character device (DEVFS_CHAR or DEVFS_BLOCK)
 *   uid, gid	- ownership
 *   perms	- permissions
 *   clone	- minor number cloning function
 *   fmt, ...	- print format string and args to format the path name
 * Returns:
 *   A handle to a device node if successful, NULL otherwise.
 */
void * 	devfs_make_node_clone(dev_t dev, int chrblk, uid_t uid, gid_t gid, 
			     int perms, int (*clone)(dev_t dev, int action),
			     const char *fmt, ...);

/*
 * Function: devfs_make_node
 *
 * Purpose
 *   Create a device node with the given pathname in the devfs namespace.
 *
 * Parameters:
 *   dev 	- the dev_t value to associate
 *   chrblk	- block or character device (DEVFS_CHAR or DEVFS_BLOCK)
 *   uid, gid	- ownership
 *   perms	- permissions
 *   fmt, ...	- print format string and args to format the path name
 * Returns:
 *   A handle to a device node if successful, NULL otherwise.
 */
void * 	devfs_make_node(dev_t dev, int chrblk, uid_t uid, gid_t gid, 
			     int perms, const char *fmt, ...);

#ifdef BSD_KERNEL_PRIVATE
/*
 * Function: devfs_make_link
 *
 * Purpose:
 *   Create a link to a previously created device node.
 *
 * Returns:
 *   0 if successful, -1 if failed
 */
int	devfs_make_link(void * handle, char *fmt, ...);
#endif /* BSD_KERNEL_PRIVATE */

/*
 * Function: devfs_remove
 *
 * Purpose:
 *   Remove the device node returned by devfs_make_node() along with
 *   any links created with devfs_make_link().
 */
void	devfs_remove(void * handle);

__END_DECLS

#ifdef __APPLE_API_PRIVATE
/* XXX */
#define	UID_ROOT	0
#define	UID_BIN		3
#define	UID_UUCP	66

/* XXX */
#define	GID_WHEEL	0
#define	GID_KMEM	2
#define	GID_TTY		4
#define	GID_OPERATOR	5
#define	GID_BIN		7
#define	GID_GAMES	13
#define	GID_DIALER	68
#endif /* __APPLE_API_PRIVATE */

#endif /* !_MISCFS_DEVFS_DEVFS_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* Copyright 1997,1998 Julian Elischer. All rights reserved.
	30	* julian@freebsd.org
	31	*
	32	* Redistribution and use in source and binary forms, with or without
	33	* modification, are permitted provided that the following conditions are
	34	* met:
	35	* 1. Redistributions of source code must retain the above copyright
	36	* notice, this list of conditions and the following disclaimer.
	37	* 2. Redistributions in binary form must reproduce the above copyright notice,
	38	* this list of conditions and the following disclaimer in the documentation
	39	* and/or other materials provided with the distribution.
	40	*
	41	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS
	42	* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	43	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	44	* DISCLAIMED. IN NO EVENT SHALL THE HOLDER OR CONTRIBUTORS BE LIABLE FOR
	45	* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	46	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
	47	* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
	48	* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	49	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	50	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	51	* SUCH DAMAGE.
	52	*
	53	* miscfs/devfs/devfs.h
	54	*/
	55
	56	#ifndef _MISCFS_DEVFS_DEVFS_H_
	57	#define _MISCFS_DEVFS_DEVFS_H_
	58
9bccf70c A	59	#include <sys/appleapiopts.h>
9bccf70c A	60
1c79356b A	61	#define DEVFS_CHAR 0
	62	#define DEVFS_BLOCK 1
	63
2d21ac55 A	64	/*
	65	* Argument to clone callback after dev
	66	*/
	67	#define DEVFS_CLONE_ALLOC 1 /* Allocate minor number slot */
	68	#define DEVFS_CLONE_FREE 0 /* Free minor number slot */
	69
1c79356b A	70	__BEGIN_DECLS
1c79356b A	71
2d21ac55 A	72	/*
	73	* Function: devfs_make_node_clone
	74	*
	75	* Purpose
	76	* Create a device node with the given pathname in the devfs namespace;
	77	* before returning a dev_t value for an open instance, the dev_t has
	78	* it's minor number updated by calling the supplied clone function on
	79	* the supplied dev..
	80	*
	81	* Parameters:
	82	* dev - the dev_t value to associate
	83	* chrblk - block or character device (DEVFS_CHAR or DEVFS_BLOCK)
	84	* uid, gid - ownership
	85	* perms - permissions
	86	* clone - minor number cloning function
	87	* fmt, ... - print format string and args to format the path name
	88	* Returns:
	89	* A handle to a device node if successful, NULL otherwise.
	90	*/
	91	void * devfs_make_node_clone(dev_t dev, int chrblk, uid_t uid, gid_t gid,
	92	int perms, int (*clone)(dev_t dev, int action),
	93	const char *fmt, ...);
	94
1c79356b A	95	/*
	96	* Function: devfs_make_node
	97	*
	98	* Purpose
	99	* Create a device node with the given pathname in the devfs namespace.
	100	*
	101	* Parameters:
	102	* dev - the dev_t value to associate
	103	* chrblk - block or character device (DEVFS_CHAR or DEVFS_BLOCK)
	104	* uid, gid - ownership
	105	* perms - permissions
	106	* fmt, ... - print format string and args to format the path name
	107	* Returns:
	108	* A handle to a device node if successful, NULL otherwise.
	109	*/
91447636 A	110	void * devfs_make_node(dev_t dev, int chrblk, uid_t uid, gid_t gid,
91447636 A	111	int perms, const char *fmt, ...);
1c79356b	112
91447636	113	#ifdef BSD_KERNEL_PRIVATE
1c79356b A	114	/*
	115	* Function: devfs_make_link
	116	*
	117	* Purpose:
	118	* Create a link to a previously created device node.
	119	*
	120	* Returns:
	121	* 0 if successful, -1 if failed
	122	*/
2d21ac55	123	int devfs_make_link(void * handle, char *fmt, ...);
91447636	124	#endif /* BSD_KERNEL_PRIVATE */
1c79356b A	125
	126	/*
	127	* Function: devfs_remove
	128	*
	129	* Purpose:
	130	* Remove the device node returned by devfs_make_node() along with
	131	* any links created with devfs_make_link().
	132	*/
91447636	133	void devfs_remove(void * handle);
1c79356b A	134
	135	__END_DECLS
	136
9bccf70c	137	#ifdef __APPLE_API_PRIVATE
1c79356b A	138	/* XXX */
	139	#define UID_ROOT 0
	140	#define UID_BIN 3
	141	#define UID_UUCP 66
	142
	143	/* XXX */
	144	#define GID_WHEEL 0
	145	#define GID_KMEM 2
2d21ac55	146	#define GID_TTY 4
1c79356b A	147	#define GID_OPERATOR 5
	148	#define GID_BIN 7
	149	#define GID_GAMES 13
	150	#define GID_DIALER 68
9bccf70c	151	#endif /* __APPLE_API_PRIVATE */
1c79356b A	152
1c79356b A	153	#endif /* !_MISCFS_DEVFS_DEVFS_H_ */