uffs_types.h

一个NAND FLASH文件系统

#ifndef UFFS_TYPES_H
#define UFFS_TYPES_H

#ifdef __cplusplus
extern "C"{
#endif



/** 
 * \file uffs_types.h
 * \brief basic types used on uffs
 * \author Ricky Zheng
 */

/* basic types */

/** \typedef i8 
 * \brief 8 bit integer
 */
typedef char i8;

/** \typedef u8 
 * \brief 8 bit unsigned integer
 */
typedef unsigned char u8;

/** \typedef i16 
 * \brief 16 bit integer
 */
typedef short int i16;


/** \typedef u16
 * \brief 16 bit unsigned integer
 */
typedef unsigned short int u16;


/** \typedef i32
 * \brief 32 bit integer
 */
typedef int i32;

/** \typedef u32 
 * \brief 32 bit unsigned integer
 */
typedef unsigned int u32;


/* boolean type */

/** \typedef UBOOL 
 * \brief boolean type for uffs, the value would be: #U_TRUE or #U_FALSE
 */
typedef int UBOOL;


/** \def U_TRUE 
 * \brief boolean true for uffs
 */
#define U_TRUE 1


/** \def U_FALSE 
 * \brief boolean false for uffs
 */
#define U_FALSE 0

/** \typedef URET 
 * \brief return type for uffs, should be #U_FAIL or #U_SUCC
 */
typedef int URET;

/** \def U_FAIL 
 * \brief indicator of fail
 */
#define U_FAIL -1

/** \def U_SUCC 
 * \brief indicator of successful
 */
#define U_SUCC 0

/** \def IS_SUCC(ret) 
 * \brief is it successful ?
 */
#define IS_SUCC(ret) (ret >= 0 ? U_TRUE : U_FALSE)


/** \def IS_FAIL(ret) 
 * \brief is it fail ?
 */
#define IS_FAIL(ret) (ret < 0 ? U_TRUE : U_FALSE)

#ifndef NULL
/** \def NULL 
 * \brief zero for pointer
 */
#define NULL 0
#endif


/** \typedef uffs_Device */
typedef struct uffs_DeviceSt		uffs_Device;	//NAND flash device
/** \typedef uffs_DevOps */
typedef struct uffs_DeviceOpsSt		uffs_DevOps;	//NAND flash operations

typedef struct uffs_blockInfoSt uffs_blockInfo;
typedef struct uffs_pageSpareSt uffs_pageSpare;
typedef struct uffs_TagsSt			uffs_Tags;		//UFFS page tags

typedef struct uffs_BufSt uffs_Buf;			//page buffer


#ifdef __cplusplus
}
#endif


#endif