Tweaks to YaffsTuning doc.
[yaffs2.git] / yportenv.h
index 77c5b058391f9c745e5c811e44e9cc563c863b8c..e1f61f49fab59c2b85e64f49b65ebd0f7fbc36a3 100644 (file)
@@ -1,9 +1,7 @@
 /*
- * YAFFS: Yet another FFS. A NAND-flash specific file system. 
- * yportenv.h: Portable services used by yaffs. This is done to allow
- * simple migration from kernel space into app space for testing.
+ * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
  *
- * Copyright (C) 2002 Aleph One Ltd.
+ * Copyright (C) 2002-2007 Aleph One Ltd.
  *   for Toby Churchill Ltd and Brightstar Engineering
  *
  * Created by Charles Manning <charles@aleph1.co.uk>
  * it under the terms of the GNU Lesser General Public License version 2.1 as
  * published by the Free Software Foundation.
  *
- *
  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
- *
- * $Id: yportenv.h,v 1.3 2004-11-16 02:36:15 charles Exp $
- *
  */
+
+
 #ifndef __YPORTENV_H__
 #define __YPORTENV_H__
 
+/*
+ * Define the MTD version in terms of Linux Kernel versions
+ * This allows yaffs to be used independantly of the kernel
+ * as well as with it.
+ */
+
+#define MTD_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
 
 #if defined CONFIG_YAFFS_WINCE
 
 #include "ywinceenv.h"
 
-#elif  defined __KERNEL__
+#elif defined __KERNEL__
+
+#include "moduleconfig.h"
 
+/* Linux kernel */
 
+#include <linux/version.h>
+#define MTD_VERSION_CODE LINUX_VERSION_CODE
 
-// Linux kernel
-#include "linux/kernel.h"
-#include "linux/version.h"
-#include "linux/mm.h"
-#include "linux/string.h"
-#include "linux/slab.h"
+#if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19))
+#include <linux/config.h>
+#endif
+#include <linux/kernel.h>
+#include <linux/mm.h>
+#include <linux/sched.h>
+#include <linux/string.h>
+#include <linux/slab.h>
+#include <linux/vmalloc.h>
 
 #define YCHAR char
 #define YUCHAR unsigned char
 #define _Y(x)     x
-#define yaffs_strcpy(a,b)    strcpy(a,b)
-#define yaffs_strncpy(a,b,c) strncpy(a,b,c)
-#define yaffs_strlen(s)             strlen(s)
-#define yaffs_sprintf       sprintf
-#define yaffs_toupper(a)     toupper(a)
+#define yaffs_strcat(a, b)     strcat(a, b)
+#define yaffs_strcpy(a, b)     strcpy(a, b)
+#define yaffs_strncpy(a, b, c) strncpy(a, b, c)
+#define yaffs_strncmp(a, b, c) strncmp(a, b, c)
+#define yaffs_strnlen(s,m)     strnlen(s,m)
+#define yaffs_sprintf         sprintf
+#define yaffs_toupper(a)       toupper(a)
 
 #define Y_INLINE inline
 
 #define YAFFS_LOSTNFOUND_NAME          "lost+found"
 #define YAFFS_LOSTNFOUND_PREFIX                "obj"
 
-//#define YPRINTF(x) printk x
-#define YMALLOC(x) kmalloc(x,GFP_KERNEL)
+/* #define YPRINTF(x) printk x */
+#define YMALLOC(x) kmalloc(x, GFP_NOFS)
 #define YFREE(x)   kfree(x)
+#define YMALLOC_ALT(x) vmalloc(x)
+#define YFREE_ALT(x)   vfree(x)
+#define YMALLOC_DMA(x) YMALLOC(x)
+
+/* KR - added for use in scan so processes aren't blocked indefinitely. */
+#define YYIELD() schedule()
 
-#define YAFFS_ROOT_MODE                                0666
-#define YAFFS_LOSTNFOUND_MODE          0666
+#define YAFFS_ROOT_MODE                        0755
+#define YAFFS_LOSTNFOUND_MODE          0700
 
-#if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
+#if (LINUX_VERSION_CODE > KERNEL_VERSION(2, 5, 0))
 #define Y_CURRENT_TIME CURRENT_TIME.tv_sec
 #define Y_TIME_CONVERT(x) (x).tv_sec
 #else
 #define Y_TIME_CONVERT(x) (x)
 #endif
 
-#define yaffs_SumCompare(x,y) ((x) == (y))
-#define yaffs_strcmp(a,b) strcmp(a,b)
+#define yaffs_SumCompare(x, y) ((x) == (y))
+#define yaffs_strcmp(a, b) strcmp(a, b)
 
 #define TENDSTR "\n"
-#define TSTR(x) KERN_DEBUG x
+#define TSTR(x) KERN_WARNING x
+#define TCONT(x) x
 #define TOUT(p) printk p
 
