fs_internal.h 19 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *	fs_internal.h
 *
 * Project:
 * --------
 *   Maui
 *
 * Description:
 * ------------
 *    This file defines the internals of file system abstraction layer
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/
#ifndef _FS_INTERNAL_H
#define _FS_INTERNAL_H

#include "kal_general_types.h"
#include "rtfiles.h"
#include "fs_type.h"

/************************* Internal Define *************************/
#define MT_REC_RMDIR             0x00000001           //MTExtDelete
#define MT_REC_SAVE_NAME         0x00000002           //MTExtFindReset
#define MT_MAX_MSDC_TYPE         3                    //MTTestMSDC, MTCloseMSDC
#define MT_MAX_FILE_NUM          256                  //MTExtFindReset: max file/folder number under one folder
#define CopyBufferSize           512*4                //CopyFile, GetSaveNameByIndex
#define MT_PGS_PERCENTAGE        5                    //CopyFile
#define MT_PGS_PERIOD_MASK       0xfffffff0           //CopyFileLightWeight(), trigger user call back every 16 frame ~ 72ms
#define MT_MAX_WIDE_NAME         512
#define MT_MAX_WIDE_PATH         (RTF_MAX_PATH+4)     //+4 for recursive action
#define MT_MAX_QUOTA_ENTRY       40                   //For gFS_ExtQuotaSet entry
#define MT_MAXPATH_IN_WCHAR_UNIT (RTF_MAX_PATH/2)                  //RTF_MAX_PATH = 520 char = 260 wide-char
   //FS_Move internal flag to distinguish status
#define MT_XMOVE_SRC_EXIST       0x00000001           //will be forbidden initial if fail
#define MT_XMOVE_SRC_IS_FOLDER   0x00000002
#define MT_XMOVE_SRC_IS_VIRTUAL  0x00000004
#define MT_XMOVE_SRC_ATTR_RO     0x00000008
#define MT_XMOVE_SRC_DEVICE_RO   0x00000010
#define MT_XMOVE_DEST_EXIST      0x00000100
#define MT_XMOVE_DEST_IS_FOLDER  0x00000200
#define MT_XMOVE_DEST_ATTR_RO    0x00000400
#define MT_XMOVE_DEST_DEVICE_RO  0x00000800           //will be forbidden initial if fail
#define MT_XMOVE_SAME_DRIVE      0x00001000
#define MT_XMOVE_SAME_DEVICE     0x00002000
#define MT_XMOVE_COPYSECTOR      0x00004000
   // Recursive Config
#define RECCONF_NAMEBUF_GUARD_PRINT     (0xF5F5FAFA)
#define RECCONF_NAMEBUF_PACKAGE_SIZE    (RTF_MAX_PATH + 4 /* additional null */ + sizeof(int) /* guard */)
#define RECCONF_DIRSTACK_SIZE           (39 * sizeof(RTFDirEntry)) // 39 * 52 = 2028

