hc
2024-11-01 7e970c18f85f99acc678d90128b6e01dce1bf273
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
/*
 * ecma_167.h
 *
 * This file is based on ECMA-167 3rd edition (June 1997)
 * https://www.ecma.ch
 *
 * Copyright (c) 2001-2002  Ben Fennema
 * Copyright (c) 2017-2019  Pali Rohár <pali@kernel.org>
 * 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,
 *    without modification.
 * 2. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU Public License ("GPL").
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 AUTHOR 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.
 */
 
/**
 * @file
 * ECMA-167r3 defines and structure definitions
 */
 
#include <linux/types.h>
 
#ifndef _ECMA_167_H
#define _ECMA_167_H 1
 
/* Character sets and coding - d-characters (ECMA 167r3 1/7.2) */
typedef uint8_t        dchars;
 
/* Character set specification (ECMA 167r3 1/7.2.1) */
struct charspec {
   uint8_t        charSetType;
   uint8_t        charSetInfo[63];
} __packed;
 
/* Character Set Type (ECMA 167r3 1/7.2.1.1) */
#define CHARSPEC_TYPE_CS0        0x00    /* (1/7.2.2) */
#define CHARSPEC_TYPE_CS1        0x01    /* (1/7.2.3) */
#define CHARSPEC_TYPE_CS2        0x02    /* (1/7.2.4) */
#define CHARSPEC_TYPE_CS3        0x03    /* (1/7.2.5) */
#define CHARSPEC_TYPE_CS4        0x04    /* (1/7.2.6) */
#define CHARSPEC_TYPE_CS5        0x05    /* (1/7.2.7) */
#define CHARSPEC_TYPE_CS6        0x06    /* (1/7.2.8) */
#define CHARSPEC_TYPE_CS7        0x07    /* (1/7.2.9) */
#define CHARSPEC_TYPE_CS8        0x08    /* (1/7.2.10) */
 
/* Fixed-length character fields - d-string (EMCA 167r3 1/7.2.12) */
typedef uint8_t        dstring;
 
/* Timestamp (ECMA 167r3 1/7.3) */
struct timestamp {
   __le16        typeAndTimezone;
   __le16        year;
   uint8_t        month;
   uint8_t        day;
   uint8_t        hour;
   uint8_t        minute;
   uint8_t        second;
   uint8_t        centiseconds;
   uint8_t        hundredsOfMicroseconds;
   uint8_t        microseconds;
} __packed;
 
/* Type and Time Zone (ECMA 167r3 1/7.3.1) */
#define TIMESTAMP_TYPE_MASK        0xF000
#define TIMESTAMP_TYPE_CUT        0x0000
#define TIMESTAMP_TYPE_LOCAL        0x1000
#define TIMESTAMP_TYPE_AGREEMENT    0x2000
#define TIMESTAMP_TIMEZONE_MASK        0x0FFF
 
/* Entity identifier (ECMA 167r3 1/7.4) */
struct regid {
   uint8_t        flags;
   uint8_t        ident[23];
   uint8_t        identSuffix[8];
} __packed;
 
/* Flags (ECMA 167r3 1/7.4.1) */
#define ENTITYID_FLAGS_DIRTY        0x01
#define ENTITYID_FLAGS_PROTECTED    0x02
 
/* Volume Structure Descriptor (ECMA 167r3 2/9.1) */
#define VSD_STD_ID_LEN            5
struct volStructDesc {
   uint8_t        structType;
   uint8_t        stdIdent[VSD_STD_ID_LEN];
   uint8_t        structVersion;
   uint8_t        structData[2041];
} __packed;
 
/* Standard Identifier (EMCA 167r2 2/9.1.2) */
#define VSD_STD_ID_NSR02        "NSR02"    /* (3/9.1) */
 
