[linux.git] / include / linux / jffs2.h

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