e1b148fdbb51a0edf2e8a27f1075024a2b2c2857
[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_strcpy(a,b)    strcpy(a,b)
55 #define yaffs_strncpy(a,b,c) strncpy(a,b,c)
56 #define yaffs_strncmp(a,b,c) strncmp(a,b,c)
57 #define yaffs_strlen(s)      strlen(s)
58 #define yaffs_sprintf        sprintf
59 #define yaffs_toupper(a)     toupper(a)
60
61 #define Y_INLINE inline
62
63 #define YAFFS_LOSTNFOUND_NAME           "lost+found"
64 #define YAFFS_LOSTNFOUND_PREFIX         "obj"
65
66 /* #define YPRINTF(x) printk x */
67 #define YMALLOC(x) kmalloc(x,GFP_KERNEL)
68 #define YFREE(x)   kfree(x)
69 #define YMALLOC_ALT(x) vmalloc(x)
70 #define YFREE_ALT(x)   vfree(x)
71 #define YMALLOC_DMA(x) YMALLOC(x)
72
73 // KR - added for use in scan so processes aren't blocked indefinitely.
74 #define YYIELD() schedule()
75
76 #define YAFFS_ROOT_MODE                 0666
77 #define YAFFS_LOSTNFOUND_MODE           0666
78
79 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
80 #define Y_CURRENT_TIME CURRENT_TIME.tv_sec
81 #define Y_TIME_CONVERT(x) (x).tv_sec
82 #else
83 #define Y_CURRENT_TIME CURRENT_TIME
84 #define Y_TIME_CONVERT(x) (x)
85 #endif
86
87 #define yaffs_SumCompare(x,y) ((x) == (y))
88 #define yaffs_strcmp(a,b) strcmp(a,b)
89
90 #define TENDSTR "\n"
91 #define TSTR(x) KERN_WARNING x
92 #define TOUT(p) printk p
93
94 #define yaffs_trace(mask, fmt, args...) \
95         do { if ((mask) & (yaffs_traceMask|YAFFS_TRACE_ERROR)) \
96                 printk(KERN_WARNING "yaffs: " fmt, ## args); \
97         } while (0)
98
99 #define compile_time_assertion(assertion) \
100         ({ int x = __builtin_choose_expr(assertion, 0, (void)0); (void) x; })
101
102 #elif defined CONFIG_YAFFS_DIRECT
103
104 #define MTD_VERSION_CODE MTD_VERSION(2,6,22)
105
106 /* Direct interface */
107 #include "ydirectenv.h"
108
109 #elif defined CONFIG_YAFFS_UTIL
110
111 /* Stuff for YAFFS utilities */
112
113 #include "stdlib.h"
114 #include "stdio.h"
115 #include "string.h"
116
117 #include "devextras.h"
118
119 #define YMALLOC(x) malloc(x)
120 #define YFREE(x)   free(x)
121 #define YMALLOC_ALT(x) malloc(x)
122 #define YFREE_ALT(x) free(x)
123
124 #define YCHAR char
125 #define YUCHAR unsigned char
126 #define _Y(x)     x
127 #define yaffs_strcpy(a,b)    strcpy(a,b)
128 #define yaffs_strncpy(a,b,c) strncpy(a,b,c)
129 #define yaffs_strlen(s)      strlen(s)
130 #define yaffs_sprintf        sprintf
131 #define yaffs_toupper(a)     toupper(a)
132
133 #define Y_INLINE inline
134
135 /* #define YINFO(s) YPRINTF(( __FILE__ " %d %s\n",__LINE__,s)) */
136 /* #define YALERT(s) YINFO(s) */
137
138 #define TENDSTR "\n"
139 #define TSTR(x) x
140 #define TOUT(p) printf p
141
142 #define YAFFS_LOSTNFOUND_NAME           "lost+found"
143 #define YAFFS_LOSTNFOUND_PREFIX         "obj"
144 /* #define YPRINTF(x) printf x */
145
146 #define YAFFS_ROOT_MODE                         0666
147 #define YAFFS_LOSTNFOUND_MODE           0666
148
149 #define yaffs_SumCompare(x,y) ((x) == (y))
150 #define yaffs_strcmp(a,b) strcmp(a,b)
151
152 #else
153 /* Should have specified a configuration type */
154 #error Unknown configuration
155
156 #endif
157
158 /* see yaffs_fs.c */
159 extern unsigned int yaffs_traceMask;
160 extern unsigned int yaffs_wr_attempts;
161
162 /*
163  * Tracing flags.
164  * The flags masked in YAFFS_TRACE_ALWAYS are always traced.
165  */
166  
167 #define YAFFS_TRACE_OS                  0x00000002
168 #define YAFFS_TRACE_ALLOCATE            0x00000004
169 #define YAFFS_TRACE_SCAN                0x00000008
170 #define YAFFS_TRACE_BAD_BLOCKS          0x00000010
171 #define YAFFS_TRACE_ERASE               0x00000020
172 #define YAFFS_TRACE_GC                  0x00000040
173 #define YAFFS_TRACE_WRITE               0x00000080
174 #define YAFFS_TRACE_TRACING             0x00000100
175 #define YAFFS_TRACE_DELETION            0x00000200
176 #define YAFFS_TRACE_BUFFERS             0x00000400
177 #define YAFFS_TRACE_NANDACCESS          0x00000800
178 #define YAFFS_TRACE_GC_DETAIL           0x00001000
179 #define YAFFS_TRACE_SCAN_DEBUG          0x00002000
180 #define YAFFS_TRACE_MTD                 0x00004000
181 #define YAFFS_TRACE_CHECKPOINT          0x00008000
182
183 #define YAFFS_TRACE_VERIFY              0x00010000
184 #define YAFFS_TRACE_VERIFY_NAND         0x00020000
185 #define YAFFS_TRACE_VERIFY_FULL         0x00040000
186 #define YAFFS_TRACE_VERIFY_ALL          0x000F0000
187
188
189 #define YAFFS_TRACE_ERROR               0x40000000
190 #define YAFFS_TRACE_BUG                 0x80000000
191 #define YAFFS_TRACE_ALWAYS              0xF0000000
192
193
194 #define T(mask,p) do{ if((mask) & (yaffs_traceMask | YAFFS_TRACE_ALWAYS)) TOUT(p);} while(0)
195
196 #ifndef CONFIG_YAFFS_WINCE
197 #define YBUG() T(YAFFS_TRACE_BUG,(TSTR("==>> yaffs bug: " __FILE__ " %d" TENDSTR),__LINE__))
198 #endif
199
200 #endif