/* Standard Identifier (ECMA 167r3 2/9.1.2) */
#define VSD_STD_ID_BEA01        "BEA01"    /* (2/9.2) */
#define VSD_STD_ID_BOOT2        "BOOT2"    /* (2/9.4) */
#define VSD_STD_ID_CD001        "CD001"    /* (ECMA-119) */
#define VSD_STD_ID_CDW02        "CDW02"    /* (ECMA-168) */
#define VSD_STD_ID_NSR03        "NSR03"    /* (3/9.1) */
#define VSD_STD_ID_TEA01        "TEA01"    /* (2/9.3) */
 
/* Beginning Extended Area Descriptor (ECMA 167r3 2/9.2) */
struct beginningExtendedAreaDesc {
   uint8_t        structType;
   uint8_t        stdIdent[VSD_STD_ID_LEN];
   uint8_t        structVersion;
   uint8_t        structData[2041];
} __packed;
 
/* Terminating Extended Area Descriptor (ECMA 167r3 2/9.3) */
struct terminatingExtendedAreaDesc {
   uint8_t        structType;
   uint8_t        stdIdent[VSD_STD_ID_LEN];
   uint8_t        structVersion;
   uint8_t        structData[2041];
} __packed;
 
/* Boot Descriptor (ECMA 167r3 2/9.4) */
struct bootDesc {
   uint8_t            structType;
   uint8_t            stdIdent[VSD_STD_ID_LEN];
   uint8_t            structVersion;
   uint8_t            reserved1;
   struct regid        archType;
   struct regid        bootIdent;
   __le32            bootExtLocation;
   __le32            bootExtLength;
   __le64            loadAddress;
   __le64            startAddress;
   struct timestamp    descCreationDateAndTime;
   __le16            flags;
   uint8_t            reserved2[32];
   uint8_t            bootUse[1906];
} __packed;
 
/* Flags (ECMA 167r3 2/9.4.12) */
#define BOOT_FLAGS_ERASE        0x01
 
/* Extent Descriptor (ECMA 167r3 3/7.1) */
struct extent_ad {
   __le32        extLength;
   __le32        extLocation;
} __packed;
 
struct kernel_extent_ad {
   uint32_t    extLength;
   uint32_t    extLocation;
};
 
/* Descriptor Tag (ECMA 167r3 3/7.2) */
struct tag {
   __le16        tagIdent;
   __le16        descVersion;
   uint8_t        tagChecksum;
   uint8_t        reserved;
   __le16        tagSerialNum;
   __le16        descCRC;
   __le16        descCRCLength;
   __le32        tagLocation;
} __packed;
 
/* Tag Identifier (ECMA 167r3 3/7.2.1) */
#define TAG_IDENT_PVD            0x0001
#define TAG_IDENT_AVDP            0x0002
#define TAG_IDENT_VDP            0x0003
#define TAG_IDENT_IUVD            0x0004
#define TAG_IDENT_PD            0x0005
#define TAG_IDENT_LVD            0x0006
#define TAG_IDENT_USD            0x0007
#define TAG_IDENT_TD            0x0008
#define TAG_IDENT_LVID            0x0009
 
/* NSR Descriptor (ECMA 167r3 3/9.1) */
struct NSRDesc {
   uint8_t        structType;
   uint8_t        stdIdent[VSD_STD_ID_LEN];
   uint8_t        structVersion;
   uint8_t        reserved;
   uint8_t        structData[2040];
} __packed;
 
/* Generic Descriptor */
struct genericDesc {
   struct tag    descTag;
   __le32        volDescSeqNum;
   uint8_t        reserved[492];
} __packed;
 
/* Primary Volume Descriptor (ECMA 167r3 3/10.1) */
struct primaryVolDesc {
   struct tag        descTag;
   __le32            volDescSeqNum;
   __le32            primaryVolDescNum;
   dstring            volIdent[32];
   __le16            volSeqNum;
   __le16            maxVolSeqNum;
   __le16            interchangeLvl;
   __le16            maxInterchangeLvl;
   __le32            charSetList;
   __le32            maxCharSetList;
   dstring            volSetIdent[128];
   struct charspec        descCharSet;
   struct charspec        explanatoryCharSet;
   struct extent_ad    volAbstract;
   struct extent_ad    volCopyright;
   struct regid        appIdent;
   struct timestamp    recordingDateAndTime;
   struct regid        impIdent;
   uint8_t            impUse[64];
   __le32            predecessorVolDescSeqLocation;
   __le16            flags;
   uint8_t            reserved[22];
} __packed;
 
