[net-next-2.6.git] / include / linux / jffs2.h

/*
 * JFFS2 -- Journalling Flash File System, Version 2.
 *
 * Copyright (C) 2001-2003 Red Hat, Inc.
 *
 * Created by David Woodhouse <dwmw2@infradead.org>
 *
 * For licensing information, see the file 'LICENCE' in the
 * jffs2 directory.
 */

#ifndef __LINUX_JFFS2_H__
#define __LINUX_JFFS2_H__

#include <linux/types.h>
#include <linux/magic.h>

/* You must include something which defines the C99 uintXX_t types. 
   We don't do it from here because this file is used in too many
   different environments. */

/* 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 0x8519 /* 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
#define JFFS2_COMPR_LZO		0x07
/* 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)

#define JFFS2_NODETYPE_XATTR (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 8)
#define JFFS2_NODETYPE_XREF (JFFS2_FEATURE_INCOMPAT | JFFS2_NODE_ACCURATE | 9)

/* XATTR Related */
#define JFFS2_XPREFIX_USER		1	/* for "user." */
#define JFFS2_XPREFIX_SECURITY		2	/* for "security." */
#define JFFS2_XPREFIX_ACL_ACCESS	3	/* for "system.posix_acl_access" */
#define JFFS2_XPREFIX_ACL_DEFAULT	4	/* for "system.posix_acl_default" */
#define JFFS2_XPREFIX_TRUSTED		5	/* for "trusted.*" */

#define JFFS2_ACL_VERSION		0x0001

// 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)


#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 */


/* These can go once we've made sure we've caught all uses without
   byteswapping */

typedef struct {
	__u32 v32;
} __attribute__((packed)) jint32_t;

typedef struct {
	__u32 m;
} __attribute__((packed)) jmode_t;

typedef struct {
	__u16 v16;
} __attribute__((packed)) jint16_t;

struct jffs2_unknown_node
{
	/* All start like this */
	jint16_t magic;
	jint16_t nodetype;
	jint32_t totlen; /* So we can skip over nodes we don't grok */
	jint32_t hdr_crc;
};

struct jffs2_raw_dirent
{
	jint16_t magic;
	jint16_t nodetype;	/* == JFFS2_NODETYPE_DIRENT */
	jint32_t totlen;
	jint32_t hdr_crc;
	jint32_t pino;
	jint32_t version;
	jint32_t ino; /* == zero for unlink */
	jint32_t mctime;
	__u8 nsize;
	__u8 type;
	__u8 unused[2];
	jint32_t node_crc;
	jint32_t name_crc;
	__u8 name[0];
};

/* 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
{
	jint16_t magic;      /* A constant magic number.  */
	jint16_t nodetype;   /* == JFFS2_NODETYPE_INODE */
	jint32_t totlen;     /* Total length of this node (inc data, etc.) */
	jint32_t hdr_crc;
	jint32_t ino;        /* Inode number.  */
	jint32_t version;    /* Version number.  */
	jmode_t mode;       /* The file's type or mode.  */
	jint16_t uid;        /* The file's owner.  */
	jint16_t gid;        /* The file's group.  */
	jint32_t isize;      /* Total resultant size of this inode (used for truncations)  */
	jint32_t atime;      /* Last access time.  */
	jint32_t mtime;      /* Last modification time.  */
	jint32_t ctime;      /* Change time.  */
	jint32_t offset;     /* Where to begin to write.  */
	jint32_t csize;      /* (Compressed) data size */
	jint32_t dsize;	     /* Size of the node's data. (after decompression) */
	__u8 compr;       /* Compression algorithm used */
	__u8 usercompr;   /* Compression algorithm requested by the user */
	jint16_t flags;	     /* See JFFS2_INO_FLAG_* */
	jint32_t data_crc;   /* CRC for the (compressed) data.  */
	jint32_t node_crc;   /* CRC for the raw inode (excluding data)  */
	__u8 data[0];
};

struct jffs2_raw_xattr {
	jint16_t magic;
	jint16_t nodetype;	/* = JFFS2_NODETYPE_XATTR */
	jint32_t totlen;
	jint32_t hdr_crc;
	jint32_t xid;		/* XATTR identifier number */
	jint32_t version;
	__u8 xprefix;
	__u8 name_len;
	jint16_t value_len;
	jint32_t data_crc;
	jint32_t node_crc;
	__u8 data[0];
} __attribute__((packed));

