mtd.h - toolbox - Rivoreo Source Code Repositories

 /*
  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  *
  */

 #ifndef _MTD_H
 #define _MTD_H

 #ifdef __MTD_USER_H__
 #error "冲突的头文件"
 #endif
 #define __MTD_USER_H__

 #ifdef __MTD_ABI_H__
 #error "冲突的头文件"
 #endif
 #define __MTD_ABI_H__

 #include <stdint.h>
 #ifdef __linux__
 #include <linux/types.h>
 #else
 #define __u8 uint8_t
 #define __u32 uint32_t
 #define __u64 uint64_t
 #ifdef __APPLE__
 #include <sys/types.h>
 typedef quad_t loff_t;
 #endif
 typedef loff_t __kernel_loff_t;
 #endif

 struct erase_info_user {
 	__u32 start;
 	__u32 length;
 };

 struct erase_info_user64 {
 	__u64 start;
 	__u64 length;
 };

 struct mtd_oob_buf {
 	__u32 start;
 	__u32 length;
 	unsigned char *ptr;
 };

 struct mtd_oob_buf64 {
 	__u64 start;
 	__u32 pad;
 	__u32 length;
 	__u64 usr_ptr;
 };

 #define MTD_ABSENT		0
 #define MTD_RAM			1
 #define MTD_ROM			2
 #define MTD_NORFLASH		3
 #define MTD_NANDFLASH		4
 #define MTD_DATAFLASH		6
 #define MTD_UBIVOLUME		7
 #define MTD_MLCNANDFLASH	8

 #define MTD_WRITEABLE		0x400	/* Device is writeable */
 #define MTD_BIT_WRITEABLE	0x800	/* Single bits can be flipped */
 #define MTD_NO_ERASE		0x1000	/* No erase necessary */
 #define MTD_POWERUP_LOCK	0x2000	/* Always locked after reset */

 // Some common devices / combinations of capabilities
 #define MTD_CAP_ROM		0
 #define MTD_CAP_RAM		(MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
 #define MTD_CAP_NORFLASH	(MTD_WRITEABLE | MTD_BIT_WRITEABLE)
 #define MTD_CAP_NANDFLASH	(MTD_WRITEABLE)

 /* ECC byte placement */
 #define MTD_NANDECC_OFF		0	// Switch off ECC (Not recommended)
 #define MTD_NANDECC_PLACE	1	// Use the given placement in the structure (YAFFS1 legacy mode)
 #define MTD_NANDECC_AUTOPLACE	2	// Use the default placement scheme
 #define MTD_NANDECC_PLACEONLY	3	// Use the given placement in the structure (Do not store ecc result on read)
 #define MTD_NANDECC_AUTOPL_USR 	4	// Use the given autoplacement scheme rather than using the default

 /* OTP mode selection */
 #define MTD_OTP_OFF		0
 #define MTD_OTP_FACTORY		1
 #define MTD_OTP_USER		2

 struct mtd_info_user {
 	__u8 type;
 	__u32 flags;
 	__u32 size;	 // Total size of the MTD
 	__u32 erasesize;
 	__u32 writesize;
 	__u32 oobsize;   // Amount of OOB data per block (e.g. 16)
 	/* The below two fields are obsolete and broken, do not use them
 	 * (TODO: remove at some point) */
 	__u32 ecctype;
 	__u32 eccsize;
 };

 struct region_info_user {
 	__u32 offset;		/* At which this region starts,
 					 * from the beginning of the MTD */
 	__u32 erasesize;		/* For this region */
 	__u32 numblocks;		/* Number of blocks in this region */
 	__u32 regionindex;
 };

 struct otp_info {
 	__u32 start;
 	__u32 length;
 	__u32 locked;
 };

 #define MEMGETINFO		_IOR('M', 1, struct mtd_info_user)
 #define MEMERASE		_IOW('M', 2, struct erase_info_user)
 #define MEMWRITEOOB		_IOWR('M', 3, struct mtd_oob_buf)
 #define MEMREADOOB		_IOWR('M', 4, struct mtd_oob_buf)
 #define MEMLOCK			_IOW('M', 5, struct erase_info_user)
 #define MEMUNLOCK		_IOW('M', 6, struct erase_info_user)
 #define MEMGETREGIONCOUNT	_IOR('M', 7, int)
 #define MEMGETREGIONINFO	_IOWR('M', 8, struct region_info_user)
 #define MEMSETOOBSEL		_IOW('M', 9, struct nand_oobinfo)
 #define MEMGETOOBSEL		_IOR('M', 10, struct nand_oobinfo)
 #define MEMGETBADBLOCK		_IOW('M', 11, __kernel_loff_t)
 #define MEMSETBADBLOCK		_IOW('M', 12, __kernel_loff_t)
 #define OTPSELECT		_IOR('M', 13, int)
 #define OTPGETREGIONCOUNT	_IOW('M', 14, int)
 #define OTPGETREGIONINFO	_IOW('M', 15, struct otp_info)
 #define OTPLOCK			_IOR('M', 16, struct otp_info)
 #define ECCGETLAYOUT		_IOR('M', 17, struct nand_ecclayout_user)
 #define ECCGETSTATS		_IOR('M', 18, struct mtd_ecc_stats)
 #define MTDFILEMODE		_IO('M', 19)
 #define MEMERASE64		_IOW('M', 20, struct erase_info_user64)
 #define MEMWRITEOOB64		_IOWR('M', 21, struct mtd_oob_buf64)
 #define MEMREADOOB64		_IOWR('M', 22, struct mtd_oob_buf64)
 #define MEMISLOCKED		_IOR('M', 23, struct erase_info_user)

 #if defined __GNU__ && defined __MACH__
 #define _IOT__IOTBASE___kernel_loff_t _IOT_SIMPLE(__kernel_loff_t)
 #define _IOT_mtd_info_user _IOT(_IOTS(__u8), 1, _IOTS(__u32), 7, 0, 0)
 #define _IOT_erase_info_user _IOT(_IOTS(__u32), 2, 0, 0, 0, 0)
 #define _IOT_mtd_oob_buf _IOT(_IOTS(__u32), 2, _IOTS(unsigned char *), 1, 0, 0)
 #define _IOT_region_info_user _IOT(_IOTS(__u32), 2, 0, 0, 0, 0)
 #define _IOT_nand_oobinfo _IOT(_IOTS(__u32), 2, _IOTS(__u32), 16, _IOTS(__u32), 32)
 #define _IOT_otp_info _IOT(_IOTS(__u32), 3, 0, 0, 0, 0)
 #define _IOT_nand_ecclayout_user _IOT(_IOTS(__u32), 2, _IOTS(__u32), MTD_MAX_ECCPOS_ENTRIES, _IOTS(__u32), 2 * MTD_MAX_OOBFREE_ENTRIES)
 #define _IOT_mtd_ecc_stats _IOT(_IOTS(__u32), 4, 0, 0, 0, 0)
 #define _IOT_erase_info_user64 _IOT(_IOTS(__u64), 2, 0, 0, 0, 0)
 #define _IOT_mtd_oob_buf64 _IOT(_IOTS(__u64), 2, _IOTS(__u32), 2, 0, 0)
 #endif

 /*
  * Obsolete legacy interface. Keep it in order not to break userspace
  * interfaces
  */
 struct nand_oobinfo {
 	__u32 useecc;
 	__u32 eccbytes;
 	__u32 oobfree[8][2];
 	__u32 eccpos[32];
 };

 struct nand_oobfree {
 	__u32 offset;
 	__u32 length;
 };

 #define MTD_MAX_OOBFREE_ENTRIES	8
 #define MTD_MAX_ECCPOS_ENTRIES	64
 /*
  * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
  * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
  * complete set of ECC information. The ioctl truncates the larger internal
  * structure to retain binary compatibility with the static declaration of the
  * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
  * the user struct, not the MAX size of the internal struct nand_ecclayout.
  */
 struct nand_ecclayout_user {
 	__u32 eccbytes;
 	__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
 	__u32 oobavail;
 	struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
 };

 /**
  * struct mtd_ecc_stats - error correction stats
  *
  * @corrected:	number of corrected bits
  * @failed:	number of uncorrectable errors
  * @badblocks:	number of bad blocks in this partition
  * @bbtblocks:	number of blocks reserved for bad block tables
  */
 struct mtd_ecc_stats {
 	__u32 corrected;
 	__u32 failed;
 	__u32 badblocks;
 	__u32 bbtblocks;
 };

 /*
  * Read/write file modes for access to MTD
  */
 enum mtd_file_modes {
 	MTD_MODE_NORMAL = MTD_OTP_OFF,
 	MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
 	MTD_MODE_OTP_USER = MTD_OTP_USER,
 	MTD_MODE_RAW,
 };

 typedef struct mtd_info_user mtd_info_t;
 typedef struct erase_info_user erase_info_t;
 typedef struct region_info_user region_info_t;
 typedef struct nand_oobinfo nand_oobinfo_t;
 typedef struct nand_ecclayout_user nand_ecclayout_t;

 #endif
	/*
	* Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
	*
	* This program is free software; you can redistribute it and/or modify
	* it under the terms of the GNU General Public License as published by
	* the Free Software Foundation; either version 2 of the License, or
	* (at your option) any later version.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.
	*
	* You should have received a copy of the GNU General Public License
	* along with this program; if not, write to the Free Software
	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	*
	*/

	#ifndef _MTD_H
	#define _MTD_H

	#ifdef __MTD_USER_H__
	#error "冲突的头文件"
	#endif
	#define __MTD_USER_H__

	#ifdef __MTD_ABI_H__
	#error "冲突的头文件"
	#endif
	#define __MTD_ABI_H__

	#include <stdint.h>
	#ifdef __linux__
	#include <linux/types.h>
	#else
	#define __u8 uint8_t
	#define __u32 uint32_t
	#define __u64 uint64_t
	#ifdef __APPLE__
	#include <sys/types.h>
	typedef quad_t loff_t;
	#endif
	typedef loff_t __kernel_loff_t;
	#endif

	struct erase_info_user {
	__u32 start;
	__u32 length;
	};

	struct erase_info_user64 {
	__u64 start;
	__u64 length;
	};

	struct mtd_oob_buf {
	__u32 start;
	__u32 length;
	unsigned char *ptr;
	};

	struct mtd_oob_buf64 {
	__u64 start;
	__u32 pad;
	__u32 length;
	__u64 usr_ptr;
	};

	#define MTD_ABSENT 0
	#define MTD_RAM 1
	#define MTD_ROM 2
	#define MTD_NORFLASH 3
	#define MTD_NANDFLASH 4
	#define MTD_DATAFLASH 6
	#define MTD_UBIVOLUME 7
	#define MTD_MLCNANDFLASH 8

	#define MTD_WRITEABLE 0x400 /* Device is writeable */
	#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
	#define MTD_NO_ERASE 0x1000 /* No erase necessary */
	#define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */

	// Some common devices / combinations of capabilities
	#define MTD_CAP_ROM 0
	#define MTD_CAP_RAM (MTD_WRITEABLE \| MTD_BIT_WRITEABLE \| MTD_NO_ERASE)
	#define MTD_CAP_NORFLASH (MTD_WRITEABLE \| MTD_BIT_WRITEABLE)
	#define MTD_CAP_NANDFLASH (MTD_WRITEABLE)

	/* ECC byte placement */
	#define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
	#define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
	#define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
	#define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
	#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default

	/* OTP mode selection */
	#define MTD_OTP_OFF 0
	#define MTD_OTP_FACTORY 1
	#define MTD_OTP_USER 2

	struct mtd_info_user {
	__u8 type;
	__u32 flags;
	__u32 size; // Total size of the MTD
	__u32 erasesize;
	__u32 writesize;
	__u32 oobsize; // Amount of OOB data per block (e.g. 16)
	/* The below two fields are obsolete and broken, do not use them
	* (TODO: remove at some point) */
	__u32 ecctype;
	__u32 eccsize;
	};

	struct region_info_user {
	__u32 offset; /* At which this region starts,
	* from the beginning of the MTD */
	__u32 erasesize; /* For this region */
	__u32 numblocks; /* Number of blocks in this region */
	__u32 regionindex;
	};

	struct otp_info {
	__u32 start;
	__u32 length;
	__u32 locked;
	};

	#define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
	#define MEMERASE _IOW('M', 2, struct erase_info_user)
	#define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
	#define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
	#define MEMLOCK _IOW('M', 5, struct erase_info_user)
	#define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
	#define MEMGETREGIONCOUNT _IOR('M', 7, int)
	#define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
	#define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
	#define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
	#define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t)
	#define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t)
	#define OTPSELECT _IOR('M', 13, int)
	#define OTPGETREGIONCOUNT _IOW('M', 14, int)
	#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
	#define OTPLOCK _IOR('M', 16, struct otp_info)
	#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user)
	#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
	#define MTDFILEMODE _IO('M', 19)
	#define MEMERASE64 _IOW('M', 20, struct erase_info_user64)
	#define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64)
	#define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64)
	#define MEMISLOCKED _IOR('M', 23, struct erase_info_user)

	#if defined __GNU__ && defined __MACH__
	#define _IOT__IOTBASE___kernel_loff_t _IOT_SIMPLE(__kernel_loff_t)
	#define _IOT_mtd_info_user _IOT(_IOTS(__u8), 1, _IOTS(__u32), 7, 0, 0)
	#define _IOT_erase_info_user _IOT(_IOTS(__u32), 2, 0, 0, 0, 0)
	#define _IOT_mtd_oob_buf _IOT(_IOTS(__u32), 2, _IOTS(unsigned char *), 1, 0, 0)
	#define _IOT_region_info_user _IOT(_IOTS(__u32), 2, 0, 0, 0, 0)
	#define _IOT_nand_oobinfo _IOT(_IOTS(__u32), 2, _IOTS(__u32), 16, _IOTS(__u32), 32)
	#define _IOT_otp_info _IOT(_IOTS(__u32), 3, 0, 0, 0, 0)
	#define _IOT_nand_ecclayout_user _IOT(_IOTS(__u32), 2, _IOTS(__u32), MTD_MAX_ECCPOS_ENTRIES, _IOTS(__u32), 2 * MTD_MAX_OOBFREE_ENTRIES)
	#define _IOT_mtd_ecc_stats _IOT(_IOTS(__u32), 4, 0, 0, 0, 0)
	#define _IOT_erase_info_user64 _IOT(_IOTS(__u64), 2, 0, 0, 0, 0)
	#define _IOT_mtd_oob_buf64 _IOT(_IOTS(__u64), 2, _IOTS(__u32), 2, 0, 0)
	#endif

	/*
	* Obsolete legacy interface. Keep it in order not to break userspace
	* interfaces
	*/
	struct nand_oobinfo {
	__u32 useecc;
	__u32 eccbytes;
	__u32 oobfree[8][2];
	__u32 eccpos[32];
	};

	struct nand_oobfree {
	__u32 offset;
	__u32 length;
	};

	#define MTD_MAX_OOBFREE_ENTRIES 8
	#define MTD_MAX_ECCPOS_ENTRIES 64
	/*
	* OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
	* ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
	* complete set of ECC information. The ioctl truncates the larger internal
	* structure to retain binary compatibility with the static declaration of the
	* ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
	* the user struct, not the MAX size of the internal struct nand_ecclayout.
	*/
	struct nand_ecclayout_user {
	__u32 eccbytes;
	__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
	__u32 oobavail;
	struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
	};

	/**
	* struct mtd_ecc_stats - error correction stats
	*
	* @corrected: number of corrected bits
	* @failed: number of uncorrectable errors
	* @badblocks: number of bad blocks in this partition
	* @bbtblocks: number of blocks reserved for bad block tables
	*/
	struct mtd_ecc_stats {
	__u32 corrected;
	__u32 failed;
	__u32 badblocks;
	__u32 bbtblocks;
	};

	/*
	* Read/write file modes for access to MTD
	*/
	enum mtd_file_modes {
	MTD_MODE_NORMAL = MTD_OTP_OFF,
	MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
	MTD_MODE_OTP_USER = MTD_OTP_USER,
	MTD_MODE_RAW,
	};

	typedef struct mtd_info_user mtd_info_t;
	typedef struct erase_info_user erase_info_t;
	typedef struct region_info_user region_info_t;
	typedef struct nand_oobinfo nand_oobinfo_t;
	typedef struct nand_ecclayout_user nand_ecclayout_t;

	#endif