/* Flags (ECMA 167r3 3/10.1.21) */
#define PVD_FLAGS_VSID_COMMON        0x0001
 
/* Anchor Volume Descriptor Pointer (ECMA 167r3 3/10.2) */
struct anchorVolDescPtr {
   struct tag        descTag;
   struct extent_ad    mainVolDescSeqExt;
   struct extent_ad    reserveVolDescSeqExt;
   uint8_t             reserved[480];
} __packed;
 
/* Volume Descriptor Pointer (ECMA 167r3 3/10.3) */
struct volDescPtr {
   struct tag        descTag;
   __le32            volDescSeqNum;
   struct extent_ad    nextVolDescSeqExt;
   uint8_t            reserved[484];
} __packed;
 
/* Implementation Use Volume Descriptor (ECMA 167r3 3/10.4) */
struct impUseVolDesc {
   struct tag    descTag;
   __le32        volDescSeqNum;
   struct regid    impIdent;
   uint8_t        impUse[460];
} __packed;
 
/* Partition Descriptor (ECMA 167r3 3/10.5) */
struct partitionDesc {
   struct tag descTag;
   __le32 volDescSeqNum;
   __le16 partitionFlags;
   __le16 partitionNumber;
   struct regid partitionContents;
   uint8_t partitionContentsUse[128];
   __le32 accessType;
   __le32 partitionStartingLocation;
   __le32 partitionLength;
   struct regid impIdent;
   uint8_t impUse[128];
   uint8_t reserved[156];
} __packed;
 
/* Partition Flags (ECMA 167r3 3/10.5.3) */
#define PD_PARTITION_FLAGS_ALLOC    0x0001
 
/* Partition Contents (ECMA 167r2 3/10.5.3) */
#define PD_PARTITION_CONTENTS_NSR02    "+NSR02"
 
/* Partition Contents (ECMA 167r3 3/10.5.5) */
#define PD_PARTITION_CONTENTS_FDC01    "+FDC01"
#define PD_PARTITION_CONTENTS_CD001    "+CD001"
#define PD_PARTITION_CONTENTS_CDW02    "+CDW02"
#define PD_PARTITION_CONTENTS_NSR03    "+NSR03"
 
/* Access Type (ECMA 167r3 3/10.5.7) */
#define PD_ACCESS_TYPE_NONE        0x00000000
#define PD_ACCESS_TYPE_READ_ONLY    0x00000001
#define PD_ACCESS_TYPE_WRITE_ONCE    0x00000002
#define PD_ACCESS_TYPE_REWRITABLE    0x00000003
#define PD_ACCESS_TYPE_OVERWRITABLE    0x00000004
 
/* Logical Volume Descriptor (ECMA 167r3 3/10.6) */
struct logicalVolDesc {
   struct tag        descTag;
   __le32            volDescSeqNum;
   struct charspec        descCharSet;
   dstring            logicalVolIdent[128];
   __le32            logicalBlockSize;
   struct regid        domainIdent;
   uint8_t            logicalVolContentsUse[16];
   __le32            mapTableLength;
   __le32            numPartitionMaps;
   struct regid        impIdent;
   uint8_t            impUse[128];
   struct extent_ad    integritySeqExt;
   uint8_t            partitionMaps[0];
} __packed;
 
/* Generic Partition Map (ECMA 167r3 3/10.7.1) */
struct genericPartitionMap {
   uint8_t        partitionMapType;
   uint8_t        partitionMapLength;
   uint8_t        partitionMapping[0];
} __packed;
 
