blob: 65ff47902bd25784940b9ac3bc7744fc9da0e04f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * osta_udf.h
3 *
4 * This file is based on OSTA UDF(tm) 2.50 (April 30, 2003)
5 * http://www.osta.org
6 *
7 * Copyright (c) 2001-2004 Ben Fennema <bfennema@falcon.csc.calpoly.edu>
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 * without modification.
16 * 2. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
18 *
19 * Alternatively, this software may be distributed under the terms of the
20 * GNU Public License ("GPL").
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
26 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 */
34
35#include "ecma_167.h"
36
37#ifndef _OSTA_UDF_H
38#define _OSTA_UDF_H 1
39
40/* OSTA CS0 Charspec (UDF 2.50 2.1.2) */
41#define UDF_CHAR_SET_TYPE 0
42#define UDF_CHAR_SET_INFO "OSTA Compressed Unicode"
43
44/* Entity Identifier (UDF 2.50 2.1.5) */
45/* Identifiers (UDF 2.50 2.1.5.2) */
46#define UDF_ID_DEVELOPER "*Linux UDFFS"
47#define UDF_ID_COMPLIANT "*OSTA UDF Compliant"
48#define UDF_ID_LV_INFO "*UDF LV Info"
49#define UDF_ID_FREE_EA "*UDF FreeEASpace"
50#define UDF_ID_FREE_APP_EA "*UDF FreeAppEASpace"
51#define UDF_ID_DVD_CGMS "*UDF DVD CGMS Info"
52#define UDF_ID_OS2_EA "*UDF OS/2 EA"
53#define UDF_ID_OS2_EA_LENGTH "*UDF OS/2 EALength"
54#define UDF_ID_MAC_VOLUME "*UDF Mac VolumeInfo"
55#define UDF_ID_MAC_FINDER "*UDF Mac FinderInfo"
56#define UDF_ID_MAC_UNIQUE "*UDF Mac UniqueIDTable"
57#define UDF_ID_MAC_RESOURCE "*UDF Mac ResourceFork"
58#define UDF_ID_VIRTUAL "*UDF Virtual Partition"
59#define UDF_ID_SPARABLE "*UDF Sparable Partition"
60#define UDF_ID_ALLOC "*UDF Virtual Alloc Tbl"
61#define UDF_ID_SPARING "*UDF Sparing Table"
62#define UDF_ID_METADATA "*UDF Metadata Partition"
63
64/* Identifier Suffix (UDF 2.50 2.1.5.3) */
65#define IS_DF_HARD_WRITE_PROTECT 0x01
66#define IS_DF_SOFT_WRITE_PROTECT 0x02
67
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -070068struct UDFIdentSuffix {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -070069 __le16 UDFRevision;
70 uint8_t OSClass;
71 uint8_t OSIdentifier;
72 uint8_t reserved[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -070073} __attribute__ ((packed));
74
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -070075struct impIdentSuffix {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -070076 uint8_t OSClass;
77 uint8_t OSIdentifier;
78 uint8_t reserved[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -070079} __attribute__ ((packed));
80
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -070081struct appIdentSuffix {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -070082 uint8_t impUse[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -070083} __attribute__ ((packed));
84
85/* Logical Volume Integrity Descriptor (UDF 2.50 2.2.6) */
86/* Implementation Use (UDF 2.50 2.2.6.4) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -070087struct logicalVolIntegrityDescImpUse {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -070088 regid impIdent;
89 __le32 numFiles;
90 __le32 numDirs;
91 __le16 minUDFReadRev;
92 __le16 minUDFWriteRev;
93 __le16 maxUDFWriteRev;
94 uint8_t impUse[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -070095} __attribute__ ((packed));
96
97/* Implementation Use Volume Descriptor (UDF 2.50 2.2.7) */
98/* Implementation Use (UDF 2.50 2.2.7.2) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -070099struct impUseVolDescImpUse {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700100 charspec LVICharset;
101 dstring logicalVolIdent[128];
102 dstring LVInfo1[36];
103 dstring LVInfo2[36];
104 dstring LVInfo3[36];
105 regid impIdent;
106 uint8_t impUse[128];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107} __attribute__ ((packed));
108
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700109struct udfPartitionMap2 {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700110 uint8_t partitionMapType;
111 uint8_t partitionMapLength;
112 uint8_t reserved1[2];
113 regid partIdent;
114 __le16 volSeqNum;
115 __le16 partitionNum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116} __attribute__ ((packed));
117
118/* Virtual Partition Map (UDF 2.50 2.2.8) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700119struct virtualPartitionMap {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700120 uint8_t partitionMapType;
121 uint8_t partitionMapLength;
122 uint8_t reserved1[2];
123 regid partIdent;
124 __le16 volSeqNum;
125 __le16 partitionNum;
126 uint8_t reserved2[24];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127} __attribute__ ((packed));
128
129/* Sparable Partition Map (UDF 2.50 2.2.9) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700130struct sparablePartitionMap {
131 uint8_t partitionMapType;
132 uint8_t partitionMapLength;
133 uint8_t reserved1[2];
134 regid partIdent;
135 __le16 volSeqNum;
136 __le16 partitionNum;
137 __le16 packetLength;
138 uint8_t numSparingTables;
139 uint8_t reserved2[1];
140 __le32 sizeSparingTable;
141 __le32 locSparingTable[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142} __attribute__ ((packed));
143
144/* Metadata Partition Map (UDF 2.4.0 2.2.10) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700145struct metadataPartitionMap {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700146 uint8_t partitionMapType;
147 uint8_t partitionMapLength;
148 uint8_t reserved1[2];
149 regid partIdent;
150 __le16 volSeqNum;
151 __le16 partitionNum;
152 __le32 metadataFileLoc;
153 __le32 metadataMirrorFileLoc;
154 __le32 metadataBitmapFileLoc;
155 __le32 allocUnitSize;
156 __le16 alignUnitSize;
157 uint8_t flags;
158 uint8_t reserved2[5];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159} __attribute__ ((packed));
160
161/* Virtual Allocation Table (UDF 1.5 2.2.10) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700162struct virtualAllocationTable15 {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700163 __le32 VirtualSector[0];
164 regid vatIdent;
165 __le32 previousVATICBLoc;
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700166} __attribute__ ((packed));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168#define ICBTAG_FILE_TYPE_VAT15 0x00U
169
170/* Virtual Allocation Table (UDF 2.50 2.2.11) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700171struct virtualAllocationTable20 {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700172 __le16 lengthHeader;
173 __le16 lengthImpUse;
174 dstring logicalVolIdent[128];
175 __le32 previousVATICBLoc;
176 __le32 numFiles;
177 __le32 numDirs;
178 __le16 minReadRevision;
179 __le16 minWriteRevision;
180 __le16 maxWriteRevision;
181 __le16 reserved;
182 uint8_t impUse[0];
183 __le32 vatEntry[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184} __attribute__ ((packed));
185
186#define ICBTAG_FILE_TYPE_VAT20 0xF8U
187
188/* Sparing Table (UDF 2.50 2.2.12) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700189struct sparingEntry {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700190 __le32 origLocation;
191 __le32 mappedLocation;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192} __attribute__ ((packed));
193
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700194struct sparingTable {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700195 tag descTag;
196 regid sparingIdent;
197 __le16 reallocationTableLen;
198 __le16 reserved;
199 __le32 sequenceNum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 struct sparingEntry
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700201 mapEntry[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202} __attribute__ ((packed));
203
204/* Metadata File (and Metadata Mirror File) (UDF 2.50 2.2.13.1) */
205#define ICBTAG_FILE_TYPE_MAIN 0xFA
206#define ICBTAG_FILE_TYPE_MIRROR 0xFB
207#define ICBTAG_FILE_TYPE_BITMAP 0xFC
208
209/* struct long_ad ICB - ADImpUse (UDF 2.50 2.2.4.3) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700210struct allocDescImpUse {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700211 __le16 flags;
212 uint8_t impUse[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213} __attribute__ ((packed));
214
215#define AD_IU_EXT_ERASED 0x0001
216
217/* Real-Time Files (UDF 2.50 6.11) */
218#define ICBTAG_FILE_TYPE_REALTIME 0xF9U
219
220/* Implementation Use Extended Attribute (UDF 2.50 3.3.4.5) */
221/* FreeEASpace (UDF 2.50 3.3.4.5.1.1) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700222struct freeEaSpace {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700223 __le16 headerChecksum;
224 uint8_t freeEASpace[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225} __attribute__ ((packed));
226
227/* DVD Copyright Management Information (UDF 2.50 3.3.4.5.1.2) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700228struct DVDCopyrightImpUse {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700229 __le16 headerChecksum;
230 uint8_t CGMSInfo;
231 uint8_t dataType;
232 uint8_t protectionSystemInfo[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233} __attribute__ ((packed));
234
235/* Application Use Extended Attribute (UDF 2.50 3.3.4.6) */
236/* FreeAppEASpace (UDF 2.50 3.3.4.6.1) */
Cyrill Gorcunovcb00ea32007-07-19 01:47:43 -0700237struct freeAppEASpace {
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700238 __le16 headerChecksum;
239 uint8_t freeEASpace[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240} __attribute__ ((packed));
241
242/* UDF Defined System Stream (UDF 2.50 3.3.7) */
243#define UDF_ID_UNIQUE_ID "*UDF Unique ID Mapping Data"
244#define UDF_ID_NON_ALLOC "*UDF Non-Allocatable Space"
245#define UDF_ID_POWER_CAL "*UDF Power Cal Table"
246#define UDF_ID_BACKUP "*UDF Backup"
247
248/* Operating System Identifiers (UDF 2.50 6.3) */
249#define UDF_OS_CLASS_UNDEF 0x00U
250#define UDF_OS_CLASS_DOS 0x01U
251#define UDF_OS_CLASS_OS2 0x02U
252#define UDF_OS_CLASS_MAC 0x03U
253#define UDF_OS_CLASS_UNIX 0x04U
254#define UDF_OS_CLASS_WIN9X 0x05U
255#define UDF_OS_CLASS_WINNT 0x06U
256#define UDF_OS_CLASS_OS400 0x07U
257#define UDF_OS_CLASS_BEOS 0x08U
258#define UDF_OS_CLASS_WINCE 0x09U
259
260#define UDF_OS_ID_UNDEF 0x00U
261#define UDF_OS_ID_DOS 0x00U
262#define UDF_OS_ID_OS2 0x00U
263#define UDF_OS_ID_MAC 0x00U
264#define UDF_OS_ID_MAX_OSX 0x01U
265#define UDF_OS_ID_UNIX 0x00U
266#define UDF_OS_ID_AIX 0x01U
267#define UDF_OS_ID_SOLARIS 0x02U
268#define UDF_OS_ID_HPUX 0x03U
269#define UDF_OS_ID_IRIX 0x04U
270#define UDF_OS_ID_LINUX 0x05U
271#define UDF_OS_ID_MKLINUX 0x06U
272#define UDF_OS_ID_FREEBSD 0x07U
273#define UDF_OS_ID_WIN9X 0x00U
274#define UDF_OS_ID_WINNT 0x00U
275#define UDF_OS_ID_OS400 0x00U
276#define UDF_OS_ID_BEOS 0x00U
277#define UDF_OS_ID_WINCE 0x00U
278
Cyrill Gorcunov28de7942007-07-21 04:37:18 -0700279#endif /* _OSTA_UDF_H */