typedef enum
{
   API_ENUM_OPEN = 1,
   API_ENUM_OPENHINT,
   API_ENUM_CLOSE,
   API_ENUM_CLOSEALL,
   API_ENUM_READ,
   API_ENUM_WRITE,
   API_ENUM_SETSEEKHINT,
   API_ENUM_SEEK,
   API_ENUM_COMMIT,
   API_ENUM_RELEASEFH,
   API_ENUM_ABORT,
   API_ENUM_PARSEFH,
   API_ENUM_GETFILEINFO,
   API_ENUM_GETFILESIZE,
   API_ENUM_GETFILEPOSITION,
   API_ENUM_SETFILETIME,
   API_ENUM_GETATTRIBUTES,
   API_ENUM_GETFIRSTCLUSTER,
   API_ENUM_SETATTRIBUTES,
   API_ENUM_DELETE,
   API_ENUM_PSEUDOMERGE,
   API_ENUM_CHECKFILE,
   API_ENUM_GETCURRENTDIR,
   API_ENUM_SETCURRENTDIR,
   API_ENUM_CREATEDIR,
   API_ENUM_REMOVEDIR,
   API_ENUM_GETFOLDERSIZE,
   API_ENUM_EXTEND,
   API_ENUM_TRUNCATE,
   API_ENUM_MAKEFILENAME,
   API_ENUM_RENAME,
   API_ENUM_MOVE,
   API_ENUM_COUNT,
   API_ENUM_XDELETE,
   API_ENUM_FINDFIRST,
   API_ENUM_FINDNEXT,
   API_ENUM_FINDFIRSTN,
   API_ENUM_FINDNEXTN,
   API_ENUM_FINDCLOSE,
   API_ENUM_XFINDRESET,
   API_ENUM_XFINDSTART,
   API_ENUM_XFINDCLOSE,
   API_ENUM_CREATEBOOTSECTOR,
   API_ENUM_GETPARTITIONINFO,
   API_ENUM_COMMITALL,
   API_ENUM_GETDRIVE,
   API_ENUM_MAPPINGDRIVE,
   API_ENUM_GENERALFORMAT,
   API_ENUM_QMGETFREE,
   API_ENUM_GETCLUSTERSIZE,
   API_ENUM_CHECKDRIVE,
   API_ENUM_CREATEMASTERBOOTRECORD,
   API_ENUM_SPLITPARTITION,
   API_ENUM_GETDISKINFO,
   API_ENUM_SHUTDOWN,
   API_ENUM_UNLOCKALL,
   API_ENUM_SANITYCHECK,
   API_ENUM_SETDISKFLAG,
   API_ENUM_CHECKDISKFLAG,
   API_ENUM_CLEARDISKFLAG,
   API_ENUM_GETDEVTYPE,
   API_ENUM_GETDEVSTATUS,
   API_ENUM_LOCKFAT,
   API_ENUM_TESTMSDC,
   API_ENUM_CLOSEMSDC,
   API_ENUM_SETTRACE,
   API_ENUM_DUMPFHTABLE,
   API_ENUM_GENVIRTUALFILENAME,
   API_ENUM_CONFIGEXTDEVICE,
   API_ENUM_GETDIRCACHE,
   API_ENUM_SETDIRCACHE,
   API_ENUM_EXPIREDIRCACHE,
   API_ENUM_OTPREAD,
   API_ENUM_OTPWRITE,
   API_ENUM_OTPLOCK,
   API_ENUM_OTPQUERYLENGTH,
   API_ENUM_SWEEPDEVICE,
   API_ENUM_COUNTUSEDFH,
   API_ENUM_GETDEVPARTITIONS,
   API_ENUM_RECOVERDEVICE,
   API_ENUM_SETVOLUMELABEL,
   API_ENUM_SWITCHDRIVEMODE,
   API_ENUM_IOCTRL,
   API_ENUM_COMPACTDIR
}FS_API_ENUM;

/* ---  ScanDrive Engine Internal Usage */
typedef RTFCluster MTRAWClusterValue(RTFDrive * Drive, RTFCluster Cluster);

typedef struct __InternScanDataStruct {
   RTFDrive             * Drive;
   MTRAWClusterValue    * RAWCluster;
   BYTE                 * ClusterMap;
   RTFDOSDirEntry         D;
   RTFCluster             ClsOffset;
   RTFCluster             ClsSpan;
   RTFCluster             ClsRange;
}InternScanDataStruct;

/* ---  Recursive Engine Internal Usage, Act priviate data */
typedef struct __InternCallBackParameter {
   // Configured parameter
   kal_uint32             Flag;
   FS_ProgressCallback  * Progress;
   UINT                   Total;
   UINT                   ProgInfo;
   void                 * PrivateData;
   // Final Result and Status
   int                    Result;
   int                    ErrorCode;
   // Run-Time Self-Use Context, Optional for temporal / sparital coherence
   RTFDrive             * Drive;
   MTRAWClusterValue    * RAWCluster;
}InternCallBackData;

typedef struct __InternRecursiveEngineStruct {
   // Run-Time Used Resource
   WCHAR                * NameBuf;
   WCHAR                * CurrPath;
   WCHAR                * DestPath;         /* 3rd Name Buffer used by XDelete or XCopy */
   RTFDirEntry          * LevelStack;
   // Boundary Check
   int                    LevelLimit;
   UINT                   CurrLeftLen;
   // Final Result and Status
   int                    TravStatus;
   // Configure-Time Setup , Generic CallBack Functions
   UINT                   PrefixPathLen; /* Length of the Prefix Path in CurrPath */
   UINT                   DestPrefixPathLen; /* Length of the Prefix Path in DestPath */
   int                    CallerAddress;     /* Caller Address (LR) of the FS API User */
   InternCallBackData     Parameters;
}InternRecursiveEngineStruct;

typedef int MTGenericCallBack(InternRecursiveEngineStruct *RES, WCHAR *ObjName, RTFDOSDirEntry *ObjInfo);

#ifdef __FS_SORT_SUPPORT__

extern const UINT FS_SORTING_MAX_ENTRY;

#define ABS(x)    (x>0? x: -x)
#define FS_SORTING_SIGNATURE           "FSST"
#define SWAP(x, y) { x^=y; y^=x; x^=y; }

#define SWAP_SORTING_ENTRY(x, y)                                    \
{                                                                   \
        SWAP(HintList[x], HintList[y]);                             \
        SWAP(PosList[x].Cluster, PosList[y].Cluster);               \
        SWAP(PosList[x].Index, PosList[y].Index);                   \
}

