xref: /xnu-12377.61.12/bsd/sys/loadable_fs.h (revision 4d495c6e23c53686cf65f45067f79024cf5dcee8)
1*4d495c6eSApple OSS Distributions /*
2*4d495c6eSApple OSS Distributions  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3*4d495c6eSApple OSS Distributions  *
4*4d495c6eSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*4d495c6eSApple OSS Distributions  *
6*4d495c6eSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*4d495c6eSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*4d495c6eSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*4d495c6eSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*4d495c6eSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*4d495c6eSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*4d495c6eSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*4d495c6eSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*4d495c6eSApple OSS Distributions  *
15*4d495c6eSApple OSS Distributions  * Please obtain a copy of the License at
16*4d495c6eSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*4d495c6eSApple OSS Distributions  *
18*4d495c6eSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*4d495c6eSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*4d495c6eSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*4d495c6eSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*4d495c6eSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*4d495c6eSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*4d495c6eSApple OSS Distributions  * limitations under the License.
25*4d495c6eSApple OSS Distributions  *
26*4d495c6eSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*4d495c6eSApple OSS Distributions  */
28*4d495c6eSApple OSS Distributions /*	@(#)loadable_fs.h	2.0	26/06/90	(c) 1990 NeXT	*/
29*4d495c6eSApple OSS Distributions 
30*4d495c6eSApple OSS Distributions /* XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
31*4d495c6eSApple OSS Distributions  *
32*4d495c6eSApple OSS Distributions  * W I L L    D R A S T I C A L L Y   C H A N G E   S O O N
33*4d495c6eSApple OSS Distributions  * U S E   A T  Y O U R   O W N  R I S K
34*4d495c6eSApple OSS Distributions  *
35*4d495c6eSApple OSS Distributions  * XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */
36*4d495c6eSApple OSS Distributions 
37*4d495c6eSApple OSS Distributions 
38*4d495c6eSApple OSS Distributions /*
39*4d495c6eSApple OSS Distributions  * loadable_fs.h - message struct for loading and initializing loadable
40*4d495c6eSApple OSS Distributions  *		   file systems.
41*4d495c6eSApple OSS Distributions  */
42*4d495c6eSApple OSS Distributions 
43*4d495c6eSApple OSS Distributions #ifndef _SYS_LOADABLE_FS_
44*4d495c6eSApple OSS Distributions #define _SYS_LOADABLE_FS_
45*4d495c6eSApple OSS Distributions 
46*4d495c6eSApple OSS Distributions 
47*4d495c6eSApple OSS Distributions /*
48*4d495c6eSApple OSS Distributions  * Constants for Loadable FS Utilities (in "/System/Library/Filesystems")
49*4d495c6eSApple OSS Distributions  *
50*4d495c6eSApple OSS Distributions  * Example of a /usr/filesystems directory
51*4d495c6eSApple OSS Distributions  *
52*4d495c6eSApple OSS Distributions  * /usr/filesystems/dos.fs/dos.util		utility with which WSM
53*4d495c6eSApple OSS Distributions  *							communicates
54*4d495c6eSApple OSS Distributions  * /usr/filesystems/dos.fs/dos.name             "DOS Floppy"
55*4d495c6eSApple OSS Distributions  * /usr/filesystems/dos.fs/dos_reloc		actual loadable filesystem
56*4d495c6eSApple OSS Distributions  * /usr/filesystems/dos.fs/dos.openfs.tiff	"open folder" icon
57*4d495c6eSApple OSS Distributions  * /usr/filesystems/dos.fs/dos.fs.tiff		"closed folder" icon
58*4d495c6eSApple OSS Distributions  */
59*4d495c6eSApple OSS Distributions #define FS_DIR_LOCATION         "/System/Library/Filesystems"
60*4d495c6eSApple OSS Distributions #define FS_DIR_SUFFIX           ".fs"
61*4d495c6eSApple OSS Distributions #define FS_UTIL_SUFFIX          ".util"
62*4d495c6eSApple OSS Distributions 
63*4d495c6eSApple OSS Distributions /*
64*4d495c6eSApple OSS Distributions  * .util program commands - all sent in the form "-p" or "-m" ... as argv[1].
65*4d495c6eSApple OSS Distributions  */
66*4d495c6eSApple OSS Distributions #define FSUC_PROBE              'p'     /* probe FS for mount or init */
67*4d495c6eSApple OSS Distributions /* example usage: foo.util -p fd0 removable writable */
68*4d495c6eSApple OSS Distributions 
69*4d495c6eSApple OSS Distributions #define FSUC_PROBEFORINIT       'P'     /* probe FS for init only */
70*4d495c6eSApple OSS Distributions /* example usage: foo.util -P fd0 removable */
71*4d495c6eSApple OSS Distributions 
72*4d495c6eSApple OSS Distributions #define FSUC_MOUNT              'm'     /* mount FS */
73*4d495c6eSApple OSS Distributions /* example usage: foo.util -m fd0 /bar removable writable */
74*4d495c6eSApple OSS Distributions 
75*4d495c6eSApple OSS Distributions #define FSUC_REPAIR             'r'     /* repair ('fsck') FS */
76*4d495c6eSApple OSS Distributions /* example usage: foo.util -r fd0 removable */
77*4d495c6eSApple OSS Distributions 
78*4d495c6eSApple OSS Distributions #define FSUC_UNMOUNT            'u'     /* unmount FS */
79*4d495c6eSApple OSS Distributions /* example usage: foo.util -u fd0 /bar */
80*4d495c6eSApple OSS Distributions 
81*4d495c6eSApple OSS Distributions /* The following is not used by Workspace Manager */
82*4d495c6eSApple OSS Distributions #define FSUC_MOUNT_FORCE        'M'     /* like FSUC_MOUNT, but proceed even on
83*4d495c6eSApple OSS Distributions 	                                 * error. */
84*4d495c6eSApple OSS Distributions /*
85*4d495c6eSApple OSS Distributions  * Return codes from .util program
86*4d495c6eSApple OSS Distributions  */
87*4d495c6eSApple OSS Distributions #define FSUR_RECOGNIZED         (-1)    /* response to FSUC_PROBE; implies that
88*4d495c6eSApple OSS Distributions 	                                 * a mount is possible */
89*4d495c6eSApple OSS Distributions #define FSUR_UNRECOGNIZED       (-2)    /* negative response to FSUC_PROBE */
90*4d495c6eSApple OSS Distributions #define FSUR_IO_SUCCESS         (-3)    /* mount, unmount, repair succeeded */
91*4d495c6eSApple OSS Distributions #define FSUR_IO_FAIL            (-4)    /* unrecoverable I/O error */
92*4d495c6eSApple OSS Distributions #define FSUR_IO_UNCLEAN         (-5)    /* mount failed, file system not clean
93*4d495c6eSApple OSS Distributions 	                                 */
94*4d495c6eSApple OSS Distributions #define FSUR_INVAL              (-6)    /* invalid argument */
95*4d495c6eSApple OSS Distributions #define FSUR_LOADERR            (-7)    /* kern_loader error */
96*4d495c6eSApple OSS Distributions #define FSUR_INITRECOGNIZED     (-8)    /* response to FSUC_PROBE or
97*4d495c6eSApple OSS Distributions 	                                 * FSUC_PROBEFORINIT, implies that
98*4d495c6eSApple OSS Distributions 	                                 * initialization is possible */
99*4d495c6eSApple OSS Distributions 
100*4d495c6eSApple OSS Distributions /*
101*4d495c6eSApple OSS Distributions  *	mount parameters passed from WSM to the .util program.
102*4d495c6eSApple OSS Distributions  */
103*4d495c6eSApple OSS Distributions #define DEVICE_READONLY         "readonly"
104*4d495c6eSApple OSS Distributions #define DEVICE_WRITABLE         "writable"
105*4d495c6eSApple OSS Distributions 
106*4d495c6eSApple OSS Distributions #define DEVICE_REMOVABLE        "removable"
107*4d495c6eSApple OSS Distributions #define DEVICE_FIXED            "fixed"
108*4d495c6eSApple OSS Distributions 
109*4d495c6eSApple OSS Distributions #endif  /* _SYS_LOADABLE_FS_ */
110