struct jffs2_raw_xref
{
	jint16_t magic;
	jint16_t nodetype;	/* = JFFS2_NODETYPE_XREF */
	jint32_t totlen;
	jint32_t hdr_crc;
	jint32_t ino;		/* inode number */
	jint32_t xid;		/* XATTR identifier number */
	jint32_t xseqno;	/* xref sequencial number */
	jint32_t node_crc;
} __attribute__((packed));

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

union jffs2_node_union
{
	struct jffs2_raw_inode i;
	struct jffs2_raw_dirent d;
	struct jffs2_raw_xattr x;
	struct jffs2_raw_xref r;
	struct jffs2_raw_summary s;
	struct jffs2_unknown_node u;
};

/* Data payload for device nodes. */
union jffs2_device_node {
	jint16_t old_id;
	jint32_t new_id;
};

#endif /* __LINUX_JFFS2_H__ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* JFFS2 -- Journalling Flash File System, Version 2.
	3	*
	4	* Copyright (C) 2001-2003 Red Hat, Inc.
	5	*
	6	* Created by David Woodhouse <dwmw2@infradead.org>
	7	*
182ec4ee	8	* For licensing information, see the file 'LICENCE' in the
1da177e4	9	* jffs2 directory.
1da177e4 LT	10	*/
	11
	12	#ifndef __LINUX_JFFS2_H__
	13	#define __LINUX_JFFS2_H__
	14
ccef7ab5	15	#include <linux/types.h>
e18fa700 JG	16	#include <linux/magic.h>
e18fa700 JG	17
1da177e4 LT	18	/* You must include something which defines the C99 uintXX_t types.
	19	We don't do it from here because this file is used in too many
	20	different environments. */
	21
1da177e4 LT	22	/* Values we may expect to find in the 'magic' field */
	23	#define JFFS2_OLD_MAGIC_BITMASK 0x1984
	24	#define JFFS2_MAGIC_BITMASK 0x1985
	25	#define KSAMTIB_CIGAM_2SFFJ 0x8519 /* For detecting wrong-endian fs */
	26	#define JFFS2_EMPTY_BITMASK 0xffff
	27	#define JFFS2_DIRTY_BITMASK 0x0000
	28
e631ddba FH	29	/* Summary node MAGIC marker */
	30	#define JFFS2_SUM_MAGIC 0x02851885
	31
1da177e4 LT	32	/* We only allow a single char for length, and 0xFF is empty flash so
	33	we don't want it confused with a real length. Hence max 254.
	34	*/
	35	#define JFFS2_MAX_NAME_LEN 254
	36
	37	/* How small can we sensibly write nodes? */
	38	#define JFFS2_MIN_DATA_LEN 128
	39
	40	#define JFFS2_COMPR_NONE 0x00
	41	#define JFFS2_COMPR_ZERO 0x01
	42	#define JFFS2_COMPR_RTIME 0x02
	43	#define JFFS2_COMPR_RUBINMIPS 0x03
	44	#define JFFS2_COMPR_COPY 0x04
	45	#define JFFS2_COMPR_DYNRUBIN 0x05
	46	#define JFFS2_COMPR_ZLIB 0x06
c799aca3	47	#define JFFS2_COMPR_LZO 0x07
1da177e4 LT	48	/* Compatibility flags. */
	49	#define JFFS2_COMPAT_MASK 0xc000 /* What do to if an unknown nodetype is found */
	50	#define JFFS2_NODE_ACCURATE 0x2000
	51	/* INCOMPAT: Fail to mount the filesystem */
	52	#define JFFS2_FEATURE_INCOMPAT 0xc000
	53	/* ROCOMPAT: Mount read-only */
	54	#define JFFS2_FEATURE_ROCOMPAT 0x8000
	55	/* RWCOMPAT_COPY: Mount read/write, and copy the node when it's GC'd */
	56	#define JFFS2_FEATURE_RWCOMPAT_COPY 0x4000
	57	/* RWCOMPAT_DELETE: Mount read/write, and delete the node when it's GC'd */
	58	#define JFFS2_FEATURE_RWCOMPAT_DELETE 0x0000
	59
	60	#define JFFS2_NODETYPE_DIRENT (JFFS2_FEATURE_INCOMPAT \| JFFS2_NODE_ACCURATE \| 1)
	61	#define JFFS2_NODETYPE_INODE (JFFS2_FEATURE_INCOMPAT \| JFFS2_NODE_ACCURATE \| 2)
	62	#define JFFS2_NODETYPE_CLEANMARKER (JFFS2_FEATURE_RWCOMPAT_DELETE \| JFFS2_NODE_ACCURATE \| 3)
	63	#define JFFS2_NODETYPE_PADDING (JFFS2_FEATURE_RWCOMPAT_DELETE \| JFFS2_NODE_ACCURATE \| 4)
	64
