[u-boot.git] / include / jffs2 / jffs2.h

/*
 * JFFS2 -- Journalling Flash File System, Version 2.
 *
 * Copyright (C) 2001 Red Hat, Inc.
 *
 * Created by David Woodhouse <[email protected]>
 *
 * The original JFFS, from which the design for JFFS2 was derived,
 * was designed and implemented by Axis Communications AB.
 *
 * The contents of this file are subject to the Red Hat eCos Public
 * License Version 1.1 (the "Licence"); you may not use this file
 * except in compliance with the Licence.  You may obtain a copy of
 * the Licence at http://www.redhat.com/
 *
 * Software distributed under the Licence is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing rights and
 * limitations under the Licence.
 *
 * The Original Code is JFFS2 - Journalling Flash File System, version 2
 *
 * Alternatively, the contents of this file may be used under the
 * terms of the GNU General Public License version 2 (the "GPL"), in
 * which case the provisions of the GPL are applicable instead of the
 * above.  If you wish to allow the use of your version of this file
 * only under the terms of the GPL and not to allow others to use your
 * version of this file under the RHEPL, indicate your decision by
 * deleting the provisions above and replace them with the notice and
 * other provisions required by the GPL.  If you do not delete the
 * provisions above, a recipient may use your version of this file
 * under either the RHEPL or the GPL.
 *
 * $Id: jffs2.h,v 1.2 2002/01/17 00:53:20 nyet Exp $
 *
 */

#ifndef __LINUX_JFFS2_H__
#define __LINUX_JFFS2_H__

#include <asm/types.h>
#include <jffs2/load_kernel.h>

#define JFFS2_SUPER_MAGIC 0x72b6

/* Values we may expect to find in the 'magic' field */
#define JFFS2_OLD_MAGIC_BITMASK 0x1984
#define JFFS2_MAGIC_BITMASK 0x1985
#define KSAMTIB_CIGAM_2SFFJ 0x5981 /* For detecting wrong-endian fs */
#define JFFS2_EMPTY_BITMASK 0xffff
#define JFFS2_DIRTY_BITMASK 0x0000

/* Summary node MAGIC marker */
#define JFFS2_SUM_MAGIC	0x02851885

/* We only allow a single char for length, and 0xFF is empty flash so
   we don't want it confused with a real length. Hence max 254.
*/
#define JFFS2_MAX_NAME_LEN 254

/* How small can we sensibly write nodes? */
#define JFFS2_MIN_DATA_LEN 128

#define JFFS2_COMPR_NONE	0x00
#define JFFS2_COMPR_ZERO	0x01
#define JFFS2_COMPR_RTIME	0x02
#define JFFS2_COMPR_RUBINMIPS	0x03
#define JFFS2_COMPR_COPY	0x04
#define JFFS2_COMPR_DYNRUBIN	0x05
#define JFFS2_COMPR_ZLIB	0x06
#if defined(CONFIG_JFFS2_LZO)
#define JFFS2_COMPR_LZO		0x07
#define JFFS2_NUM_COMPR		8
#else
#define JFFS2_NUM_COMPR		7
#endif

/* Compatibility flags. */
#define JFFS2_COMPAT_MASK 0xc000      /* What do to if an unknown nodetype is found */
#define JFFS2_NODE_ACCURATE 0x2000
/* INCOMPAT: Fail to mount the filesystem */
#define JFFS2_FEATURE_INCOMPAT 0xc000
/* ROCOMPAT: Mount read-only */
#define JFFS2_FEATURE_ROCOMPAT 0x8000
/* RWCOMPAT_COPY: Mount read/write, and copy the node when it's GC'd */
#define JFFS2_FEATURE_RWCOMPAT_COPY 0x4000
/* RWCOMPAT_DELETE: Mount read/write, and delete the node when it's GC'd */
#define JFFS2_FEATURE_RWCOMPAT_DELETE 0x0000

#define JFFS2_NODETYPE_DIRENT (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 1)
#define JFFS2_NODETYPE_INODE (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 2)
#define JFFS2_NODETYPE_CLEANMARKER (JFFS2_FEATURE_RWCOMPAT_DELETE | JFFS2_NODE_ACCURATE | 3)
#define JFFS2_NODETYPE_PADDING (JFFS2_FEATURE_RWCOMPAT_DELETE | JFFS2_NODE_ACCURATE | 4)
#define JFFS2_NODETYPE_SUMMARY (JFFS2_FEATURE_RWCOMPAT_DELETE | JFFS2_NODE_ACCURATE | 6)

