blob: 651f94cf381edd2a286dadc9ff4e61225e38f35e [file] [log] [blame]
wdenkfe8c2802002-11-03 00:38:21 +00001/*
2 * JFFS2 -- Journalling Flash File System, Version 2.
3 *
4 * Copyright (C) 2001 Red Hat, Inc.
5 *
6 * Created by David Woodhouse <dwmw2@cambridge.redhat.com>
7 *
8 * The original JFFS, from which the design for JFFS2 was derived,
9 * was designed and implemented by Axis Communications AB.
10 *
11 * The contents of this file are subject to the Red Hat eCos Public
12 * License Version 1.1 (the "Licence"); you may not use this file
13 * except in compliance with the Licence. You may obtain a copy of
14 * the Licence at http://www.redhat.com/
15 *
16 * Software distributed under the Licence is distributed on an "AS IS"
17 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
18 * See the Licence for the specific language governing rights and
19 * limitations under the Licence.
20 *
21 * The Original Code is JFFS2 - Journalling Flash File System, version 2
22 *
23 * Alternatively, the contents of this file may be used under the
24 * terms of the GNU General Public License version 2 (the "GPL"), in
25 * which case the provisions of the GPL are applicable instead of the
26 * above. If you wish to allow the use of your version of this file
27 * only under the terms of the GPL and not to allow others to use your
28 * version of this file under the RHEPL, indicate your decision by
29 * deleting the provisions above and replace them with the notice and
30 * other provisions required by the GPL. If you do not delete the
31 * provisions above, a recipient may use your version of this file
32 * under either the RHEPL or the GPL.
33 *
34 * $Id: jffs2.h,v 1.2 2002/01/17 00:53:20 nyet Exp $
35 *
36 */
37
38#ifndef __LINUX_JFFS2_H__
39#define __LINUX_JFFS2_H__
40
41#include <asm/types.h>
42#include <jffs2/load_kernel.h>
43
44#define JFFS2_SUPER_MAGIC 0x72b6
45
46/* Values we may expect to find in the 'magic' field */
47#define JFFS2_OLD_MAGIC_BITMASK 0x1984
48#define JFFS2_MAGIC_BITMASK 0x1985
49#define KSAMTIB_CIGAM_2SFFJ 0x5981 /* For detecting wrong-endian fs */
50#define JFFS2_EMPTY_BITMASK 0xffff
51#define JFFS2_DIRTY_BITMASK 0x0000
52
Ilya Yanok9b707622008-11-13 19:49:35 +030053/* Summary node MAGIC marker */
54#define JFFS2_SUM_MAGIC 0x02851885
55
wdenkfe8c2802002-11-03 00:38:21 +000056/* We only allow a single char for length, and 0xFF is empty flash so
57 we don't want it confused with a real length. Hence max 254.
58*/
59#define JFFS2_MAX_NAME_LEN 254
60
61/* How small can we sensibly write nodes? */
62#define JFFS2_MIN_DATA_LEN 128
63
64#define JFFS2_COMPR_NONE 0x00
65#define JFFS2_COMPR_ZERO 0x01
66#define JFFS2_COMPR_RTIME 0x02
67#define JFFS2_COMPR_RUBINMIPS 0x03
68#define JFFS2_COMPR_COPY 0x04
69#define JFFS2_COMPR_DYNRUBIN 0x05
70#define JFFS2_COMPR_ZLIB 0x06
Wolfgang Denkf0983372010-01-15 11:10:33 +010071#if defined(CONFIG_JFFS2_LZO)
wdenk07cc0992005-05-05 00:04:14 +000072#define JFFS2_COMPR_LZO 0x07
Wolfgang Denkf0983372010-01-15 11:10:33 +010073#define JFFS2_NUM_COMPR 8
wdenk412babe2005-05-05 09:51:44 +000074#else
75#define JFFS2_NUM_COMPR 7
76#endif
wdenk9dd41a72005-05-12 22:48:09 +000077
wdenkfe8c2802002-11-03 00:38:21 +000078/* Compatibility flags. */
79#define JFFS2_COMPAT_MASK 0xc000 /* What do to if an unknown nodetype is found */
80#define JFFS2_NODE_ACCURATE 0x2000
81/* INCOMPAT: Fail to mount the filesystem */
82#define JFFS2_FEATURE_INCOMPAT 0xc000
83/* ROCOMPAT: Mount read-only */
84#define JFFS2_FEATURE_ROCOMPAT 0x8000
85/* RWCOMPAT_COPY: Mount read/write, and copy the node when it's GC'd */
86#define JFFS2_FEATURE_RWCOMPAT_COPY 0x4000
87/* RWCOMPAT_DELETE: Mount read/write, and delete the node when it's GC'd */
88#define JFFS2_FEATURE_RWCOMPAT_DELETE 0x0000
89
90#define JFFS2_NODETYPE_DIRENT (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 1)
91#define JFFS2_NODETYPE_INODE (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 2)
92#define JFFS2_NODETYPE_CLEANMARKER (JFFS2_FEATURE_RWCOMPAT_DELETE | JFFS2_NODE_ACCURATE | 3)
wdenk7205e402003-09-10 22:30:53 +000093#define JFFS2_NODETYPE_PADDING (JFFS2_FEATURE_RWCOMPAT_DELETE | JFFS2_NODE_ACCURATE | 4)
Ilya Yanok9b707622008-11-13 19:49:35 +030094#define JFFS2_NODETYPE_SUMMARY (JFFS2_FEATURE_RWCOMPAT_DELETE | JFFS2_NODE_ACCURATE | 6)
wdenkfe8c2802002-11-03 00:38:21 +000095
96/* Maybe later... */
97/*#define JFFS2_NODETYPE_CHECKPOINT (JFFS2_FEATURE_RWCOMPAT_DELETE | JFFS2_NODE_ACCURATE | 3) */
98/*#define JFFS2_NODETYPE_OPTIONS (JFFS2_FEATURE_RWCOMPAT_COPY | JFFS2_NODE_ACCURATE | 4) */
99
100/* Same as the non_ECC versions, but with extra space for real
101 * ECC instead of just the checksum. For use on NAND flash
102 */
103/*#define JFFS2_NODETYPE_DIRENT_ECC (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 5) */
104/*#define JFFS2_NODETYPE_INODE_ECC (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 6) */
105
106#define JFFS2_INO_FLAG_PREREAD 1 /* Do read_inode() for this one at
107 mount time, don't wait for it to
108 happen later */
109#define JFFS2_INO_FLAG_USERCOMPR 2 /* User has requested a specific
110 compression type */
111
112
113struct jffs2_unknown_node
114{
115 /* All start like this */
116 __u16 magic;
117 __u16 nodetype;
118 __u32 totlen; /* So we can skip over nodes we don't grok */
119 __u32 hdr_crc;
120} __attribute__((packed));
121
122struct jffs2_raw_dirent
123{
124 __u16 magic;
125 __u16 nodetype; /* == JFFS_NODETYPE_DIRENT */
126 __u32 totlen;
127 __u32 hdr_crc;
128 __u32 pino;
129 __u32 version;
130 __u32 ino; /* == zero for unlink */
131 __u32 mctime;
132 __u8 nsize;
133 __u8 type;
134 __u8 unused[2];
135 __u32 node_crc;
136 __u32 name_crc;
137 __u8 name[0];
138} __attribute__((packed));
139
140/* The JFFS2 raw inode structure: Used for storage on physical media. */
141/* The uid, gid, atime, mtime and ctime members could be longer, but
142 are left like this for space efficiency. If and when people decide
143 they really need them extended, it's simple enough to add support for
144 a new type of raw node.
145*/
146struct jffs2_raw_inode
147{
148 __u16 magic; /* A constant magic number. */
149 __u16 nodetype; /* == JFFS_NODETYPE_INODE */
150 __u32 totlen; /* Total length of this node (inc data, etc.) */
151 __u32 hdr_crc;
152 __u32 ino; /* Inode number. */
153 __u32 version; /* Version number. */
154 __u32 mode; /* The file's type or mode. */
155 __u16 uid; /* The file's owner. */
156 __u16 gid; /* The file's group. */
157 __u32 isize; /* Total resultant size of this inode (used for truncations) */
158 __u32 atime; /* Last access time. */
159 __u32 mtime; /* Last modification time. */
160 __u32 ctime; /* Change time. */
161 __u32 offset; /* Where to begin to write. */
162 __u32 csize; /* (Compressed) data size */
163 __u32 dsize; /* Size of the node's data. (after decompression) */
164 __u8 compr; /* Compression algorithm used */
165 __u8 usercompr; /* Compression algorithm requested by the user */
166 __u16 flags; /* See JFFS2_INO_FLAG_* */
167 __u32 data_crc; /* CRC for the (compressed) data. */
168 __u32 node_crc; /* CRC for the raw inode (excluding data) */
169/* __u8 data[dsize]; */
170} __attribute__((packed));
171
Ilya Yanok9b707622008-11-13 19:49:35 +0300172struct jffs2_raw_summary
173{
174 __u16 magic;
175 __u16 nodetype; /* = JFFS2_NODETYPE_SUMMARY */
176 __u32 totlen;
177 __u32 hdr_crc;
178 __u32 sum_num; /* number of sum entries*/
179 __u32 cln_mkr; /* clean marker size, 0 = no cleanmarker */
180 __u32 padded; /* sum of the size of padding nodes */
181 __u32 sum_crc; /* summary information crc */
182 __u32 node_crc; /* node crc */
183 __u32 sum[0]; /* inode summary info */
184};
185
wdenkfe8c2802002-11-03 00:38:21 +0000186union jffs2_node_union {
187 struct jffs2_raw_inode i;
188 struct jffs2_raw_dirent d;
Ilya Yanok9b707622008-11-13 19:49:35 +0300189 struct jffs2_raw_summary s;
wdenkfe8c2802002-11-03 00:38:21 +0000190 struct jffs2_unknown_node u;
191} __attribute__((packed));
192
193enum
194 {
195 DT_UNKNOWN = 0,
196# define DT_UNKNOWN DT_UNKNOWN
197 DT_FIFO = 1,
198# define DT_FIFO DT_FIFO
199 DT_CHR = 2,
200# define DT_CHR DT_CHR
201 DT_DIR = 4,
202# define DT_DIR DT_DIR
203 DT_BLK = 6,
204# define DT_BLK DT_BLK
205 DT_REG = 8,
206# define DT_REG DT_REG
207 DT_LNK = 10,
208# define DT_LNK DT_LNK
209 DT_SOCK = 12,
210# define DT_SOCK DT_SOCK
211 DT_WHT = 14
212# define DT_WHT DT_WHT
213 };
214
215
216u32 jffs2_1pass_ls(struct part_info *part,const char *fname);
217u32 jffs2_1pass_load(char *dest, struct part_info *part,const char *fname);
218u32 jffs2_1pass_info(struct part_info *part);
219
wdenk07cc0992005-05-05 00:04:14 +0000220void rtime_decompress(unsigned char *data_in, unsigned char *cpage_out,
221 u32 srclen, u32 destlen);
222void rubin_do_decompress(unsigned char *bits, unsigned char *in,
223 unsigned char *page_out, __u32 destlen);
wdenkfe8c2802002-11-03 00:38:21 +0000224void dynrubin_decompress(unsigned char *data_in, unsigned char *cpage_out,
wdenk07cc0992005-05-05 00:04:14 +0000225 unsigned long sourcelen, unsigned long dstlen);
wdenkfe8c2802002-11-03 00:38:21 +0000226long zlib_decompress(unsigned char *data_in, unsigned char *cpage_out,
wdenk07cc0992005-05-05 00:04:14 +0000227 __u32 srclen, __u32 destlen);
Wolfgang Denkf0983372010-01-15 11:10:33 +0100228#if defined(CONFIG_JFFS2_LZO)
wdenk07cc0992005-05-05 00:04:14 +0000229int lzo_decompress(unsigned char *data_in, unsigned char *cpage_out,
230 u32 srclen, u32 destlen);
231#endif
wdenkfe8c2802002-11-03 00:38:21 +0000232
wdenk180d3f72004-01-04 16:28:35 +0000233char *mkmodestr(unsigned long mode, char *str);
wdenkfe8c2802002-11-03 00:38:21 +0000234#endif /* __LINUX_JFFS2_H__ */