home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / src / linux-headers-2.6.17-6 / include / linux / mtd / mtd.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-08-11  |  8.0 KB  |  238 lines
  1. /*
  2.  * $Id: mtd.h,v 1.61 2005/11/07 11:14:54 gleixner Exp $
  3.  *
  4.  * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
  5.  *
  6.  * Released under GPL
  7.  */
  8.  
  9. #ifndef __MTD_MTD_H__
  10. #define __MTD_MTD_H__
  11.  
  12. #ifndef __KERNEL__
  13. #error This is a kernel header. Perhaps include mtd-user.h instead?
  14. #endif
  15.  
  16. #include <linux/types.h>
  17. #include <linux/module.h>
  18. #include <linux/uio.h>
  19. #include <linux/notifier.h>
  20.  
  21. #include <linux/mtd/compatmac.h>
  22. #include <mtd/mtd-abi.h>
  23.  
  24. #define MTD_CHAR_MAJOR 90
  25. #define MTD_BLOCK_MAJOR 31
  26. #define MAX_MTD_DEVICES 16
  27.  
  28. #define MTD_ERASE_PENDING          0x01
  29. #define MTD_ERASING        0x02
  30. #define MTD_ERASE_SUSPEND    0x04
  31. #define MTD_ERASE_DONE          0x08
  32. #define MTD_ERASE_FAILED        0x10
  33.  
  34. /* If the erase fails, fail_addr might indicate exactly which block failed.  If
  35.    fail_addr = 0xffffffff, the failure was not at the device level or was not
  36.    specific to any particular block. */
  37. struct erase_info {
  38.     struct mtd_info *mtd;
  39.     u_int32_t addr;
  40.     u_int32_t len;
  41.     u_int32_t fail_addr;
  42.     u_long time;
  43.     u_long retries;
  44.     u_int dev;
  45.     u_int cell;
  46.     void (*callback) (struct erase_info *self);
  47.     u_long priv;
  48.     u_char state;
  49.     struct erase_info *next;
  50. };
  51.  
  52. struct mtd_erase_region_info {
  53.     u_int32_t offset;            /* At which this region starts, from the beginning of the MTD */
  54.     u_int32_t erasesize;        /* For this region */
  55.     u_int32_t numblocks;        /* Number of blocks of erasesize in this region */
  56. };
  57.  
  58. struct mtd_info {
  59.     u_char type;
  60.     u_int32_t flags;
  61.     u_int32_t size;     // Total size of the MTD
  62.  
  63.     /* "Major" erase size for the device. Na∩ve users may take this
  64.      * to be the only erase size available, or may use the more detailed
  65.      * information below if they desire
  66.      */
  67.     u_int32_t erasesize;
  68.  
  69.     u_int32_t oobblock;  // Size of OOB blocks (e.g. 512)
  70.     u_int32_t oobsize;   // Amount of OOB data per block (e.g. 16)
  71.     u_int32_t ecctype;
  72.     u_int32_t eccsize;
  73.  
  74.     /*
  75.      * Reuse some of the above unused fields in the case of NOR flash
  76.      * with configurable programming regions to avoid modifying the
  77.      * user visible structure layout/size.  Only valid when the
  78.      * MTD_PROGRAM_REGIONS flag is set.
  79.      * (Maybe we should have an union for those?)
  80.      */
  81. #define MTD_PROGREGION_SIZE(mtd)  (mtd)->oobblock
  82. #define MTD_PROGREGION_CTRLMODE_VALID(mtd)  (mtd)->oobsize
  83. #define MTD_PROGREGION_CTRLMODE_INVALID(mtd)  (mtd)->ecctype
  84.  
  85.     // Kernel-only stuff starts here.
  86.     char *name;
  87.     int index;
  88.  
  89.     // oobinfo is a nand_oobinfo structure, which can be set by iotcl (MEMSETOOBINFO)
  90.     struct nand_oobinfo oobinfo;
  91.     u_int32_t oobavail;  // Number of bytes in OOB area available for fs
  92.  
  93.     /* Data for variable erase regions. If numeraseregions is zero,
  94.      * it means that the whole device has erasesize as given above.
  95.      */
  96.     int numeraseregions;
  97.     struct mtd_erase_region_info *eraseregions;
  98.  
  99.     /* This really shouldn't be here. It can go away in 2.5 */
  100.     u_int32_t bank_size;
  101.  
  102.     int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
  103.  
  104.     /* This stuff for eXecute-In-Place */
  105.     int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf);
  106.  
  107.     /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
  108.     void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len);
  109.  
  110.  
  111.     int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  112.     int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
  113.  
  114.     int (*read_ecc) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf, u_char *eccbuf, struct nand_oobinfo *oobsel);
  115.     int (*write_ecc) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf, u_char *eccbuf, struct nand_oobinfo *oobsel);
  116.  
  117.     int (*read_oob) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  118.     int (*write_oob) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
  119.  
  120.     /*
  121.      * Methods to access the protection register area, present in some
  122.      * flash devices. The user data is one time programmable but the
  123.      * factory data is read only.
  124.      */
  125.     int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
  126.     int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  127.     int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
  128.     int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  129.     int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
  130.     int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
  131.  
  132.     /* kvec-based read/write methods. We need these especially for NAND flash,
  133.        with its limited number of write cycles per erase.
  134.        NB: The 'count' parameter is the number of _vectors_, each of
  135.        which contains an (ofs, len) tuple.
  136.     */
  137.     int (*readv) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, size_t *retlen);
  138.     int (*readv_ecc) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from,
  139.         size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel);
  140.     int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
  141.     int (*writev_ecc) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to,
  142.         size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel);
  143.  
  144.     /* Sync */
  145.     void (*sync) (struct mtd_info *mtd);
  146.  
  147.     /* Chip-supported device locking */
  148.     int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len);
  149.     int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len);
  150.  
  151.     /* Power Management functions */
  152.     int (*suspend) (struct mtd_info *mtd);
  153.     void (*resume) (struct mtd_info *mtd);
  154.  
  155.     /* Bad block management functions */
  156.     int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
  157.     int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
  158.  
  159.     struct notifier_block reboot_notifier;  /* default mode before reboot */
  160.  
  161.     void *priv;
  162.  
  163.     struct module *owner;
  164.     int usecount;
  165. };
  166.  
  167.  
  168.     /* Kernel-side ioctl definitions */
  169.  
  170. extern int add_mtd_device(struct mtd_info *mtd);
  171. extern int del_mtd_device (struct mtd_info *mtd);
  172.  
  173. extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
  174.  
  175. extern void put_mtd_device(struct mtd_info *mtd);
  176.  
  177.  
  178. struct mtd_notifier {
  179.     void (*add)(struct mtd_info *mtd);
  180.     void (*remove)(struct mtd_info *mtd);
  181.     struct list_head list;
  182. };
  183.  
  184.  
  185. extern void register_mtd_user (struct mtd_notifier *new);
  186. extern int unregister_mtd_user (struct mtd_notifier *old);
  187.  
  188. int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
  189.                unsigned long count, loff_t to, size_t *retlen);
  190.  
  191. int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
  192.               unsigned long count, loff_t from, size_t *retlen);
  193.  
  194. #define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args)
  195. #define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d))
  196. #define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg)
  197. #define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args)
  198. #define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args)
  199. #define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args)
  200. #define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args)
  201. #define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args)
  202. #define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args)
  203. #define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args)
  204. #define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args)
  205. #define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd);  } while (0)
  206.  
  207.  
  208. #ifdef CONFIG_MTD_PARTITIONS
  209. void mtd_erase_callback(struct erase_info *instr);
  210. #else
  211. static inline void mtd_erase_callback(struct erase_info *instr)
  212. {
  213.     if (instr->callback)
  214.         instr->callback(instr);
  215. }
  216. #endif
  217.  
  218. /*
  219.  * Debugging macro and defines
  220.  */
  221. #define MTD_DEBUG_LEVEL0    (0)    /* Quiet   */
  222. #define MTD_DEBUG_LEVEL1    (1)    /* Audible */
  223. #define MTD_DEBUG_LEVEL2    (2)    /* Loud    */
  224. #define MTD_DEBUG_LEVEL3    (3)    /* Noisy   */
  225.  
  226. #ifdef CONFIG_MTD_DEBUG
  227. #define DEBUG(n, args...)                \
  228.      do {                        \
  229.         if (n <= CONFIG_MTD_DEBUG_VERBOSE)    \
  230.             printk(KERN_INFO args);        \
  231.     } while(0)
  232. #else /* CONFIG_MTD_DEBUG */
  233. #define DEBUG(n, args...) do { } while(0)
  234.  
  235. #endif /* CONFIG_MTD_DEBUG */
  236.  
  237. #endif /* __MTD_MTD_H__ */
  238.