tmfat32ram.h

PNX1500上Fat32文件系统源代码

/* -------------------------------------------------------------------------- */
/* (C) Copyright 2000,2002, 2003 Koninklijke Philips Electronics N.V.,        */
/*     All rights reserved                                                    */
/*                                                                            */
/* This source code and any compilation or derivative thereof is the          */
/* proprietary information of Konlinklijke Philips Electronics N.V. and is    */
/* Confidential in nature.                                                    */
/* Under no circumstances is this software to be exposed to or placed under an*/
/* Open Source License of any type without the expressed written permission of*/
/* Koninklijke Philips Electronics N.V.                                       */
/* -------------------------------------------------------------------------- */
/* FILE NAME:    tmFat32Ram.h                                                 */
/*                                                                            */
/* DESCRIPTION:  This is the API for tmFat32 RAM device driver                */
/*                                                                            */
/* DOCUMENT REF: tbd                                                          */
/* 																			  */
/* NOTES:        tbd                                                          */
/*                                                                            */
/* -------------------------------------------------------------------------- */

#ifndef _TMFAT32_RAM_H_
#define _TMFAT32_RAM_H_

/* -------------------------------------------------------------------------- */
/* Define extern c for C++ prototypes                                         */
/* -------------------------------------------------------------------------- */

#if defined(__cplusplus)
extern "C"{
#endif

/* -------------------------------------------------------------------------- */
/*    Types and defines:                                                      */
/* -------------------------------------------------------------------------- */

#define     TMFAT_RAM_SECTORSIZE    512

/*
 * Useful information about the tmFat32 RAM device driver
 */
typedef struct tmFat32_Ram
{
    tmFat32_Dev_t           common;     // Info common to all tmFat32 devices
    Bool                    installed;  // True if installed
    Bool                    keepAlive;  // If true do not de-allocate when
                                        // device is terminated
    UInt8   		        *disk;      // Pointer to memory allocated to
                                        // this RAM disk
    tmFat32_DeviceDriver_t  driver;     // Device driver info for tmFat32
} tmFat32_Ram_t, *ptmFat32_Ram_t;

/* -------------------------------------------------------------------------- */
/*    Exported functions:                                                     */
/* -------------------------------------------------------------------------- */

//-----------------------------------------------------------------------------
// FUNCTION:    tmFat32_Ram_SetSize
//
// DESCRIPTION: Set tmFat32 RAM disk size
//
// RETURN:      Return TM_OK on success.
//
// NOTES:       The size will ceiling'ed to a multiple of TMFAT_RAM_SECTORSIZE
//-----------------------------------------------------------------------------
//
tmErrorCode_t
tmFat32_Ram_SetSize (
    UInt32     unit,   // I: Unit number
    UInt32     size    // I: Size in bytes
    );

//-----------------------------------------------------------------------------
// FUNCTION:    tmFat32_Ram_Install
//
// DESCRIPTION: Install RAM disk tmFat32 device driver
//
// RETURN:      Pointer ptmFat32_DeviceDriver_t. Return Null on failure.
//
// NOTES:
//-----------------------------------------------------------------------------
//
ptmFat32_DeviceDriver_t
tmFat32_Ram_Install (
    UInt32     unit   // I: Unit number
    );

//-----------------------------------------------------------------------------
// FUNCTION:    tmFat32_Ram_Uninstall
//
// DESCRIPTION: Uninstall RAM disk tmFat32 device driver
//
// RETURN:      void
//
// NOTES:
//-----------------------------------------------------------------------------
//
void
tmFat32_Ram_Uninstall (
    ptmFat32_DeviceDriver_t     p   // IO: Pointer to tmFat32_DeviceDriver_t structure
    );

//-----------------------------------------------------------------------------
// FUNCTION:    tmFat32_Ram_GetInfo
//
// DESCRIPTION: Get information about the RAM disk tmFat32 device driver
//
// RETURN:      void
//
// NOTES:       Return numUnits (number of units supported). No other
//              fields are set.
//-----------------------------------------------------------------------------
//
void
tmFat32_Ram_GetInfo (
    ptmFat32_Dev_t     p   // IO: Pointer to tmFat32_Dev_t structure
    );


/* -------------------------------------------------------------------------- */
/* End of extern c for C++ prototypes                                         */
/* -------------------------------------------------------------------------- */

#if defined(__cplusplus)
}
#endif

#endif	/* !defined(_TMFAT32_RAM_H_) */