/* Partition Map Type (ECMA 167r3 3/10.7.1.1) */
#define GP_PARTITION_MAP_TYPE_UNDEF    0x00
#define GP_PARTITION_MAP_TYPE_1        0x01
#define GP_PARTITION_MAP_TYPE_2        0x02
 
/* Type 1 Partition Map (ECMA 167r3 3/10.7.2) */
struct genericPartitionMap1 {
   uint8_t        partitionMapType;
   uint8_t        partitionMapLength;
   __le16        volSeqNum;
   __le16        partitionNum;
} __packed;
 
/* Type 2 Partition Map (ECMA 167r3 3/10.7.3) */
struct genericPartitionMap2 {
   uint8_t        partitionMapType;
   uint8_t        partitionMapLength;
   uint8_t        partitionIdent[62];
} __packed;
 
/* Unallocated Space Descriptor (ECMA 167r3 3/10.8) */
struct unallocSpaceDesc {
   struct tag        descTag;
   __le32            volDescSeqNum;
   __le32            numAllocDescs;
   struct extent_ad    allocDescs[0];
} __packed;
 
/* Terminating Descriptor (ECMA 167r3 3/10.9) */
struct terminatingDesc {
   struct tag    descTag;
   uint8_t        reserved[496];
} __packed;
 
/* Logical Volume Integrity Descriptor (ECMA 167r3 3/10.10) */
struct logicalVolIntegrityDesc {
   struct tag        descTag;
   struct timestamp    recordingDateAndTime;
   __le32            integrityType;
   struct extent_ad    nextIntegrityExt;
   uint8_t            logicalVolContentsUse[32];
   __le32            numOfPartitions;
   __le32            lengthOfImpUse;
   __le32            freeSpaceTable[0];
   __le32            sizeTable[0];
   uint8_t            impUse[0];
} __packed;
 
/* Integrity Type (ECMA 167r3 3/10.10.3) */
#define LVID_INTEGRITY_TYPE_OPEN    0x00000000
#define LVID_INTEGRITY_TYPE_CLOSE    0x00000001
 
/* Recorded Address (ECMA 167r3 4/7.1) */
struct lb_addr {
   __le32        logicalBlockNum;
   __le16         partitionReferenceNum;
} __packed;
 
/* ... and its in-core analog */
struct kernel_lb_addr {
   uint32_t        logicalBlockNum;
   uint16_t         partitionReferenceNum;
};
 
/* Short Allocation Descriptor (ECMA 167r3 4/14.14.1) */
struct short_ad {
        __le32        extLength;
        __le32        extPosition;
} __packed;
 
/* Long Allocation Descriptor (ECMA 167r3 4/14.14.2) */
struct long_ad {
   __le32        extLength;
   struct lb_addr    extLocation;
   uint8_t        impUse[6];
} __packed;
 
struct kernel_long_ad {
   uint32_t        extLength;
   struct kernel_lb_addr    extLocation;
   uint8_t            impUse[6];
};
 
/* Extended Allocation Descriptor (ECMA 167r3 4/14.14.3) */
struct ext_ad {
   __le32        extLength;
   __le32        recordedLength;
   __le32        informationLength;
   struct lb_addr    extLocation;
} __packed;
 
struct kernel_ext_ad {
   uint32_t        extLength;
   uint32_t        recordedLength;
   uint32_t        informationLength;
   struct kernel_lb_addr    extLocation;
};
 
/* Descriptor Tag (ECMA 167r3 4/7.2 - See 3/7.2) */
 
/* Tag Identifier (ECMA 167r3 4/7.2.1) */
#define TAG_IDENT_FSD            0x0100
#define TAG_IDENT_FID            0x0101
#define TAG_IDENT_AED            0x0102
#define TAG_IDENT_IE            0x0103
#define TAG_IDENT_TE            0x0104
#define TAG_IDENT_FE            0x0105
#define TAG_IDENT_EAHD            0x0106
#define TAG_IDENT_USE            0x0107
#define TAG_IDENT_SBD            0x0108
#define TAG_IDENT_PIE            0x0109
#define TAG_IDENT_EFE            0x010A
 