e631ddba FH	65	#define JFFS2_NODETYPE_SUMMARY (JFFS2_FEATURE_RWCOMPAT_DELETE \| JFFS2_NODE_ACCURATE \| 6)
e631ddba FH	66
aa98d7cf KK	67	#define JFFS2_NODETYPE_XATTR (JFFS2_FEATURE_INCOMPAT \| JFFS2_NODE_ACCURATE \| 8)
	68	#define JFFS2_NODETYPE_XREF (JFFS2_FEATURE_INCOMPAT \| JFFS2_NODE_ACCURATE \| 9)
	69
	70	/* XATTR Related */
	71	#define JFFS2_XPREFIX_USER 1 /* for "user." */
	72	#define JFFS2_XPREFIX_SECURITY 2 /* for "security." */
	73	#define JFFS2_XPREFIX_ACL_ACCESS 3 /* for "system.posix_acl_access" */
	74	#define JFFS2_XPREFIX_ACL_DEFAULT 4 /* for "system.posix_acl_default" */
	75	#define JFFS2_XPREFIX_TRUSTED 5 /* for "trusted." /
	76
	77	#define JFFS2_ACL_VERSION 0x0001
	78
1da177e4 LT	79	// Maybe later...
	80	//#define JFFS2_NODETYPE_CHECKPOINT (JFFS2_FEATURE_RWCOMPAT_DELETE \| JFFS2_NODE_ACCURATE \| 3)
	81	//#define JFFS2_NODETYPE_OPTIONS (JFFS2_FEATURE_RWCOMPAT_COPY \| JFFS2_NODE_ACCURATE \| 4)
	82
	83
