patch-2.4.0-test3 linux/include/linux/mtd/map.h

• Lines: 104
• Date: Tue Jul 4 10:12:34 2000
• Orig file: v2.4.0-test2/linux/include/linux/mtd/map.h
• Orig date: Wed Dec 31 16:00:00 1969

diff -u --recursive --new-file v2.4.0-test2/linux/include/linux/mtd/map.h linux/include/linux/mtd/map.h
@@ -0,0 +1,103 @@
+
+/* Overhauled routines for dealing with different mmap regions of flash */
+/* $Id: map.h,v 1.5 2000/06/26 16:18:58 dwmw2 Exp $ */
+
+#ifndef __LINUX_MTD_MAP_H__
+#define __LINUX_MTD_MAP_H__
+
+#include <linux/types.h>
+#include <linux/mtd/mtd.h>
+#include <linux/kmod.h>
+#include <linux/malloc.h>
+
+/* The map stuff is very simple. You fill in your struct map_info with
+   a handful of routines for accessing the device, making sure they handle
+   paging etc. correctly if your device needs it. Then you pass it off
+   to a chip driver which deals with a mapped device - generally either
+   do_cfi_probe() or do_ram_probe(), either of which will return a 
+   struct mtd_info if they liked what they saw. At which point, you
+   fill in the mtd->module with your own module address, and register 
+   it.
+   
+   The mtd->priv field will point to the struct map_info, and any further
+   private data required by the chip driver is linked from the 
+   mtd->priv->fldrv_priv field. This allows the map driver to get at 
+   the destructor function map->fldrv_destroy() when it's tired
+   of living.
+*/
+
+struct map_info {
+	char *name;
+	unsigned long size;
+	int buswidth; /* in octets */
+	__u8 (*read8)(struct map_info *, unsigned long);
+	__u16 (*read16)(struct map_info *, unsigned long);
+	__u32 (*read32)(struct map_info *, unsigned long);  
+	/* If it returned a 'long' I'd call it readl.
+	 * It doesn't.
+	 * I won't.
+	 * dwmw2 */
+	
+	void (*copy_from)(struct map_info *, void *, unsigned long, ssize_t);
+	void (*write8)(struct map_info *, __u8, unsigned long);
+	void (*write16)(struct map_info *, __u16, unsigned long);
+	void (*write32)(struct map_info *, __u32, unsigned long);
+	void (*copy_to)(struct map_info *, unsigned long, const void *, ssize_t);
+	/* We put these two here rather than a single void *map_priv, 
+	   because we want mappers to be able to have quickly-accessible
+	   cache for the 'currently-mapped page' without the _extra_
+	   redirection that would be necessary. If you need more than
+	   two longs, turn the second into a pointer. dwmw2 */
+	unsigned long map_priv_1;
+	unsigned long map_priv_2;
+	void *fldrv_priv;
+	void (*fldrv_destroy)(struct mtd_info *);
+};
+
+/* 
+ * Probe for the contents of a map device and make an MTD structure
+ * if anything is recognised. Doesn't register it because the calling
+ * map driver needs to set the 'module' field first.
+ */
+static inline struct mtd_info *do_map_probe(struct map_info *map, char *funcname, char *modname)
+{
+	struct mtd_info *(*probe_p)(struct map_info *);
+	struct mtd_info *mtd = NULL;
+
+	probe_p = (void *)get_module_symbol(NULL, funcname);
+	if (!probe_p) {
+		request_module(modname);
+		probe_p = (void *)get_module_symbol(NULL, funcname);
+	}
+	if (probe_p) {
+		mtd = (*probe_p)(map);
+		put_module_symbol((unsigned long)probe_p);
+	}
+
+	return mtd;
+}
+
+
+/* 
+ * Commonly-used probe functions for different types of chip.
+ */
+#define do_cfi_probe(x) do_map_probe(x, "cfi_probe", "cfi_probe")
+#define do_jedec_probe(x) do_map_probe(x, "jedec_probe", "jedec_probe")
+#define do_ram_probe(x) do_map_probe(x, "map_ram_probe", "map_ram")
+#define do_rom_probe(x) do_map_probe(x, "map_rom_probe", "map_rom")
+
+/*
+ * Destroy an MTD device which was created for a map device.
+ * Make sure the MTD device is already unregistered before calling this
+ */
+static inline void map_destroy(struct mtd_info *mtd)
+{
+	struct map_info *map = mtd->priv;
+
+	map->fldrv_destroy(mtd);
+	put_module_symbol((unsigned long)map->fldrv_destroy);
+	kfree(mtd);
+}
+
+
+#endif /* __LINUX_MTD_MAP_H__ */