/* File Set Descriptor (ECMA 167r3 4/14.1) */
struct fileSetDesc {
   struct tag        descTag;
   struct timestamp    recordingDateAndTime;
   __le16            interchangeLvl;
   __le16            maxInterchangeLvl;
   __le32            charSetList;
   __le32            maxCharSetList;
   __le32            fileSetNum;
   __le32            fileSetDescNum;
   struct charspec        logicalVolIdentCharSet;
   dstring            logicalVolIdent[128];
   struct charspec        fileSetCharSet;
   dstring            fileSetIdent[32];
   dstring            copyrightFileIdent[32];
   dstring            abstractFileIdent[32];
   struct long_ad        rootDirectoryICB;
   struct regid        domainIdent;
   struct long_ad        nextExt;
   struct long_ad        streamDirectoryICB;
   uint8_t            reserved[32];
} __packed;
 
/* Partition Header Descriptor (ECMA 167r3 4/14.3) */
struct partitionHeaderDesc {
   struct short_ad    unallocSpaceTable;
   struct short_ad    unallocSpaceBitmap;
   struct short_ad    partitionIntegrityTable;
   struct short_ad    freedSpaceTable;
   struct short_ad    freedSpaceBitmap;
   uint8_t        reserved[88];
} __packed;
 
/* File Identifier Descriptor (ECMA 167r3 4/14.4) */
struct fileIdentDesc {
   struct tag    descTag;
   __le16        fileVersionNum;
   uint8_t        fileCharacteristics;
   uint8_t        lengthFileIdent;
   struct long_ad    icb;
   __le16        lengthOfImpUse;
   uint8_t        impUse[0];
   uint8_t        fileIdent[0];
   uint8_t        padding[0];
} __packed;
 
/* File Characteristics (ECMA 167r3 4/14.4.3) */
#define FID_FILE_CHAR_HIDDEN        0x01
#define FID_FILE_CHAR_DIRECTORY        0x02
#define FID_FILE_CHAR_DELETED        0x04
#define FID_FILE_CHAR_PARENT        0x08
#define FID_FILE_CHAR_METADATA        0x10
 
/* Allocation Ext Descriptor (ECMA 167r3 4/14.5) */
struct allocExtDesc {
   struct tag    descTag;
   __le32        previousAllocExtLocation;
   __le32        lengthAllocDescs;
} __packed;
 
/* ICB Tag (ECMA 167r3 4/14.6) */
struct icbtag {
   __le32        priorRecordedNumDirectEntries;
   __le16        strategyType;
   __le16        strategyParameter;
   __le16        numEntries;
   uint8_t        reserved;
   uint8_t        fileType;
   struct lb_addr    parentICBLocation;
   __le16        flags;
} __packed;
 
/* Strategy Type (ECMA 167r3 4/14.6.2) */
#define ICBTAG_STRATEGY_TYPE_UNDEF    0x0000
#define ICBTAG_STRATEGY_TYPE_1        0x0001
#define ICBTAG_STRATEGY_TYPE_2        0x0002
#define ICBTAG_STRATEGY_TYPE_3        0x0003
#define ICBTAG_STRATEGY_TYPE_4        0x0004
 
/* File Type (ECMA 167r3 4/14.6.6) */
#define ICBTAG_FILE_TYPE_UNDEF        0x00
#define ICBTAG_FILE_TYPE_USE        0x01
#define ICBTAG_FILE_TYPE_PIE        0x02
#define ICBTAG_FILE_TYPE_IE        0x03
#define ICBTAG_FILE_TYPE_DIRECTORY    0x04
#define ICBTAG_FILE_TYPE_REGULAR    0x05
#define ICBTAG_FILE_TYPE_BLOCK        0x06
#define ICBTAG_FILE_TYPE_CHAR        0x07
#define ICBTAG_FILE_TYPE_EA        0x08
#define ICBTAG_FILE_TYPE_FIFO        0x09
#define ICBTAG_FILE_TYPE_SOCKET        0x0A
#define ICBTAG_FILE_TYPE_TE        0x0B
#define ICBTAG_FILE_TYPE_SYMLINK    0x0C
#define ICBTAG_FILE_TYPE_STREAMDIR    0x0D
 