#define SWAP_SORTING_ENTRY_FILE(x, y)                               \
{                                                                   \
        SWAP(HintList_File[x], HintList_File[y]);                   \
        SWAP(PosList_File[x].Cluster, PosList_File[y].Cluster);     \
        SWAP(PosList_File[x].Index, PosList_File[y].Index);         \
}

#define FS_SORTING_IS_FLAG_HINT_DISABLED  (0x80)

typedef struct
{
    BYTE                Signature[4];
    FS_SORT_PGS_ENUM    Status;
    BYTE                Flag;

    int                 TotalCount;
    int                 ReadyCount;
    int                 FolderCount;
    int                 FileCount;
    RTFDirLocation      *PosList;
    RTFDirLocation      *PosList_File;

    int                 MaxCount;

    int                 UserLock;

    // Working Buffer
    UINT                *HintList;
    UINT                *HintList2;
    UINT                *HintList_File;
    UINT                *HintList2_File;
    BYTE                *FileName;
    BYTE                *TmpName1;
    BYTE                *TmpName2;

    RTFDOSDirEntry      *FileInfo;

    char                *FreeCacheList;

    UINT                MaxFileNameLength;

    UINT                DirCluster;
} FSSortingInternalS; /* ! MUST SYNC WITH FS_SORT_SORTING_BUFFER_SIZE_FOR_FILES ! */

#endif /* __FS_SORT_SUPPORT__ */

/************************* Internal APIs *************************/
extern void SweepDrive(BYTE DriveIdx);
extern int  ChkQuotaConfig(BYTE DriveIdx);
extern void CloseDevice(RTFDevice * Dev);
extern int  ReleaseFH(void * TaskId);
extern int  CountUsedFH(void * TaskId);

extern int CopyFileLightWeight(const WCHAR * SrcFullPath, const WCHAR * DstFullPath, FS_ProgressCallback Progress, BYTE * Buffer, int BufferLen, kal_uint32 caller_address);
extern int CopyFileOnSameDrive(const WCHAR * SrcFullPath, const WCHAR * DstFullPath, FS_ProgressCallback Progress, BYTE * Buffer, int BufferLen, kal_uint32 caller_address);
extern int CreateCopyDestPath(const WCHAR * SrcFullPath, const WCHAR * DstFullPath);

extern int fs_srv_get_name_by_pos(RTFile * f, const WCHAR * Pattern, RTFDOSDirEntry * FileInfo, WCHAR * FileName, UINT MaxLength, RTFDirLocation * Pos, UINT Flag);

#ifdef __FS_SORT_SUPPORT__
extern int  GetFindByPos(const WCHAR * Pattern, RTFDOSDirEntry * FileInfo, WCHAR * FileName, kal_uint32 MaxLength, RTFDirLocation * Pos, kal_uint32 Flag);
extern int  Sort(const WCHAR * FileName, WCHAR * TmpName, RTFDOSDirEntry * FileInfo, kal_uint32 Flag, RTFDirLocation * PosList, kal_uint32 * Hex, kal_uint32 Index, const WCHAR * Pattern, RTFDirLocation * Pos);
extern int  CompareFileName(WCHAR *FileName1, UINT*Hint1, WCHAR *FileName2, UINT *Hint2);
extern int  CreateHeap(FS_SortingParam *Param, FSSortingInternalS *SortingData);
extern int  HeapSort(FS_SortingParam *Param, FSSortingInternalS *SortingData);
#endif

extern int  GetNameByPos(RTFile *f, WCHAR * FileName, UINT MaxLength, RTFDirLocation *Pos, RTFDOSDirEntry *FileInfo);
extern int  FindFirst(const WCHAR * NamePattern, FS_Pattern_Struct * PatternArray, kal_uint32 PatternNum, BYTE ArrayMask, BYTE Attr, BYTE AttrMask, RTFDOSDirEntry * FileInfo, WCHAR * FileName, UINT MaxLength, RTFDirLocation * Pos_Hint, UINT *DirCluster);
extern int  FindNext(RTFHANDLE Handle, FS_Pattern_Struct * PatternArray, kal_uint32 PatternNum, BYTE ArrayMask, RTFDOSDirEntry * FileInfo, WCHAR * FileName, kal_uint32 MaxLength, RTFDirLocation * Pos_Hint);

#ifdef __FS_QM_SUPPORT__
extern void SweepDrive(BYTE DriveIdx);
#endif

#ifdef __FS_CHECKDRIVE_SUPPORT__
extern int  ScanDrive(RTFDrive * Drive, void * Buffer, unsigned int BufferLen);
#endif

#ifdef __P_PROPRIETARY_COPYRIGHT__
/* under construction !*/
#endif

