Sync usage with man page.
[netbsd-mini2440.git] / sys / fs / cd9660 / iso.h
blob070f7e6d4c5a83776e645d810cdfe4359acd5906
1 /* $NetBSD: iso.h,v 1.8 2006/02/16 20:17:19 perry Exp $ */
3 /*-
4 * Copyright (c) 1994
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley
8 * by Pace Willisson (pace@blitz.com). The Rock Ridge Extension
9 * Support code is derived from software contributed to Berkeley
10 * by Atsushi Murai (amurai@spec.co.jp).
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
36 * @(#)iso.h 8.6 (Berkeley) 5/10/95
40 * Definitions describing ISO9660 file system structure, as well as
41 * the functions necessary to access fields of ISO9660 file system
42 * structures.
45 #ifndef _ISOFS_CD9660_ISO_H_
46 #define _ISOFS_CD9660_ISO_H_
48 #define ISODCL(from, to) (to - from + 1)
50 struct iso_volume_descriptor {
51 char type[ISODCL(1,1)]; /* 711 */
52 char id[ISODCL(2,6)];
53 char version[ISODCL(7,7)];
54 char data[ISODCL(8,2048)];
57 /* volume descriptor types */
58 #define ISO_VD_PRIMARY 1
59 #define ISO_VD_SUPPLEMENTARY 2
60 #define ISO_VD_END 255
62 #define ISO_STANDARD_ID "CD001"
63 #define ISO_ECMA_ID "CDW01"
65 struct iso_primary_descriptor {
66 char type [ISODCL ( 1, 1)]; /* 711 */
67 char id [ISODCL ( 2, 6)];
68 char version [ISODCL ( 7, 7)]; /* 711 */
69 char unused1 [ISODCL ( 8, 8)];
70 char system_id [ISODCL ( 9, 40)]; /* achars */
71 char volume_id [ISODCL ( 41, 72)]; /* dchars */
72 char unused2 [ISODCL ( 73, 80)];
73 char volume_space_size [ISODCL ( 81, 88)]; /* 733 */
74 char unused3 [ISODCL ( 89, 120)];
75 char volume_set_size [ISODCL (121, 124)]; /* 723 */
76 char volume_sequence_number [ISODCL (125, 128)]; /* 723 */
77 char logical_block_size [ISODCL (129, 132)]; /* 723 */
78 char path_table_size [ISODCL (133, 140)]; /* 733 */
79 char type_l_path_table [ISODCL (141, 144)]; /* 731 */
80 char opt_type_l_path_table [ISODCL (145, 148)]; /* 731 */
81 char type_m_path_table [ISODCL (149, 152)]; /* 732 */
82 char opt_type_m_path_table [ISODCL (153, 156)]; /* 732 */
83 char root_directory_record [ISODCL (157, 190)]; /* 9.1 */
84 char volume_set_id [ISODCL (191, 318)]; /* dchars */
85 char publisher_id [ISODCL (319, 446)]; /* achars */
86 char preparer_id [ISODCL (447, 574)]; /* achars */
87 char application_id [ISODCL (575, 702)]; /* achars */
88 char copyright_file_id [ISODCL (703, 739)]; /* 7.5 dchars */
89 char abstract_file_id [ISODCL (740, 776)]; /* 7.5 dchars */
90 char bibliographic_file_id [ISODCL (777, 813)]; /* 7.5 dchars */
91 char creation_date [ISODCL (814, 830)]; /* 8.4.26.1 */
92 char modification_date [ISODCL (831, 847)]; /* 8.4.26.1 */
93 char expiration_date [ISODCL (848, 864)]; /* 8.4.26.1 */
94 char effective_date [ISODCL (865, 881)]; /* 8.4.26.1 */
95 char file_structure_version [ISODCL (882, 882)]; /* 711 */
96 char unused4 [ISODCL (883, 883)];
97 char application_data [ISODCL (884, 1395)];
98 char unused5 [ISODCL (1396, 2048)];
100 #define ISO_DEFAULT_BLOCK_SIZE 2048
102 struct iso_supplementary_descriptor {
103 char type [ISODCL ( 1, 1)]; /* 711 */
104 char id [ISODCL ( 2, 6)];
105 char version [ISODCL ( 7, 7)]; /* 711 */
106 char flags [ISODCL ( 8, 8)]; /* 711? */
107 char system_id [ISODCL ( 9, 40)]; /* achars */
108 char volume_id [ISODCL ( 41, 72)]; /* dchars */
109 char unused2 [ISODCL ( 73, 80)];
110 char volume_space_size [ISODCL ( 81, 88)]; /* 733 */
111 char escape [ISODCL ( 89, 120)];
112 char volume_set_size [ISODCL (121, 124)]; /* 723 */
113 char volume_sequence_number [ISODCL (125, 128)]; /* 723 */
114 char logical_block_size [ISODCL (129, 132)]; /* 723 */
115 char path_table_size [ISODCL (133, 140)]; /* 733 */
116 char type_l_path_table [ISODCL (141, 144)]; /* 731 */
117 char opt_type_l_path_table [ISODCL (145, 148)]; /* 731 */
118 char type_m_path_table [ISODCL (149, 152)]; /* 732 */
119 char opt_type_m_path_table [ISODCL (153, 156)]; /* 732 */
120 char root_directory_record [ISODCL (157, 190)]; /* 9.1 */
121 char volume_set_id [ISODCL (191, 318)]; /* dchars */
122 char publisher_id [ISODCL (319, 446)]; /* achars */
123 char preparer_id [ISODCL (447, 574)]; /* achars */
124 char application_id [ISODCL (575, 702)]; /* achars */
125 char copyright_file_id [ISODCL (703, 739)]; /* 7.5 dchars */
126 char abstract_file_id [ISODCL (740, 776)]; /* 7.5 dchars */
127 char bibliographic_file_id [ISODCL (777, 813)]; /* 7.5 dchars */
128 char creation_date [ISODCL (814, 830)]; /* 8.4.26.1 */
129 char modification_date [ISODCL (831, 847)]; /* 8.4.26.1 */
130 char expiration_date [ISODCL (848, 864)]; /* 8.4.26.1 */
131 char effective_date [ISODCL (865, 881)]; /* 8.4.26.1 */
132 char file_structure_version [ISODCL (882, 882)]; /* 711 */
133 char unused4 [ISODCL (883, 883)];
134 char application_data [ISODCL (884, 1395)];
135 char unused5 [ISODCL (1396, 2048)];
138 struct iso_directory_record {
139 char length [ISODCL (1, 1)]; /* 711 */
140 char ext_attr_length [ISODCL (2, 2)]; /* 711 */
141 u_char extent [ISODCL (3, 10)]; /* 733 */
142 u_char size [ISODCL (11, 18)]; /* 733 */
143 char date [ISODCL (19, 25)]; /* 7 by 711 */
144 char flags [ISODCL (26, 26)];
145 char file_unit_size [ISODCL (27, 27)]; /* 711 */
146 char interleave [ISODCL (28, 28)]; /* 711 */
147 char volume_sequence_number [ISODCL (29, 32)]; /* 723 */
148 char name_len [ISODCL (33, 33)]; /* 711 */
149 char name [1]; /* XXX */
151 /* can't take sizeof(iso_directory_record), because of possible alignment
152 of the last entry (34 instead of 33) */
153 #define ISO_DIRECTORY_RECORD_SIZE 33
155 struct iso_extended_attributes {
156 u_char owner [ISODCL (1, 4)]; /* 723 */
157 u_char group [ISODCL (5, 8)]; /* 723 */
158 u_char perm [ISODCL (9, 10)]; /* 9.5.3 */
159 char ctime [ISODCL (11, 27)]; /* 8.4.26.1 */
160 char mtime [ISODCL (28, 44)]; /* 8.4.26.1 */
161 char xtime [ISODCL (45, 61)]; /* 8.4.26.1 */
162 char ftime [ISODCL (62, 78)]; /* 8.4.26.1 */
163 char recfmt [ISODCL (79, 79)]; /* 711 */
164 char recattr [ISODCL (80, 80)]; /* 711 */
165 u_char reclen [ISODCL (81, 84)]; /* 723 */
166 char system_id [ISODCL (85, 116)]; /* achars */
167 char system_use [ISODCL (117, 180)];
168 char version [ISODCL (181, 181)]; /* 711 */
169 char len_esc [ISODCL (182, 182)]; /* 711 */
170 char reserved [ISODCL (183, 246)];
171 u_char len_au [ISODCL (247, 250)]; /* 723 */
174 /* 7.1.1: unsigned char */
175 static __inline __unused int
176 isonum_711(const u_char *p)
178 return *p;
181 /* 7.1.2: signed char */
182 static __inline __unused int
183 isonum_712(const u_char *p)
185 return (signed char) *p;
188 /* 7.2.1: unsigned little-endian 16-bit value. NOT USED IN KERNEL. */
189 static __inline __unused uint16_t
190 isonum_721(const u_char *p)
192 return le16dec(p);
195 /* 7.2.2: unsigned big-endian 16-bit value. NOT USED IN KERNEL. */
196 static __inline __unused uint16_t
197 isonum_722(const u_char *p)
199 return be16dec(p);
202 /* 7.2.3: unsigned both-endian (little, then big) 16-bit value */
203 static __inline __unused uint16_t
204 isonum_723(const u_char *p)
206 #if BYTE_ORDER == BIG_ENDIAN
207 return be16dec(p + 2);
208 #else
209 return le16dec(p);
210 #endif
213 /* 7.3.1: unsigned little-endian 32-bit value. NOT USED IN KERNEL. */
214 static __inline __unused uint32_t
215 isonum_731(const u_char *p)
217 return le32dec(p);
220 /* 7.3.2: unsigned big-endian 32-bit value. NOT USED IN KERNEL. */
221 static __inline __unused uint32_t
222 isonum_732(const u_char *p)
224 return be32dec(p);
227 /* 7.3.3: unsigned both-endian (little, then big) 32-bit value */
228 static __inline __unused uint32_t
229 isonum_733(const u_char *p)
231 #if BYTE_ORDER == BIG_ENDIAN
232 return be32dec(p + 4);
233 #else
234 return le32dec(p);
235 #endif
239 * Associated files have a leading '='.
241 #define ASSOCCHAR '='
243 #endif /* _ISOFS_CD9660_ISO_H_ */