182ec4ee TG	84	#define JFFS2_INO_FLAG_PREREAD 1 /* Do read_inode() for this one at
182ec4ee TG	85	mount time, don't wait for it to
1da177e4	86	happen later */
182ec4ee	87	#define JFFS2_INO_FLAG_USERCOMPR 2 /* User has requested a specific
1da177e4 LT	88	compression type */
	89
	90
	91	/* These can go once we've made sure we've caught all uses without
	92	byteswapping */
	93
	94	typedef struct {
ccef7ab5	95	__u32 v32;
ba9627b8	96	} __attribute__((packed)) jint32_t;
1da177e4 LT	97
1da177e4 LT	98	typedef struct {
ccef7ab5	99	__u32 m;
ba9627b8	100	} __attribute__((packed)) jmode_t;
1da177e4 LT	101
1da177e4 LT	102	typedef struct {
ccef7ab5	103	__u16 v16;
ba9627b8	104	} __attribute__((packed)) jint16_t;
1da177e4 LT	105
	106	struct jffs2_unknown_node
	107	{
	108	/* All start like this */
	109	jint16_t magic;
	110	jint16_t nodetype;
	111	jint32_t totlen; /* So we can skip over nodes we don't grok */
	112	jint32_t hdr_crc;
3e68fbb5	113	};
1da177e4 LT	114
	115	struct jffs2_raw_dirent
	116	{
	117	jint16_t magic;
f302cd02	118	jint16_t nodetype; /* == JFFS2_NODETYPE_DIRENT */
1da177e4 LT	119	jint32_t totlen;
	120	jint32_t hdr_crc;
	121	jint32_t pino;
	122	jint32_t version;
	123	jint32_t ino; /* == zero for unlink */
	124	jint32_t mctime;
ccef7ab5 AB	125	__u8 nsize;
	126	__u8 type;
	127	__u8 unused[2];
1da177e4 LT	128	jint32_t node_crc;
1da177e4 LT	129	jint32_t name_crc;
ccef7ab5	130	__u8 name[0];
3e68fbb5	131	};
1da177e4 LT	132
1da177e4 LT	133	/* The JFFS2 raw inode structure: Used for storage on physical media. */
182ec4ee	134	/* The uid, gid, atime, mtime and ctime members could be longer, but
1da177e4 LT	135	are left like this for space efficiency. If and when people decide
	136	they really need them extended, it's simple enough to add support for
	137	a new type of raw node.
	138	*/
	139	struct jffs2_raw_inode
	140	{
	141	jint16_t magic; /* A constant magic number. */
f302cd02	142	jint16_t nodetype; /* == JFFS2_NODETYPE_INODE */
1da177e4 LT	143	jint32_t totlen; /* Total length of this node (inc data, etc.) */
	144	jint32_t hdr_crc;
	145	jint32_t ino; /* Inode number. */
	146	jint32_t version; /* Version number. */
	147	jmode_t mode; /* The file's type or mode. */
	148	jint16_t uid; /* The file's owner. */
	149	jint16_t gid; /* The file's group. */
	150	jint32_t isize; /* Total resultant size of this inode (used for truncations) */
	151	jint32_t atime; /* Last access time. */
	152	jint32_t mtime; /* Last modification time. */
	153	jint32_t ctime; /* Change time. */
	154	jint32_t offset; /* Where to begin to write. */
	155	jint32_t csize; /* (Compressed) data size */
	156	jint32_t dsize; /* Size of the node's data. (after decompression) */
ccef7ab5 AB	157	__u8 compr; /* Compression algorithm used */
ccef7ab5 AB	158	__u8 usercompr; /* Compression algorithm requested by the user */
1da177e4 LT	159	jint16_t flags; /* See JFFS2_INO_FLAG_* */
	160	jint32_t data_crc; /* CRC for the (compressed) data. */
	161	jint32_t node_crc; /* CRC for the raw inode (excluding data) */
ccef7ab5	162	__u8 data[0];
3e68fbb5	163	};
1da177e4	164
aa98d7cf KK	165	struct jffs2_raw_xattr {
	166	jint16_t magic;
	167	jint16_t nodetype; /* = JFFS2_NODETYPE_XATTR */
	168	jint32_t totlen;
	169	jint32_t hdr_crc;
	170	jint32_t xid; /* XATTR identifier number */
	171	jint32_t version;
ccef7ab5 AB	172	__u8 xprefix;
ccef7ab5 AB	173	__u8 name_len;
aa98d7cf KK	174	jint16_t value_len;
	175	jint32_t data_crc;
	176	jint32_t node_crc;
ccef7ab5	177	__u8 data[0];
aa98d7cf KK	178	} __attribute__((packed));
	179
	180	struct jffs2_raw_xref
	181	{
	182	jint16_t magic;
	183	jint16_t nodetype; /* = JFFS2_NODETYPE_XREF */
	184	jint32_t totlen;
	185	jint32_t hdr_crc;
	186	jint32_t ino; /* inode number */
	187	jint32_t xid; /* XATTR identifier number */
c9f700f8	188	jint32_t xseqno; /* xref sequencial number */
aa98d7cf KK	189	jint32_t node_crc;
	190	} __attribute__((packed));
	191
2bc9764c FH	192	struct jffs2_raw_summary
2bc9764c FH	193	{
e631ddba	194	jint16_t magic;
2bc9764c	195	jint16_t nodetype; /* = JFFS2_NODETYPE_SUMMARY */
e631ddba FH	196	jint32_t totlen;
	197	jint32_t hdr_crc;
	198	jint32_t sum_num; /* number of sum entries*/
	199	jint32_t cln_mkr; /* clean marker size, 0 = no cleanmarker */
	200	jint32_t padded; /* sum of the size of padding nodes */
	201	jint32_t sum_crc; /* summary information crc */
	202	jint32_t node_crc; /* node crc */
	203	jint32_t sum[0]; /* inode summary info */
3e68fbb5	204	};
e631ddba	205
182ec4ee	206	union jffs2_node_union
2bc9764c	207	{
1da177e4 LT	208	struct jffs2_raw_inode i;
1da177e4 LT	209	struct jffs2_raw_dirent d;
aa98d7cf KK	210	struct jffs2_raw_xattr x;
aa98d7cf KK	211	struct jffs2_raw_xref r;
2bc9764c	212	struct jffs2_raw_summary s;
1da177e4 LT	213	struct jffs2_unknown_node u;
	214	};
	215
aef9ab47 DW	216	/* Data payload for device nodes. */
aef9ab47 DW	217	union jffs2_device_node {
91f80266 AM	218	jint16_t old_id;
91f80266 AM	219	jint32_t new_id;
aef9ab47 DW	220	};
aef9ab47 DW	221
1da177e4	222	#endif /* __LINUX_JFFS2_H__ */