extern int MTMakeFileName(RTFDrive * Drive, RTFDirLocation * Pos, WCHAR * FileName, UINT MaxLength);
extern int MTGenVirtualFileName(FS_HANDLE F, WCHAR * VFNBuf, UINT BufLen, UINT Offset, UINT Length);
extern int FindDeviceNumberByDriveIdx(int DriveIdx);
extern RTFDevice * FindFirstDeviceByType(FS_DEVICE_TYPE_ENUM);
extern int MountRemovableDevice(RTFDevice *Dev);
extern int ReMountDriveAndCountFreeClusters(RTFDrive *Drive);

      /* Object (File/Folder) Identify */
extern int GetFirstClusterByFileHandle(RTFHANDLE FileHandle, UINT * Cluster);
extern int GetFirstClusterByFileName(const WCHAR *FileName, UINT * Cluster);

      /* Recursive Class -- Engine */
RTFHANDLE RecTravStart(WCHAR * PathNamePattern);
int RecTravClose(RTFHANDLE Handle);

      /* Recursive Class -- Search */
void RecTravCore_DFS(InternRecursiveEngineStruct *TravCB, RTFHANDLE TravFH, MTGenericCallBack *Act);
void RecTravCore_BFS(InternRecursiveEngineStruct *TravCB, RTFHANDLE TravFH, MTGenericCallBack *Act);
void RecTravCore_Flat(InternRecursiveEngineStruct *TravCB, RTFHANDLE TravFH, MTGenericCallBack *Act);
void RecTravCore_CloseAndRootNodeAct(InternRecursiveEngineStruct *TravCB, RTFHANDLE TravFH, MTGenericCallBack *Act);
#ifdef __P_PROPRIETARY_COPYRIGHT__
/* under construction !*/
#endif

      /* Recursive Class -- Action */
int RecAct_List(InternRecursiveEngineStruct *RES, WCHAR *ObjName, RTFDOSDirEntry *ObjInfo);
int RecAct_CountNum(InternRecursiveEngineStruct *RES, WCHAR *ObjName, RTFDOSDirEntry *ObjInfo);
int RecAct_CountSize(InternRecursiveEngineStruct *RES, WCHAR *ObjName, RTFDOSDirEntry *ObjInfo);
#ifdef __P_PROPRIETARY_COPYRIGHT__
/* under construction !*/
/* under construction !*/
#endif

      /* Recursive Class -- Config */
int RecConf_Alloc(InternRecursiveEngineStruct **RES, BYTE *RecursiveStack, const UINT StackSize);
void RecConf_Free(InternRecursiveEngineStruct **RES, BYTE *RecursiveStack, const UINT StackSize);
void RecConf_MemoryChecker(InternRecursiveEngineStruct **RES);

      /* Recursive Class -- API auxilary */

typedef int RecAUX_FuncType(UINT Flag, FS_HANDLE TravFH, InternRecursiveEngineStruct *ReCB);

int RecAUX(const WCHAR * FullPath, UINT Flag, FS_ProgressCallback Progress, BYTE *RecursiveStack, const UINT StackSize, RecAUX_FuncType Aux);
int RecAUX_CountObject(UINT Flag, FS_HANDLE TravFH, InternRecursiveEngineStruct *ReCB);
int RecAUX_CountSize(UINT Flag, FS_HANDLE TravFH, InternRecursiveEngineStruct *ReCB);
int RecAUX_Delete(UINT Flag, FS_HANDLE TravFH, InternRecursiveEngineStruct *ReCB);

int RecAUX_IsFolder(const WCHAR * PathName, kal_bool rw_check);
int RecAUX_TestSrcAndDestPath(const WCHAR * SrcPathName, const WCHAR * DestPathName, UINT Flag);

#if 0
/* under construction !*/
/* under construction !*/
/* under construction !*/
#endif


int RecAUX_XCopyFolder(const WCHAR * FullPath, const WCHAR * DstPath, int Status,
                       FS_ProgressCallback Progress, UINT Total,
                       BYTE *RecursiveStack, const UINT StackSize, kal_uint32 caller_address);

#ifdef __AUDIO_DSP_LOWPOWER__
int MTQueryPhysicalMap(FS_PMapInfo* PMapInfo);
#endif

/************* Internal Data *************/
#ifdef __FS_CHECKDRIVE_SUPPORT__
extern kal_bool g_CheckDrive;
#endif

extern kal_bool g_Xdelete;
extern kal_bool g_ExternalDevice;

extern UINT FS_MAX_COPY_CLUSTER;

#ifdef __P_PROPRIETARY_COPYRIGHT__
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
/* under construction !*/
#endif

extern FS_HANDLE gFS_USBMS_PhoneDriveHandle;

#endif //_FS_INTERNAL_H