Add more comment for yaffs_PruneWorker function.
[yaffs2.git] / yportenv.h
1 /*
2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
3  *
4  * Copyright (C) 2002-2007 Aleph One Ltd.
5  *   for Toby Churchill Ltd and Brightstar Engineering
6  *
7  * Created by Charles Manning <charles@aleph1.co.uk>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU Lesser General Public License version 2.1 as
11  * published by the Free Software Foundation.
12  *
13  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
14  */
15
16
17 #ifndef __YPORTENV_H__
18 #define __YPORTENV_H__
19
20 /*
21  * Define the MTD version in terms of Linux Kernel versions
22  * This allows yaffs to be used independantly of the kernel
23  * as well as with it.
24  */
25
26 #define MTD_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
27
28 #if defined CONFIG_YAFFS_WINCE
29
30 #include "ywinceenv.h"
31
32 #elif defined __KERNEL__
33
34 #include "moduleconfig.h"
35
36 /* Linux kernel */
37
38 #include <linux/version.h>
39 #define MTD_VERSION_CODE LINUX_VERSION_CODE
40
41 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19))
42 #include <linux/config.h>
43 #endif
44 #include <linux/kernel.h>
45 #include <linux/mm.h>
46 #include <linux/sched.h>
47 #include <linux/string.h>
48 #include <linux/slab.h>
49 #include <linux/vmalloc.h>
50
51 #define YCHAR char
52 #define YUCHAR unsigned char
53 #define _Y(x)     x
54 #define yaffs_strcat(a, b)     strcat(a, b)
55 #define yaffs_strcpy(a, b)     strcpy(a, b)
56 #define yaffs_strncpy(a, b, c) strncpy(a, b, c)
57 #define yaffs_strncmp(a, b, c) strncmp(a, b, c)
58 #define yaffs_strnlen(s,m)      strnlen(s,m)
59 #define yaffs_sprintf          sprintf
60 #define yaffs_toupper(a)       toupper(a)
61
62 #define Y_INLINE inline
63
64 #define YAFFS_LOSTNFOUND_NAME           "lost+found"
65 #define YAFFS_LOSTNFOUND_PREFIX         "obj"
66
67 /* #define YPRINTF(x) printk x */
68 #define YMALLOC(x) kmalloc(x, GFP_NOFS)
69 #define YFREE(x)   kfree(x)
70 #define YMALLOC_ALT(x) vmalloc(x)
71 #define YFREE_ALT(x)   vfree(x)
72 #define YMALLOC_DMA(x) YMALLOC(x)
73
74 /* KR - added for use in scan so processes aren't blocked indefinitely. */
75 #define YYIELD() schedule()
76
77 #define YAFFS_ROOT_MODE                 0755
78 #define YAFFS_LOSTNFOUND_MODE           0700
79
80 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2, 5, 0))
81 #define Y_CURRENT_TIME CURRENT_TIME.tv_sec
82 #define Y_TIME_CONVERT(x) (x).tv_sec
83 #else
84 #define Y_CURRENT_TIME CURRENT_TIME
85 #define Y_TIME_CONVERT(x) (x)
86 #endif
87
88 #define yaffs_SumCompare(x, y) ((x) == (y))
89 #define yaffs_strcmp(a, b) strcmp(a, b)
90
91 #define TENDSTR "\n"
92 #define TSTR(x) KERN_WARNING x
93 #define TCONT(x) x
94 #define TOUT(p) printk p
95
96 #define yaffs_trace(mask, fmt, args...) \
97         do { if ((mask) & (yaffs_traceMask| YAFFS_TRACE_ALWAYS)) \
98                 printk(KERN_WARNING "yaffs: " fmt, ## args); \
99         } while (0)
100
101 #define compile_time_assertion(assertion) \
102         ({ int x = __builtin_choose_expr(assertion, 0, (void)0); (void) x; })
103
104 #elif defined CONFIG_YAFFS_DIRECT
105
106 #define MTD_VERSION_CODE MTD_VERSION(2, 6, 22)
107
108 /* Direct interface */
109 #include "ydirectenv.h"
110
111 #elif defined CONFIG_YAFFS_UTIL
112
113 /* Stuff for YAFFS utilities */
114
115 #include "stdlib.h"
116 #include "stdio.h"
117 #include "string.h"
118
119 #include "devextras.h"
120
121 #define YMALLOC(x) malloc(x)
122 #define YFREE(x)   free(x)
123 #define YMALLOC_ALT(x) malloc(x)
124 #define YFREE_ALT(x) free(x)
125
126 #define YCHAR char
127 #define YUCHAR unsigned char
128 #define _Y(x)     x
129 #define yaffs_strcat(a, b)     strcat(a, b)
130 #define yaffs_strcpy(a, b)     strcpy(a, b)
131 #define yaffs_strncpy(a, b, c) strncpy(a, b, c)
132 #define yaffs_strnlen(s,m)             strnlen(s,m)
133 #define yaffs_sprintf          sprintf
134 #define yaffs_toupper(a)       toupper(a)
135
136 #define Y_INLINE inline
137
138 /* #define YINFO(s) YPRINTF(( __FILE__ " %d %s\n",__LINE__,s)) */
139 /* #define YALERT(s) YINFO(s) */
140
141 #define TENDSTR "\n"
142 #define TSTR(x) x
143 #define TOUT(p) printf p
144
145 #define YAFFS_LOSTNFOUND_NAME           "lost+found"
146 #define YAFFS_LOSTNFOUND_PREFIX         "obj"
147 /* #define YPRINTF(x) printf x */
148
149 #define YAFFS_ROOT_MODE                 0755
150 #define YAFFS_LOSTNFOUND_MODE           0700
151
152 #define yaffs_SumCompare(x, y) ((x) == (y))
153 #define yaffs_strcmp(a, b) strcmp(a, b)
154
155 #else
156 /* Should have specified a configuration type */
157 #error Unknown configuration
158
159 #endif
160
161 /* see yaffs_fs.c */
162 extern unsigned int yaffs_traceMask;
163 extern unsigned int yaffs_wr_attempts;
164
165 /*
166  * Tracing flags.
167  * The flags masked in YAFFS_TRACE_ALWAYS are always traced.
168  */
169
170 #define YAFFS_TRACE_OS                  0x00000002
171 #define YAFFS_TRACE_ALLOCATE            0x00000004
172 #define YAFFS_TRACE_SCAN                0x00000008
173 #define YAFFS_TRACE_BAD_BLOCKS          0x00000010
174 #define YAFFS_TRACE_ERASE               0x00000020
175 #define YAFFS_TRACE_GC                  0x00000040
176 #define YAFFS_TRACE_WRITE               0x00000080
177 #define YAFFS_TRACE_TRACING             0x00000100
178 #define YAFFS_TRACE_DELETION            0x00000200
179 #define YAFFS_TRACE_BUFFERS             0x00000400
180 #define YAFFS_TRACE_NANDACCESS          0x00000800
181 #define YAFFS_TRACE_GC_DETAIL           0x00001000
182 #define YAFFS_TRACE_SCAN_DEBUG          0x00002000
183 #define YAFFS_TRACE_MTD                 0x00004000
184 #define YAFFS_TRACE_CHECKPOINT          0x00008000
185
186 #define YAFFS_TRACE_VERIFY              0x00010000
187 #define YAFFS_TRACE_VERIFY_NAND         0x00020000
188 #define YAFFS_TRACE_VERIFY_FULL         0x00040000
189 #define YAFFS_TRACE_VERIFY_ALL          0x000F0000
190
191
192 #define YAFFS_TRACE_ERROR               0x40000000
193 #define YAFFS_TRACE_BUG                 0x80000000
194 #define YAFFS_TRACE_ALWAYS              0xF0000000
195
196
197 #define T(mask, p) do { if ((mask) & (yaffs_traceMask | YAFFS_TRACE_ALWAYS)) TOUT(p); } while (0)
198
199 #ifndef YBUG
200 #define YBUG() do {T(YAFFS_TRACE_BUG, (TSTR("==>> yaffs bug: " __FILE__ " %d" TENDSTR), __LINE__)); } while (0)
201 #endif
202
203 #endif