/* Flags (ECMA 167r3 4/14.6.8) */
#define ICBTAG_FLAG_AD_MASK        0x0007
#define ICBTAG_FLAG_AD_SHORT        0x0000
#define ICBTAG_FLAG_AD_LONG        0x0001
#define ICBTAG_FLAG_AD_EXTENDED        0x0002
#define ICBTAG_FLAG_AD_IN_ICB        0x0003
#define ICBTAG_FLAG_SORTED        0x0008
#define ICBTAG_FLAG_NONRELOCATABLE    0x0010
#define ICBTAG_FLAG_ARCHIVE        0x0020
#define ICBTAG_FLAG_SETUID        0x0040
#define ICBTAG_FLAG_SETGID        0x0080
#define ICBTAG_FLAG_STICKY        0x0100
#define ICBTAG_FLAG_CONTIGUOUS        0x0200
#define ICBTAG_FLAG_SYSTEM        0x0400
#define ICBTAG_FLAG_TRANSFORMED        0x0800
#define ICBTAG_FLAG_MULTIVERSIONS    0x1000
#define ICBTAG_FLAG_STREAM        0x2000
 
/* Indirect Entry (ECMA 167r3 4/14.7) */
struct indirectEntry {
   struct tag    descTag;
   struct icbtag    icbTag;
   struct long_ad    indirectICB;
} __packed;
 
/* Terminal Entry (ECMA 167r3 4/14.8) */
struct terminalEntry {
   struct tag    descTag;
   struct icbtag    icbTag;
} __packed;
 
/* File Entry (ECMA 167r3 4/14.9) */
struct fileEntry {
   struct tag        descTag;
   struct icbtag        icbTag;
   __le32            uid;
   __le32            gid;
   __le32            permissions;
   __le16            fileLinkCount;
   uint8_t            recordFormat;
   uint8_t            recordDisplayAttr;
   __le32            recordLength;
   __le64            informationLength;
   __le64            logicalBlocksRecorded;
   struct timestamp    accessTime;
   struct timestamp    modificationTime;
   struct timestamp    attrTime;
   __le32            checkpoint;
   struct long_ad        extendedAttrICB;
   struct regid        impIdent;
   __le64            uniqueID;
   __le32            lengthExtendedAttr;
   __le32            lengthAllocDescs;
   uint8_t            extendedAttr[0];
   uint8_t            allocDescs[0];
} __packed;
 
/* Permissions (ECMA 167r3 4/14.9.5) */
#define FE_PERM_O_EXEC            0x00000001U
#define FE_PERM_O_WRITE            0x00000002U
#define FE_PERM_O_READ            0x00000004U
#define FE_PERM_O_CHATTR        0x00000008U
#define FE_PERM_O_DELETE        0x00000010U
#define FE_PERM_G_EXEC            0x00000020U
#define FE_PERM_G_WRITE            0x00000040U
#define FE_PERM_G_READ            0x00000080U
#define FE_PERM_G_CHATTR        0x00000100U
#define FE_PERM_G_DELETE        0x00000200U
#define FE_PERM_U_EXEC            0x00000400U
#define FE_PERM_U_WRITE            0x00000800U
#define FE_PERM_U_READ            0x00001000U
#define FE_PERM_U_CHATTR        0x00002000U
#define FE_PERM_U_DELETE        0x00004000U
 
