2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2010 Aleph One Ltd.
5 * for Toby Churchill Ltd and Brightstar Engineering
7 * Created by Charles Manning <charles@aleph1.co.uk>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #include "yaffs_packedtags2.h"
16 #include "yaffs_trace.h"
17 #include "yaffs_tagsvalidity.h"
19 /* This code packs a set of extended tags into a binary structure for
23 /* Some of the information is "extra" struff which can be packed in to
25 * This is defined by having the EXTRA_HEADER_INFO_FLAG set.
28 /* Extra flags applied to chunkId */
30 #define EXTRA_HEADER_INFO_FLAG 0x80000000
31 #define EXTRA_SHRINK_FLAG 0x40000000
32 #define EXTRA_SHADOWS_FLAG 0x20000000
33 #define EXTRA_SPARE_FLAGS 0x10000000
35 #define ALL_EXTRA_FLAGS 0xF0000000
37 /* Also, the top 4 bits of the object Id are set to the object type. */
38 #define EXTRA_OBJECT_TYPE_SHIFT (28)
39 #define EXTRA_OBJECT_TYPE_MASK ((0x0F) << EXTRA_OBJECT_TYPE_SHIFT)
42 static void yaffs_DumpPackedTags2TagsPart(const yaffs_PackedTags2TagsPart *ptt)
45 (TSTR("packed tags obj %d chunk %d byte %d seq %d" TENDSTR),
46 ptt->objectId, ptt->chunkId, ptt->byteCount,
47 ptt->sequenceNumber));
49 static void yaffs_DumpPackedTags2(const yaffs_PackedTags2 *pt)
51 yaffs_DumpPackedTags2TagsPart(&pt->t);
54 static void yaffs_DumpTags2(const yaffs_ExtendedTags *t)
58 ("ext.tags eccres %d blkbad %d chused %d obj %d chunk%d byte %d del %d ser %d seq %d"
59 TENDSTR), t->eccResult, t->blockBad, t->chunkUsed, t->objectId,
60 t->chunkId, t->byteCount, t->chunkDeleted, t->serialNumber,
65 void yaffs_PackTags2TagsPart(yaffs_PackedTags2TagsPart *ptt,
66 const yaffs_ExtendedTags *t)
68 ptt->chunkId = t->chunkId;
69 ptt->sequenceNumber = t->sequenceNumber;
70 ptt->byteCount = t->byteCount;
71 ptt->objectId = t->objectId;
73 if (t->chunkId == 0 && t->extraHeaderInfoAvailable) {
74 /* Store the extra header info instead */
75 /* We save the parent object in the chunkId */
76 ptt->chunkId = EXTRA_HEADER_INFO_FLAG
77 | t->extraParentObjectId;
78 if (t->extraIsShrinkHeader)
79 ptt->chunkId |= EXTRA_SHRINK_FLAG;
81 ptt->chunkId |= EXTRA_SHADOWS_FLAG;
83 ptt->objectId &= ~EXTRA_OBJECT_TYPE_MASK;
85 (t->extraObjectType << EXTRA_OBJECT_TYPE_SHIFT);
87 if (t->extraObjectType == YAFFS_OBJECT_TYPE_HARDLINK)
88 ptt->byteCount = t->extraEquivalentObjectId;
89 else if (t->extraObjectType == YAFFS_OBJECT_TYPE_FILE)
90 ptt->byteCount = t->extraFileLength;
95 yaffs_DumpPackedTags2TagsPart(ptt);
100 void yaffs_PackTags2(yaffs_PackedTags2 *pt, const yaffs_ExtendedTags *t, int tagsECC)
102 yaffs_PackTags2TagsPart(&pt->t, t);
105 yaffs_ECCCalculateOther((unsigned char *)&pt->t,
106 sizeof(yaffs_PackedTags2TagsPart),
111 void yaffs_UnpackTags2TagsPart(yaffs_ExtendedTags *t,
112 yaffs_PackedTags2TagsPart *ptt)
115 memset(t, 0, sizeof(yaffs_ExtendedTags));
117 yaffs_InitialiseTags(t);
119 if (ptt->sequenceNumber != 0xFFFFFFFF) {
122 t->objectId = ptt->objectId;
123 t->chunkId = ptt->chunkId;
124 t->byteCount = ptt->byteCount;
127 t->sequenceNumber = ptt->sequenceNumber;
129 /* Do extra header info stuff */
131 if (ptt->chunkId & EXTRA_HEADER_INFO_FLAG) {
135 t->extraHeaderInfoAvailable = 1;
136 t->extraParentObjectId =
137 ptt->chunkId & (~(ALL_EXTRA_FLAGS));
138 t->extraIsShrinkHeader =
139 (ptt->chunkId & EXTRA_SHRINK_FLAG) ? 1 : 0;
141 (ptt->chunkId & EXTRA_SHADOWS_FLAG) ? 1 : 0;
143 ptt->objectId >> EXTRA_OBJECT_TYPE_SHIFT;
144 t->objectId &= ~EXTRA_OBJECT_TYPE_MASK;
146 if (t->extraObjectType == YAFFS_OBJECT_TYPE_HARDLINK)
147 t->extraEquivalentObjectId = ptt->byteCount;
149 t->extraFileLength = ptt->byteCount;
153 yaffs_DumpPackedTags2TagsPart(ptt);
159 void yaffs_UnpackTags2(yaffs_ExtendedTags *t, yaffs_PackedTags2 *pt, int tagsECC)
162 yaffs_ECCResult eccResult = YAFFS_ECC_RESULT_NO_ERROR;
164 if (pt->t.sequenceNumber != 0xFFFFFFFF &&
166 /* Chunk is in use and we need to do ECC */
170 yaffs_ECCCalculateOther((unsigned char *)&pt->t,
171 sizeof(yaffs_PackedTags2TagsPart),
173 result = yaffs_ECCCorrectOther((unsigned char *)&pt->t,
174 sizeof(yaffs_PackedTags2TagsPart),
178 eccResult = YAFFS_ECC_RESULT_NO_ERROR;
181 eccResult = YAFFS_ECC_RESULT_FIXED;
184 eccResult = YAFFS_ECC_RESULT_UNFIXED;
187 eccResult = YAFFS_ECC_RESULT_UNKNOWN;
191 yaffs_UnpackTags2TagsPart(t, &pt->t);
193 t->eccResult = eccResult;
195 yaffs_DumpPackedTags2(pt);