/* Maybe later... */
/*#define JFFS2_NODETYPE_CHECKPOINT (JFFS2_FEATURE_RWCOMPAT_DELETE | JFFS2_NODE_ACCURATE | 3) */
/*#define JFFS2_NODETYPE_OPTIONS (JFFS2_FEATURE_RWCOMPAT_COPY | JFFS2_NODE_ACCURATE | 4) */

/* Same as the non_ECC versions, but with extra space for real
 * ECC instead of just the checksum. For use on NAND flash
 */
/*#define JFFS2_NODETYPE_DIRENT_ECC (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 5) */
/*#define JFFS2_NODETYPE_INODE_ECC (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 6) */

#define JFFS2_INO_FLAG_PREREAD	  1	/* Do read_inode() for this one at
					   mount time, don't wait for it to
					   happen later */
#define JFFS2_INO_FLAG_USERCOMPR  2	/* User has requested a specific
					   compression type */


struct jffs2_unknown_node
{
	/* All start like this */
	__u16 magic;
	__u16 nodetype;
	__u32 totlen; /* So we can skip over nodes we don't grok */
	__u32 hdr_crc;
} __attribute__((packed));

struct jffs2_raw_dirent
{
	__u16 magic;
	__u16 nodetype;	/* == JFFS_NODETYPE_DIRENT */
	__u32 totlen;
	__u32 hdr_crc;
	__u32 pino;
	__u32 version;
	__u32 ino; /* == zero for unlink */
	__u32 mctime;
	__u8 nsize;
	__u8 type;
	__u8 unused[2];
	__u32 node_crc;
	__u32 name_crc;
	__u8 name[0];
} __attribute__((packed));

/* The JFFS2 raw inode structure: Used for storage on physical media.  */
/* The uid, gid, atime, mtime and ctime members could be longer, but
   are left like this for space efficiency. If and when people decide
   they really need them extended, it's simple enough to add support for
   a new type of raw node.
*/
struct jffs2_raw_inode
{
	__u16 magic;      /* A constant magic number.  */
	__u16 nodetype;   /* == JFFS_NODETYPE_INODE */
	__u32 totlen;     /* Total length of this node (inc data, etc.) */
	__u32 hdr_crc;
	__u32 ino;        /* Inode number.  */
	__u32 version;    /* Version number.  */
	__u32 mode;       /* The file's type or mode.  */
	__u16 uid;        /* The file's owner.  */
	__u16 gid;        /* The file's group.  */
	__u32 isize;      /* Total resultant size of this inode (used for truncations)  */
	__u32 atime;      /* Last access time.  */
	__u32 mtime;      /* Last modification time.  */
	__u32 ctime;      /* Change time.  */
	__u32 offset;     /* Where to begin to write.  */
	__u32 csize;      /* (Compressed) data size */
	__u32 dsize;	  /* Size of the node's data. (after decompression) */
	__u8 compr;       /* Compression algorithm used */
	__u8 usercompr;	  /* Compression algorithm requested by the user */
	__u16 flags;	  /* See JFFS2_INO_FLAG_* */
	__u32 data_crc;   /* CRC for the (compressed) data.  */
	__u32 node_crc;   /* CRC for the raw inode (excluding data)  */
/*	__u8 data[dsize]; */
} __attribute__((packed));

struct jffs2_raw_summary
{
	__u16 magic;
	__u16 nodetype; 	/* = JFFS2_NODETYPE_SUMMARY */
	__u32 totlen;
	__u32 hdr_crc;
	__u32 sum_num;	/* number of sum entries*/
	__u32 cln_mkr;	/* clean marker size, 0 = no cleanmarker */
	__u32 padded;	/* sum of the size of padding nodes */
	__u32 sum_crc;	/* summary information crc */
	__u32 node_crc; 	/* node crc */
	__u32 sum[0]; 	/* inode summary info */
};

union jffs2_node_union {
	struct jffs2_raw_inode i;
	struct jffs2_raw_dirent d;
	struct jffs2_raw_summary s;
	struct jffs2_unknown_node u;
} __attribute__((packed));