+#define yaffs_trace(mask, fmt, args...) \
+       do { if ((mask) & (yaffs_traceMask| YAFFS_TRACE_ALWAYS)) \
+               printk(KERN_WARNING "yaffs: " fmt, ## args); \
+       } while (0)
+
+#define compile_time_assertion(assertion) \
+       ({ int x = __builtin_choose_expr(assertion, 0, (void)0); (void) x; })
 
 #elif defined CONFIG_YAFFS_DIRECT
 
-// Direct interface
+#define MTD_VERSION_CODE MTD_VERSION(2, 6, 22)
+
+/* Direct interface */
 #include "ydirectenv.h"
 
 #elif defined CONFIG_YAFFS_UTIL
 
-// Stuff for YAFFS utilities
+/* Stuff for YAFFS utilities */
 
 #include "stdlib.h"
 #include "stdio.h"
 
 #define YMALLOC(x) malloc(x)
 #define YFREE(x)   free(x)
-
+#define YMALLOC_ALT(x) malloc(x)
+#define YFREE_ALT(x) free(x)
 
 #define YCHAR char
 #define YUCHAR unsigned char
 #define _Y(x)     x
-#define yaffs_strcpy(a,b)    strcpy(a,b)
-#define yaffs_strncpy(a,b,c) strncpy(a,b,c)
-#define yaffs_strlen(s)             strlen(s)
-#define yaffs_sprintf       sprintf
-#define yaffs_toupper(a)     toupper(a)
+#define yaffs_strcat(a, b)     strcat(a, b)
+#define yaffs_strcpy(a, b)     strcpy(a, b)
+#define yaffs_strncpy(a, b, c) strncpy(a, b, c)
+#define yaffs_strnlen(s,m)            strnlen(s,m)
+#define yaffs_sprintf         sprintf
+#define yaffs_toupper(a)       toupper(a)
 
 #define Y_INLINE inline
 
-//#define YINFO(s) YPRINTF(( __FILE__ " %d %s\n",__LINE__,s))
-//#define YALERT(s) YINFO(s)
-
+/* #define YINFO(s) YPRINTF(( __FILE__ " %d %s\n",__LINE__,s)) */
+/* #define YALERT(s) YINFO(s) */
 
 #define TENDSTR "\n"
 #define TSTR(x) x
 #define TOUT(p) printf p
 
-
 #define YAFFS_LOSTNFOUND_NAME          "lost+found"
 #define YAFFS_LOSTNFOUND_PREFIX                "obj"
-//#define YPRINTF(x) printf x
-
+/* #define YPRINTF(x) printf x */
 
-#define YAFFS_ROOT_MODE                                0666
-#define YAFFS_LOSTNFOUND_MODE          0666
+#define YAFFS_ROOT_MODE                        0755
+#define YAFFS_LOSTNFOUND_MODE          0700
 
-#define yaffs_SumCompare(x,y) ((x) == (y))
-#define yaffs_strcmp(a,b) strcmp(a,b)
+#define yaffs_SumCompare(x, y) ((x) == (y))
+#define yaffs_strcmp(a, b) strcmp(a, b)
 
 #else
-// Should have specified a configuration type
+/* Should have specified a configuration type */
 #error Unknown configuration
 
-#endif 
-
-
-extern unsigned yaffs_traceMask;
-
-#define YAFFS_TRACE_ERROR              0x00000001
-#define YAFFS_TRACE_OS                 0x00000002
-#define YAFFS_TRACE_ALLOCATE           0x00000004
-#define YAFFS_TRACE_SCAN               0x00000008
-#define YAFFS_TRACE_BAD_BLOCKS         0x00000010
-#define YAFFS_TRACE_ERASE              0x00000020
-#define YAFFS_TRACE_GC                 0x00000040
-#define YAFFS_TRACE_WRITE              0x00000080
-#define YAFFS_TRACE_TRACING            0x00000100
-#define YAFFS_TRACE_DELETION           0x00000200
-#define YAFFS_TRACE_BUFFERS            0x00000400
-#define YAFFS_TRACE_NANDACCESS         0x00000800
-#define YAFFS_TRACE_GC_DETAIL          0x00001000
-#define YAFFS_TRACE_ALWAYS             0x40000000
-#define YAFFS_TRACE_BUG                        0x80000000
-
-#define T(mask,p) do{ if((mask) & (yaffs_traceMask | YAFFS_TRACE_ERROR)) TOUT(p);} while(0) 
+#endif
 
 
-#ifndef CONFIG_YAFFS_WINCE
-#define YBUG() T(YAFFS_TRACE_BUG,(TSTR("==>> yaffs bug: " __FILE__ " %d" TENDSTR),__LINE__))
+#ifndef YBUG
+#define YBUG() do {T(YAFFS_TRACE_BUG, (TSTR("==>> yaffs bug: " __FILE__ " %d" TENDSTR), __LINE__)); } while (0)
 #endif
 
 #endif
-
-