/* Record Format (ECMA 167r3 4/14.9.7) */
#define FE_RECORD_FMT_UNDEF        0x00
#define FE_RECORD_FMT_FIXED_PAD        0x01
#define FE_RECORD_FMT_FIXED        0x02
#define FE_RECORD_FMT_VARIABLE8        0x03
#define FE_RECORD_FMT_VARIABLE16    0x04
#define FE_RECORD_FMT_VARIABLE16_MSB    0x05
#define FE_RECORD_FMT_VARIABLE32    0x06
#define FE_RECORD_FMT_PRINT        0x07
#define FE_RECORD_FMT_LF        0x08
#define FE_RECORD_FMT_CR        0x09
#define FE_RECORD_FMT_CRLF        0x0A
#define FE_RECORD_FMT_LFCR        0x0B
 
/* Record Display Attributes (ECMA 167r3 4/14.9.8) */
#define FE_RECORD_DISPLAY_ATTR_UNDEF    0x00
#define FE_RECORD_DISPLAY_ATTR_1    0x01
#define FE_RECORD_DISPLAY_ATTR_2    0x02
#define FE_RECORD_DISPLAY_ATTR_3    0x03
 
/* Extended Attribute Header Descriptor (ECMA 167r3 4/14.10.1) */
struct extendedAttrHeaderDesc {
   struct tag    descTag;
   __le32        impAttrLocation;
   __le32        appAttrLocation;
} __packed;
 
/* Generic Format (ECMA 167r3 4/14.10.2) */
struct genericFormat {
   __le32        attrType;
   uint8_t        attrSubtype;
   uint8_t        reserved[3];
   __le32        attrLength;
   uint8_t        attrData[0];
} __packed;
 
/* Character Set Information (ECMA 167r3 4/14.10.3) */
struct charSetInfo {
   __le32        attrType;
   uint8_t        attrSubtype;
   uint8_t        reserved[3];
   __le32        attrLength;
   __le32        escapeSeqLength;
   uint8_t        charSetType;
   uint8_t        escapeSeq[0];
} __packed;
 
/* Alternate Permissions (ECMA 167r3 4/14.10.4) */
struct altPerms {
   __le32        attrType;
   uint8_t        attrSubtype;
   uint8_t        reserved[3];
   __le32        attrLength;
   __le16        ownerIdent;
   __le16        groupIdent;
   __le16        permission;
} __packed;
 
/* File Times Extended Attribute (ECMA 167r3 4/14.10.5) */
struct fileTimesExtAttr {
   __le32        attrType;
   uint8_t        attrSubtype;
   uint8_t        reserved[3];
   __le32        attrLength;
   __le32        dataLength;
   __le32        fileTimeExistence;
   uint8_t        fileTimes;
} __packed;
 
/* FileTimeExistence (ECMA 167r3 4/14.10.5.6) */
#define FTE_CREATION            0x00000001
#define FTE_DELETION            0x00000004
#define FTE_EFFECTIVE            0x00000008
#define FTE_BACKUP            0x00000002
 
/* Information Times Extended Attribute (ECMA 167r3 4/14.10.6) */
struct infoTimesExtAttr {
   __le32        attrType;
   uint8_t        attrSubtype;
   uint8_t        reserved[3];
   __le32        attrLength;
   __le32        dataLength;
   __le32        infoTimeExistence;
   uint8_t        infoTimes[0];
} __packed;
 
/* Device Specification (ECMA 167r3 4/14.10.7) */
struct deviceSpec {
   __le32        attrType;
   uint8_t        attrSubtype;
   uint8_t        reserved[3];
   __le32        attrLength;
   __le32        impUseLength;
   __le32        majorDeviceIdent;
   __le32        minorDeviceIdent;
   uint8_t        impUse[0];
} __packed;
 
/* Implementation Use Extended Attr (ECMA 167r3 4/14.10.8) */
struct impUseExtAttr {
   __le32        attrType;
   uint8_t        attrSubtype;
   uint8_t        reserved[3];
   __le32        attrLength;
   __le32        impUseLength;
   struct regid    impIdent;
   uint8_t        impUse[0];
} __packed;
 