enum
  {
    DT_UNKNOWN = 0,
# define DT_UNKNOWN     DT_UNKNOWN
    DT_FIFO = 1,
# define DT_FIFO        DT_FIFO
    DT_CHR = 2,
# define DT_CHR         DT_CHR
    DT_DIR = 4,
# define DT_DIR         DT_DIR
    DT_BLK = 6,
# define DT_BLK         DT_BLK
    DT_REG = 8,
# define DT_REG         DT_REG
    DT_LNK = 10,
# define DT_LNK         DT_LNK
    DT_SOCK = 12,
# define DT_SOCK        DT_SOCK
    DT_WHT = 14
# define DT_WHT         DT_WHT
  };


u32 jffs2_1pass_ls(struct part_info *part,const char *fname);
u32 jffs2_1pass_load(char *dest, struct part_info *part,const char *fname);
u32 jffs2_1pass_info(struct part_info *part);

void rtime_decompress(unsigned char *data_in, unsigned char *cpage_out,
		u32 srclen, u32 destlen);
void rubin_do_decompress(unsigned char *bits, unsigned char *in,
		unsigned char *page_out, __u32 destlen);
void dynrubin_decompress(unsigned char *data_in, unsigned char *cpage_out,
		unsigned long sourcelen, unsigned long dstlen);
long zlib_decompress(unsigned char *data_in, unsigned char *cpage_out,
		__u32 srclen, __u32 destlen);
#if defined(CONFIG_JFFS2_LZO)
int lzo_decompress(unsigned char *data_in, unsigned char *cpage_out,
		u32 srclen, u32 destlen);
#endif

char *mkmodestr(unsigned long mode, char *str);
#endif /* __LINUX_JFFS2_H__ */
Commit	Line	Data
fe8c2806 WD	1	/*
	2	* JFFS2 -- Journalling Flash File System, Version 2.
	3	*
	4	* Copyright (C) 2001 Red Hat, Inc.
	5	*
	6	* Created by David Woodhouse <[email protected]>
	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
9b707622 IY	53	/* Summary node MAGIC marker */
	54	#define JFFS2_SUM_MAGIC 0x02851885
	55
fe8c2806 WD	56	/* 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
f0983371	71	#if defined(CONFIG_JFFS2_LZO)
07cc0999	72	#define JFFS2_COMPR_LZO 0x07
f0983371	73	#define JFFS2_NUM_COMPR 8
412babe3 WD	74	#else
	75	#define JFFS2_NUM_COMPR 7
	76	#endif
9dd41a7b	77
fe8c2806 WD	78	/* 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)
7205e407	93	#define JFFS2_NODETYPE_PADDING (JFFS2_FEATURE_RWCOMPAT_DELETE \| JFFS2_NODE_ACCURATE \| 4)
9b707622	94	#define JFFS2_NODETYPE_SUMMARY (JFFS2_FEATURE_RWCOMPAT_DELETE \| JFFS2_NODE_ACCURATE \| 6)
fe8c2806 WD	95
	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
	113	struct 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
	122	struct 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	*/
	146	struct 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
9b707622 IY	172	struct 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
fe8c2806 WD	186	union jffs2_node_union {
	187	struct jffs2_raw_inode i;
	188	struct jffs2_raw_dirent d;
9b707622	189	struct jffs2_raw_summary s;
fe8c2806 WD	190	struct jffs2_unknown_node u;
	191	} __attribute__((packed));
	192
	193	enum
	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
	216	u32 jffs2_1pass_ls(struct part_info part,const char fname);
	217	u32 jffs2_1pass_load(char dest, struct part_info part,const char *fname);
	218	u32 jffs2_1pass_info(struct part_info *part);
	219
07cc0999 WD	220	void rtime_decompress(unsigned char data_in, unsigned char cpage_out,
	221	u32 srclen, u32 destlen);
	222	void rubin_do_decompress(unsigned char bits, unsigned char in,
	223	unsigned char *page_out, __u32 destlen);
fe8c2806	224	void dynrubin_decompress(unsigned char data_in, unsigned char cpage_out,
07cc0999	225	unsigned long sourcelen, unsigned long dstlen);
fe8c2806	226	long zlib_decompress(unsigned char data_in, unsigned char cpage_out,
07cc0999	227	__u32 srclen, __u32 destlen);
f0983371	228	#if defined(CONFIG_JFFS2_LZO)
07cc0999 WD	229	int lzo_decompress(unsigned char data_in, unsigned char cpage_out,
	230	u32 srclen, u32 destlen);
	231	#endif
fe8c2806	232
180d3f74	233	char mkmodestr(unsigned long mode, char str);
fe8c2806	234	#endif /* __LINUX_JFFS2_H__ */