annotate yportenv.h @ 185:fa4e74c5013d

Rolling in Ians and other changes
author charles
date Wed, 18 Jul 2007 20:40:38 +0100
parents ebfd69da1173
children 1ed7a7549e0a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
1 /*
174
7d11ae6795e4 normalise licence headers and attributions
wookey
parents: 172
diff changeset
2 * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
3 *
174
7d11ae6795e4 normalise licence headers and attributions
wookey
parents: 172
diff changeset
4 * Copyright (C) 2002-2007 Aleph One Ltd.
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
5 * for Toby Churchill Ltd and Brightstar Engineering
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
6 *
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
7 * Created by Charles Manning <charles@aleph1.co.uk>
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
8 *
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
9 * This program is free software; you can redistribute it and/or modify
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
10 * it under the terms of the GNU Lesser General Public License version 2.1 as
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
11 * published by the Free Software Foundation.
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
12 *
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
13 * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
14 */
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
15
174
7d11ae6795e4 normalise licence headers and attributions
wookey
parents: 172
diff changeset
16
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
17 #ifndef __YPORTENV_H__
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
18 #define __YPORTENV_H__
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
19
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
20 #if defined CONFIG_YAFFS_WINCE
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
21
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
22 #include "ywinceenv.h"
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
23
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
24 #elif defined __KERNEL__
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
25
83
51cad800e99c Modified Makefile to allow 'out of kernel tree' module building for 2.6.x
marty
parents: 79
diff changeset
26 #include "moduleconfig.h"
51cad800e99c Modified Makefile to allow 'out of kernel tree' module building for 2.6.x
marty
parents: 79
diff changeset
27
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
28 /* Linux kernel */
172
27d73e470d9d Update for Linux 2.6.19 support
charles
parents: 137
diff changeset
29 #include <linux/version.h>
27d73e470d9d Update for Linux 2.6.19 support
charles
parents: 137
diff changeset
30 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,19))
41
702751970366 Add linux/config.h here and change include markers
charles
parents: 7
diff changeset
31 #include <linux/config.h>
172
27d73e470d9d Update for Linux 2.6.19 support
charles
parents: 137
diff changeset
32 #endif
41
702751970366 Add linux/config.h here and change include markers
charles
parents: 7
diff changeset
33 #include <linux/kernel.h>
702751970366 Add linux/config.h here and change include markers
charles
parents: 7
diff changeset
34 #include <linux/mm.h>
702751970366 Add linux/config.h here and change include markers
charles
parents: 7
diff changeset
35 #include <linux/string.h>
702751970366 Add linux/config.h here and change include markers
charles
parents: 7
diff changeset
36 #include <linux/slab.h>
93
2b4deace2c2f Add support for vmallocing large blockInfos
charles
parents: 83
diff changeset
37 #include <linux/vmalloc.h>
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
38
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
39 #define YCHAR char
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
40 #define YUCHAR unsigned char
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
41 #define _Y(x) x
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
42 #define yaffs_strcpy(a,b) strcpy(a,b)
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
43 #define yaffs_strncpy(a,b,c) strncpy(a,b,c)
182
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
44 #define yaffs_strncmp(a,b,c) strncmp(a,b,c)
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
45 #define yaffs_strlen(s) strlen(s)
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
46 #define yaffs_sprintf sprintf
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
47 #define yaffs_toupper(a) toupper(a)
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
48
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
49 #define Y_INLINE inline
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
50
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
51 #define YAFFS_LOSTNFOUND_NAME "lost+found"
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
52 #define YAFFS_LOSTNFOUND_PREFIX "obj"
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
53
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
54 /* #define YPRINTF(x) printk x */
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
55 #define YMALLOC(x) kmalloc(x,GFP_KERNEL)
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
56 #define YFREE(x) kfree(x)
93
2b4deace2c2f Add support for vmallocing large blockInfos
charles
parents: 83
diff changeset
57 #define YMALLOC_ALT(x) vmalloc(x)
2b4deace2c2f Add support for vmallocing large blockInfos
charles
parents: 83
diff changeset
58 #define YFREE_ALT(x) vfree(x)
137
62488e7b581f Fix some checkpoint stuff, add qsort
charles
parents: 131
diff changeset
59 #define YMALLOC_DMA(x) YMALLOC(x)
62488e7b581f Fix some checkpoint stuff, add qsort
charles
parents: 131
diff changeset
60
62488e7b581f Fix some checkpoint stuff, add qsort
charles
parents: 131
diff changeset
61 // KR - added for use in scan so processes aren't blocked indefinitely.
62488e7b581f Fix some checkpoint stuff, add qsort
charles
parents: 131
diff changeset
62 #define YYIELD() schedule()
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
63
182
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
64 #define YAFFS_ROOT_MODE 0666
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
65 #define YAFFS_LOSTNFOUND_MODE 0666
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
66
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
67 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
68 #define Y_CURRENT_TIME CURRENT_TIME.tv_sec
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
69 #define Y_TIME_CONVERT(x) (x).tv_sec
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
70 #else
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
71 #define Y_CURRENT_TIME CURRENT_TIME
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
72 #define Y_TIME_CONVERT(x) (x)
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
73 #endif
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
74
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
75 #define yaffs_SumCompare(x,y) ((x) == (y))
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
76 #define yaffs_strcmp(a,b) strcmp(a,b)
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
77
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
78 #define TENDSTR "\n"
6
ffe653f3cb4f *** empty log message ***
charles
parents: 4
diff changeset
79 #define TSTR(x) KERN_WARNING x
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
80 #define TOUT(p) printk p
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
81
185
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
82 #define yaffs_trace(mask, fmt, args...) \
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
83 do { if ((mask) & (yaffs_traceMask|YAFFS_TRACE_ERROR)) \
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
84 printk(KERN_WARNING "yaffs: " fmt, ## args); \
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
85 } while (0)
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
86
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
87 #define compile_time_assertion(assertion) \
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
88 ({ int x = __builtin_choose_expr(assertion, 0, (void)0); (void) x; })
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
89
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
90 #elif defined CONFIG_YAFFS_DIRECT
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
91
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
92 /* Direct interface */
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
93 #include "ydirectenv.h"
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
94
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
95 #elif defined CONFIG_YAFFS_UTIL
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
96
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
97 /* Stuff for YAFFS utilities */
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
98
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
99 #include "stdlib.h"
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
100 #include "stdio.h"
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
101 #include "string.h"
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
102
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
103 #include "devextras.h"
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
104
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
105 #define YMALLOC(x) malloc(x)
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
106 #define YFREE(x) free(x)
93
2b4deace2c2f Add support for vmallocing large blockInfos
charles
parents: 83
diff changeset
107 #define YMALLOC_ALT(x) malloc(x)
2b4deace2c2f Add support for vmallocing large blockInfos
charles
parents: 83
diff changeset
108 #define YFREE_ALT(x) free(x)
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
109
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
110 #define YCHAR char
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
111 #define YUCHAR unsigned char
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
112 #define _Y(x) x
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
113 #define yaffs_strcpy(a,b) strcpy(a,b)
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
114 #define yaffs_strncpy(a,b,c) strncpy(a,b,c)
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
115 #define yaffs_strlen(s) strlen(s)
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
116 #define yaffs_sprintf sprintf
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
117 #define yaffs_toupper(a) toupper(a)
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
118
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
119 #define Y_INLINE inline
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
120
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
121 /* #define YINFO(s) YPRINTF(( __FILE__ " %d %s\n",__LINE__,s)) */
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
122 /* #define YALERT(s) YINFO(s) */
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
123
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
124 #define TENDSTR "\n"
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
125 #define TSTR(x) x
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
126 #define TOUT(p) printf p
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
127
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
128 #define YAFFS_LOSTNFOUND_NAME "lost+found"
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
129 #define YAFFS_LOSTNFOUND_PREFIX "obj"
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
130 /* #define YPRINTF(x) printf x */
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
131
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
132 #define YAFFS_ROOT_MODE 0666
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
133 #define YAFFS_LOSTNFOUND_MODE 0666
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
134
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
135 #define yaffs_SumCompare(x,y) ((x) == (y))
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
136 #define yaffs_strcmp(a,b) strcmp(a,b)
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
137
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
138 #else
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
139 /* Should have specified a configuration type */
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
140 #error Unknown configuration
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
141
79
3eaa6f96e945 lindent
marty
parents: 41
diff changeset
142 #endif
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
143
185
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
144 /* see yaffs_fs.c */
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
145 extern unsigned int yaffs_traceMask;
fa4e74c5013d Rolling in Ians and other changes
charles
parents: 182
diff changeset
146 extern unsigned int yaffs_wr_attempts;
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
147
182
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
148 /*
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
149 * Tracing flags.
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
150 * The flags masked in YAFFS_TRACE_ALWAYS are always traced.
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
151 */
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
152
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
153 #define YAFFS_TRACE_OS 0x00000002
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
154 #define YAFFS_TRACE_ALLOCATE 0x00000004
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
155 #define YAFFS_TRACE_SCAN 0x00000008
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
156 #define YAFFS_TRACE_BAD_BLOCKS 0x00000010
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
157 #define YAFFS_TRACE_ERASE 0x00000020
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
158 #define YAFFS_TRACE_GC 0x00000040
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
159 #define YAFFS_TRACE_WRITE 0x00000080
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
160 #define YAFFS_TRACE_TRACING 0x00000100
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
161 #define YAFFS_TRACE_DELETION 0x00000200
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
162 #define YAFFS_TRACE_BUFFERS 0x00000400
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
163 #define YAFFS_TRACE_NANDACCESS 0x00000800
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
164 #define YAFFS_TRACE_GC_DETAIL 0x00001000
7
ddfefbbf40d3 *** empty log message ***
charles
parents: 6
diff changeset
165 #define YAFFS_TRACE_SCAN_DEBUG 0x00002000
ddfefbbf40d3 *** empty log message ***
charles
parents: 6
diff changeset
166 #define YAFFS_TRACE_MTD 0x00004000
131
9371b1f460a4 Checkpointing changes
charles
parents: 93
diff changeset
167 #define YAFFS_TRACE_CHECKPOINT 0x00008000
182
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
168
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
169 #define YAFFS_TRACE_VERIFY 0x00010000
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
170 #define YAFFS_TRACE_VERIFY_NAND 0x00020000
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
171 #define YAFFS_TRACE_VERIFY_FULL 0x00040000
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
172 #define YAFFS_TRACE_VERIFY_ALL 0x000F0000
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
173
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
174
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
175 #define YAFFS_TRACE_ERROR 0x40000000
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
176 #define YAFFS_TRACE_BUG 0x80000000
182
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
177 #define YAFFS_TRACE_ALWAYS 0xF0000000
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
178
182
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
179
ebfd69da1173 Adding checkpoint and robustness improvements
charles
parents: 174
diff changeset
180 #define T(mask,p) do{ if((mask) & (yaffs_traceMask | YAFFS_TRACE_ALWAYS)) TOUT(p);} while(0)
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
181
4
adce2e066382 *** empty log message ***
charles
parents: 2
diff changeset
182 #ifndef CONFIG_YAFFS_WINCE
2
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
183 #define YBUG() T(YAFFS_TRACE_BUG,(TSTR("==>> yaffs bug: " __FILE__ " %d" TENDSTR),__LINE__))
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
184 #endif
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
185
3aa2a0c8196e *** empty log message ***
charles
parents: 0
diff changeset
186 #endif