/* Application Use Extended Attribute (ECMA 167r3 4/14.10.9) */
struct appUseExtAttr {
   __le32        attrType;
   uint8_t        attrSubtype;
   uint8_t        reserved[3];
   __le32        attrLength;
   __le32        appUseLength;
   struct regid    appIdent;
   uint8_t        appUse[0];
} __packed;
 
#define EXTATTR_CHAR_SET        1
#define EXTATTR_ALT_PERMS        3
#define EXTATTR_FILE_TIMES        5
#define EXTATTR_INFO_TIMES        6
#define EXTATTR_DEV_SPEC        12
#define EXTATTR_IMP_USE            2048
#define EXTATTR_APP_USE            65536
#define EXTATTR_SUBTYPE            1
 
/* Unallocated Space Entry (ECMA 167r3 4/14.11) */
struct unallocSpaceEntry {
   struct tag    descTag;
   struct icbtag    icbTag;
   __le32        lengthAllocDescs;
   uint8_t        allocDescs[0];
} __packed;
 
/* Space Bitmap Descriptor (ECMA 167r3 4/14.12) */
struct spaceBitmapDesc {
   struct tag    descTag;
   __le32        numOfBits;
   __le32        numOfBytes;
   uint8_t        bitmap[0];
} __packed;
 
/* Partition Integrity Entry (ECMA 167r3 4/14.13) */
struct partitionIntegrityEntry {
   struct tag        descTag;
   struct icbtag        icbTag;
   struct timestamp    recordingDateAndTime;
   uint8_t            integrityType;
   uint8_t            reserved[175];
   struct regid        impIdent;
   uint8_t            impUse[256];
} __packed;
 
/* Short Allocation Descriptor (ECMA 167r3 4/14.14.1) */
 
/* Extent Length (ECMA 167r3 4/14.14.1.1) */
#define EXT_LENGTH_MASK            0x3FFFFFFF
#define EXT_TYPE_MASK            0xC0000000
#define EXT_RECORDED_ALLOCATED        0x00000000
#define EXT_NOT_RECORDED_ALLOCATED    0x40000000
#define EXT_NOT_RECORDED_NOT_ALLOCATED    0x80000000
#define EXT_NEXT_EXTENT_ALLOCDESCS    0xC0000000
 
/* Long Allocation Descriptor (ECMA 167r3 4/14.14.2) */
 
/* Extended Allocation Descriptor (ECMA 167r3 4/14.14.3) */
 
/* Logical Volume Header Descriptor (ECMA 167r3 4/14.15) */
struct logicalVolHeaderDesc {
   __le64        uniqueID;
   uint8_t        reserved[24];
} __packed;
 
/* Path Component (ECMA 167r3 4/14.16.1) */
struct pathComponent {
   uint8_t        componentType;
   uint8_t        lengthComponentIdent;
   __le16        componentFileVersionNum;
   dchars        componentIdent[0];
} __packed;
 
/* File Entry (ECMA 167r3 4/14.17) */
struct extendedFileEntry {
   struct tag        descTag;
   struct icbtag        icbTag;
   __le32            uid;
   __le32            gid;
   __le32            permissions;
   __le16            fileLinkCount;
   uint8_t            recordFormat;
   uint8_t            recordDisplayAttr;
   __le32            recordLength;
   __le64            informationLength;
   __le64            objectSize;
   __le64            logicalBlocksRecorded;
   struct timestamp    accessTime;
   struct timestamp    modificationTime;
   struct timestamp    createTime;
   struct timestamp    attrTime;
   __le32            checkpoint;
   __le32            reserved;
   struct long_ad        extendedAttrICB;
   struct long_ad        streamDirectoryICB;
   struct regid        impIdent;
   __le64            uniqueID;
   __le32            lengthExtendedAttr;
   __le32            lengthAllocDescs;
   uint8_t            extendedAttr[0];
   uint8_t            allocDescs[0];
} __packed;
 
#endif /* _ECMA_167_H */