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