Move the internals read_super() functions near the declaration of
[yaffs2.git] / yaffs_packedtags2.c
1 /*
2  * YAFFS: Yet another FFS. A NAND-flash specific file system. 
3  *
4  * yaffs_packedtags2.c: Tags packing for YAFFS2
5  *
6  * Copyright (C) 2002 Aleph One Ltd.
7  *
8  * Created by Charles Manning <charles@aleph1.co.uk>
9  *
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public License
13  * version 2.1 as published by the Free Software Foundation.
14  */
15  
16 #include "yaffs_packedtags2.h"
17 #include "yportenv.h"
18 #include "yaffs_tagsvalidity.h"
19
20
21
22 // This code packs a set of extended tags into a binary structure for NAND storage
23
24 // Some of the information is "extra" struff which can be packed in to speed scanning
25 // This is defined by having the EXTRA_HEADER_INFO_FLAG set.
26
27
28 // Extra flags applied to chunkId
29
30 #define EXTRA_HEADER_INFO_FLAG  0x80000000
31 #define EXTRA_SHRINK_FLAG       0x40000000
32 #define EXTRA_SPARE_FLAGS       0x30000000
33
34 #define ALL_EXTRA_FLAGS         0xF0000000
35
36
37
38 // Also, the top 4 bits of the object Id are set to the object type.
39 #define EXTRA_OBJECT_TYPE_SHIFT (28)
40 #define EXTRA_OBJECT_TYPE_MASK  ((0x0F) << EXTRA_OBJECT_TYPE_SHIFT)
41
42
43
44 static void yaffs_DumpPackedTags2(const yaffs_PackedTags2 *pt)
45 {
46         T(YAFFS_TRACE_MTD,(TSTR("packed tags obj %d chunk %d byte %d seq %d"TENDSTR),pt->t.objectId,pt->t.chunkId,pt->t.byteCount,pt->t.sequenceNumber));
47 }
48
49 static void yaffs_DumpTags2(const yaffs_ExtendedTags *t)
50 {
51         T(YAFFS_TRACE_MTD,(TSTR("ext.tags eccres %d blkbad %d chused %d obj %d chunk%d byte %d del %d ser %d seq %d"TENDSTR),
52              t->eccResult, t->blockBad, t->chunkUsed, t->objectId, t->chunkId, t->byteCount, t->chunkDeleted, t->serialNumber, t->sequenceNumber));
53           
54 }
55
56 void yaffs_PackTags2(yaffs_PackedTags2 *pt, const yaffs_ExtendedTags *t)
57 {
58         pt->t.chunkId = t->chunkId;
59         pt->t.sequenceNumber = t->sequenceNumber;
60         pt->t.byteCount = t->byteCount;
61         pt->t.objectId = t->objectId;
62         
63         if(t->chunkId == 0 && t->extraHeaderInfoAvailable)
64         {
65                 // Store the extra header info instead
66                 pt->t.chunkId = EXTRA_HEADER_INFO_FLAG | t->extraParentObjectId; // We save the parent object in the chunkId
67                 if(t->extraIsShrinkHeader) 
68                 {
69                     pt->t.chunkId |= EXTRA_SHRINK_FLAG;
70                 }
71                 
72                 pt->t.objectId &= ~EXTRA_OBJECT_TYPE_MASK;
73                 pt->t.objectId |= (t->extraObjectType << EXTRA_OBJECT_TYPE_SHIFT);
74                  
75                 if(t->extraObjectType == YAFFS_OBJECT_TYPE_HARDLINK)
76                 {
77                    pt->t.byteCount = t->extraEquivalentObjectId;
78                 }
79                 else if(t->extraObjectType == YAFFS_OBJECT_TYPE_FILE)
80                 {
81                    pt->t.byteCount = t->extraFileLength;
82                 }
83                 else
84                 {
85                    pt->t.byteCount = 0;
86                 }
87         }
88         
89         yaffs_DumpPackedTags2(pt);
90         yaffs_DumpTags2(t);
91         
92 #ifndef YAFFS_IGNORE_TAGS_ECC
93         { 
94           yaffs_ECCCalculateOther((unsigned char *)&pt->t,sizeof(yaffs_PackedTags2TagsPart),&pt->ecc);
95         }
96 #endif
97 }
98
99 void yaffs_UnpackTags2(yaffs_ExtendedTags *t, yaffs_PackedTags2 *pt)
100 {
101
102         
103         memset(t,0,sizeof(yaffs_ExtendedTags));
104         
105         yaffs_InitialiseTags(t);
106         
107         if(pt->t.sequenceNumber != 0xFFFFFFFF)
108         {
109                 // Page is in use
110 #ifdef YAFFS_IGNORE_TAGS_ECC
111                 {
112                         t->eccResult = 0;
113                 }
114 #else
115                 {
116                         yaffs_ECCOther ecc;
117                         yaffs_ECCCalculateOther((unsigned char *)&pt->t,sizeof(yaffs_PackedTags2TagsPart),&ecc);
118                         t->eccResult = yaffs_ECCCorrectOther((unsigned char *)&pt->t,sizeof(yaffs_PackedTags2TagsPart),&pt->ecc,&ecc);
119                 }
120 #endif
121                 t->blockBad = 0;
122                 t->chunkUsed = 1;
123                 t->objectId = pt->t.objectId;
124                 t->chunkId =  pt->t.chunkId;
125                 t->byteCount = pt->t.byteCount;
126                 t->chunkDeleted = 0;
127                 t->serialNumber = 0;
128                 t->sequenceNumber = pt->t.sequenceNumber;
129                 
130                 // Do extra header info stuff
131                 
132                 if(pt->t.chunkId & EXTRA_HEADER_INFO_FLAG)
133                 {
134                         t->chunkId = 0;
135                         t->byteCount = 0;
136                         
137                         t->extraHeaderInfoAvailable = 1;
138                         t->extraParentObjectId = pt->t.chunkId & (~(ALL_EXTRA_FLAGS));
139                         t->extraIsShrinkHeader =  (pt->t.chunkId & EXTRA_SHRINK_FLAG) ? 1 : 0;
140                         t->extraObjectType = pt->t.objectId >> EXTRA_OBJECT_TYPE_SHIFT;
141                         t->objectId &= ~EXTRA_OBJECT_TYPE_MASK;
142                         
143                         if(t->extraObjectType == YAFFS_OBJECT_TYPE_HARDLINK)
144                         {
145                             t->extraEquivalentObjectId = pt->t.byteCount;
146                         }
147                         else 
148                         {
149                             t->extraFileLength = pt->t.byteCount;
150                         }
151                 }
152         }
153
154         yaffs_DumpPackedTags2(pt);
155         yaffs_DumpTags2(t);
156
157 }
158