/* ============================================================================ * Copyright (c) 2008-2012 Texas Instruments Incorporated. * Except for those rights granted to you in your license from TI, all rights * reserved. * * Software License Agreement * Texas Instruments (TI) is supplying this software for use solely and * exclusively on TI devices. The software is owned by TI and/or its suppliers, * and is protected under applicable patent and copyright laws. You may not * combine this software with any open-source software if such combination would * cause this software to become subject to any of the license terms applicable * to such open source software. * * THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS. * NO WARRANTIES APPLY TO THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY. * EXAMPLES OF EXCLUDED WARRANTIES ARE IMPLIED WARRANTIES OF MERCHANTABILITY * AND FITNESS FOR A PARTICULAR PURPOSE AND WARRANTIES OF NON-INFRINGEMENT, * BUT ALL OTHER WARRANTY EXCLUSIONS ALSO APPLY. FURTHERMORE, TI SHALL NOT, * UNDER ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, CONSEQUENTIAL * OR PUNITIVE DAMAGES, FOR ANY REASON WHATSOEVER. * ============================================================================ */ /********************************************************************************/ /* $Id: ata.h,2.4+ $ */ /* */ /* This is proprietary information, not to be published -- TI INTERNAL DATA */ /* Copyright (C) 2000, Texas Instruments, Inc. All Rights Reserved. */ /* */ /* Author: Susmit Pal */ /* Date: November 6, 2002 */ /* Modified Date: November 28, 2002 */ /* Last Modified Date: February 11, 2003 */ /********************************************************************************/ /*SUSMIT - ATA-FS2.4+ Customized */ #ifndef _ata_h #define _ata_h 1 #include /* Add definitions for ROM support */ #define ATA_systemInit vATA_systemInit #define ATA_getSerialID vATA_getSerialID #define ATA_read vATA_read #define ATA_readLittleEndian vATA_readLittleEndian #define ATA_seek vATA_seek #define ATA_seek_relative vATA_seek_relative #define ATA_sleep vATA_sleep #define ATA_fileInit vATA_fileInit #define ATA_cdRoot vATA_cdRoot #define ATA_cd vATA_cd #define ATA_findFirst vATA_findFirst #define ATA_findNext vATA_findNext #define ATA_isDir vATA_isDir #define ATA_errorCallback vATA_errorCallback #define ATA_getLongName vATA_getLongName #define ATA_tell vATA_tell #define ATA_create vATA_create #define ATA_createDirectory vATA_createDirectory #define ATA_delete vATA_delete #define ATA_rename vATA_rename #define ATA_write vATA_write #define ATA_close vATA_close #define ATA_format vATA_format #define ATA_setFileName vATA_setFileName #define ATA_setDirectoryName vATA_setDirectoryName #define ATA_diskSize vATA_diskSize #define ATA_diskUsed vATA_diskUsed #define ATA_diskFree vATA_diskFree #define ATA_setDateTime vATA_setDateTime #define ATA_setAttr vATA_setAttr #define ATA_vol vATA_vol #define ATA_label vATA_label #define ATA_setLongFileName vATA_setLongFileName #define ATA_createLong vATA_createLong #define ATA_deleteLong vATA_deleteLong #define ATA_renameLong vATA_renameLong #define ATA_setLongDirectoryName vATA_setLongDirectoryName #define ATA_createDirectoryLong vATA_createDirectoryLong #define ATA_readSector vATA_readSector #define ATA_writeSector vATA_writeSector #define ATA_read_b vATA_read_b #define ATA_seek_b vATA_seek_b #define ATA_write_b vATA_write_b #define ATA_tell_b vATA_tell_b #define _AtaGetDirEntry vAtaGetDirEntry #define _AtaFindNextBrokenCluster vAtaFindNextBrokenCluster #define _AtaCalculatePhySectorAndOffsetFromOffsetFromBootSector vAtaCalculatePhySectorAndOffsetFromOffsetFromBootSector #define _AtaCalculatePhySectorAndOffsetFromDirEntry vAtaCalculatePhySectorAndOffsetFromDirEntry #define _AtaFindNext vAtaFindNext #define _AtaFindNextAvailableCluster vAtaFindNextAvailableCluster #define _AtaWriteFatEntry vAtaWriteFatEntry #define _AtaCreate vAtaCreate #define _AtaCreateDirectory vAtaCreateDirectory #define _AtaIncrementFatEntryOffsetAndAlignment vAtaIncrementFatEntryOffsetAndAlignment #define _AtaRead vAtaRead #define _AtaReadByte vAtaReadByte #define _AtaReadWord vAtaReadWord #define _AtaReadDoubleWord vAtaReadDoubleWord #define _AtaFlush vAtaFlush #define _AtaReadSector vAtaReadSector #define _AtaReadFatEntry vAtaReadFatEntry #define _AtaCalculatePhySectorAndOffsetFromCluster vAtaCalculatePhySectorAndOffsetFromCluster #define _AtaCalculatePhySectorAndOffsetOfFatEntry vAtaCalculatePhySectorAndOffsetOfFatEntry #define _AtaReadFatEntryAtPhySector vAtaReadFatEntryAtPhySector #define _AtaWriteFatEntryAtPhySector vAtaWriteFatEntryAtPhySector #define _AtaCreateLFNEntry vAtaCreateLFNEntry #define _AtaWriteFatEntry4 vAtaWriteFatEntry4 #define _AtaFindVol vAtaFindVol #define _Ata_lfn_checksum vAta_lfn_checksum #define AtaGetLFN vAtaGetLFN #define _AtaRead_b vAtaRead_b #define ATA_MAX_LONG_NAME_SIZE 261 #define ATA_MEDIA_ID_WORDS 16 #define ATA_ATTR_READ_ONLY 0x01 #define ATA_ATTR_HIDDEN 0x02 #define ATA_ATTR_SYSTEM 0x04 #define ATA_ATTR_VOLUME 0x08 #define ATA_ATTR_DIRECTORY 0x10 #define ATA_ATTR_ARCHIVE 0x20 #define ATA_ERROR_NONE 0x0000 #define ATA_ERROR_UNSUPPORTED 0x0001 #define ATA_ERROR_NESTED 0x0002 #define ATA_ERROR_TIMEOUT 0x0004 #define ATA_ERROR_BAD_MEDIA 0x0008 #define ATA_ERROR_EOF 0x0010 #define ATA_ERROR_FILE_NOT_FOUND 0x0020 #define ATA_ERROR_ID_NOT_FOUND 0x0040 #define ATA_ERROR_MEDIA_NOT_FOUND 0x0080 #define ATA_ERROR_MEDIA_REMOVED 0x0100 #define ATA_ERROR_DISK_FULL 0x0200 /*ADD NEW MEDIA ID HERE*/ #define MMC 1 #define SD 2 #define NAND 3 #define CF 4 #define IDE 5 #define MS 6 #if 0 typedef unsigned int AtaUint16; typedef unsigned long AtaUint32; typedef AtaUint32 AtaSector; typedef AtaUint32 AtaFileSize; #endif /*typedef changed by ra*/ typedef Uint16 AtaUint16; typedef Uint32 AtaUint32; typedef Uint32 AtaSector; typedef Uint32 AtaFileSize; #ifndef DISABLE_FAT32 typedef AtaUint32 AtaCluster; typedef AtaUint32 AtaDirEntry; #else typedef AtaUint16 AtaCluster; typedef AtaUint16 AtaDirEntry; #endif /*typedef int AtaError;*//*SUSMIT - This should be unsigned int*/ typedef AtaUint16 AtaError; typedef AtaUint16 AtaSerialID[ATA_MEDIA_ID_WORDS]; #define ATA_FAT_TYPE_12 0x01 #define ATA_FAT_TYPE_16 0x04 /* 16-bit FAT. Partitions smaller than 32MB */ #define ATA_FAT_TYPE_32 0x0B /* 32-bit FAT. Partitions up to 2047GB */ typedef struct AtaStateStruct { AtaSector BootPhySector; AtaUint16 FatType; AtaUint16 WordsPerLogSector; AtaUint16 LogSectorsPerCluster; AtaUint16 RootDirEntries; AtaUint32 LogSectorsPerFat; AtaSector FirstFatSector; AtaSector RootDirSector; AtaSector FirstDataSector; AtaSector TotalSectors; AtaUint16 Data; AtaUint16 CurrentWord; AtaSector CurrentPhySector; AtaUint16 WordsPerCluster; AtaUint16 NumberOfFats; AtaUint16 MFWFlag; AtaError Err_Status; #ifdef ATA_HDD /*SUSMIT - Support for media which can support multi-block operations, user configurable*/ AtaUint16 Multi_block_Flag; /*SUSMIT - Support for media which can support multi-block operations, user configurable*/ #endif /* ATA_HDD */ void *pAtaMediaState; AtaError (*AtaReset)(void *pAtaMediaState); int (*AtaCommandReadyStatusCheck)(void *pAtaMediaState); AtaError (*AtaBusyStatusCheck)(void *pAtaMediaState); AtaUint16 (*AtaGetSerialID)(void *pAtaMediaState, AtaSerialID *pID); AtaError (*AtaIssueReadCommand)(AtaSector PhySector, void *pAtaMediaState, AtaUint16 SectorCount); AtaError (*AtaDataReadyStatusCheck)(void *pAtaMediaState); AtaError (*AtaReadNextWord)(void *pAtaMediaState, AtaUint16 *pWord); AtaError (*AtaReadNextNWords)(void *pAtaMediaState, AtaUint16 *pWord, AtaUint16 Count); AtaError (*AtaWriteSector)(AtaSector PhySector, void *pAtaMediaState, AtaUint16 *pWord, int ByteSwap); AtaError (*AtaWriteSectorFlush)(void *pAtaMediaState); AtaError (*AtaInitAtaMediaState)(void *pAtaState1); void (*AtaErrorCallback)(unsigned short Error); /*SUSMIT - Support for media which has floppy like filesystem with only a bootsector but no MBR*/ AtaUint16 (*AtaFileSystemType)(void *pAtaMediaState); /*SUSMIT - Support for media which has floppy like filesystem with only a bootsector but no MBR*/ #ifdef ATA_HDD /*SUSMIT - Support for media which can support multi-block operations, user configurable*/ AtaError (*AtaReadSectorB)(AtaSector PhySector, void *pAtaMediaState, AtaUint16 *pWord, AtaUint16 ByteSwap); AtaError (*AtaWriteSectorB)(AtaSector PhySector, void *pAtaMediaState, AtaUint16 *pWord, AtaUint16 ByteSwap); AtaError (*AtaWriteFlushB)(void *pAtaMediaState); AtaUint16 (*AtaReadWordB)(AtaSector PhySector, void *pAtaMediaState, AtaUint16 ByteOffset); /*SUSMIT - Support for media which can support multi-block operations, user configurable*/ #endif /* ATA_HDD */ /*-----------------2002-08-20 1:02PM---------------- * The following globals should be referenced * through the state structure * Also, it should be noted which functions use these * so that they can be sure to be initialized before * those functions are called. * These will anyway be initilized before ATA_systemInit * --------------------------------------------------*/ AtaUint16 (*get_mod_time)(); AtaUint16 (*get_mod_date)(); AtaUint16 (*get_time)(); AtaUint16 (*get_date)(); AtaUint16 *_AtaWriteBuffer; AtaSector _AtaWriteCurrentPhySector; } AtaState; /* File Descriptor */ typedef struct AtaFileStruct { char Filename[9]; /* unpacked characters for filename (00XX, where XX is the ASCII character */ /* null terminated (last character is 0000) */ char Ext[4]; /* unpacked characters for extension (00XX, where XX is the ASCII character */ /* null terminated (last character is 0000) */ AtaUint16 Attributes; /* file attribute byte in LSB */ AtaUint16 Time; /* time record from FDB */ AtaUint16 Date; /* date record from FDB */ AtaUint16 reserved1; /* was unsigned int ByteSwap; byte swap mode for AtaRead and AtaWrite */ AtaCluster StartCluster; /* starting cluster number */ AtaFileSize Size; /* current file size in bytes */ AtaCluster Cluster; /* current cluster number (initialized to StartCluster) */ AtaUint16 WordInCluster; /* current byte offset from start of cluster (initialized to 0) */ AtaCluster NextBrokenCluster; /* next cluster where fragment occurs (for Read and Write) */ AtaCluster PrevBrokenCluster; /* first cluster where contiguous cluster chain started (used for Write) */ AtaSector CurrentDirSector; /* sector of start of current directory entries (only used for root dir)*/ AtaDirEntry CurrentDirEntry; /* entry number in current directory */ AtaDirEntry CurrentDirSectorTag; /* number of clusters from start of dir of CurrentDirSector */ AtaCluster StartDirCluster; /* directory starting cluster number */ /* AtaCluster CurrentDirCluster;*/ /* cluster where current directory is located */ /*SUSMIT_ DIRECTORY BRWOSING BUGFIX*/ AtaFileSize CurrentByte; /* current byte in the file */ AtaState *pDrive; /* pointer to drive state structure */ } AtaFile; /*-----------------2002-08-20 4:14PM---------------- * These file names are no longer valid. I created * several new files to aide with the vector. * --------------------------------------------------*/ /* -----------------5/16/2000 4:18PM----------------- Ata.c (included in ldknl) --------------------------------------------------*/ /* SUSMIT - 25 FEB 2003 */ /*AtaError ATA_systemInit(AtaState *pAtaDrive);*/ AtaError ATA_systemInit(AtaState *pAtaDrive, AtaUint16 disk_type); /* SUSMIT - 25 FEB 2003 */ AtaUint16 ATA_getSerialID(AtaState *pAtaDrive, AtaSerialID *pID); /* -----------------5/16/2000 4:19PM----------------- AtaRead.c (included in ldknl) --------------------------------------------------*/ AtaError ATA_read(AtaFile *pAtaFile, AtaUint16 *Data, AtaUint16 Words); AtaError ATA_readLittleEndian(AtaFile *pAtaFile, AtaUint16 *Data, AtaUint16 Words); /*SUSMIT - Absolute Seek*/ AtaError ATA_seek(AtaFile *pAtaFile, AtaFileSize OffsetFromStart); /*SUSMIT - Relative Seek*/ AtaError ATA_seek_relative(AtaFile *pAtaFile, long OffsetFromCurrent); AtaError ATA_sleep(AtaState *pAtaDrive); /* -----------------5/16/2000 4:19PM----------------- AtaDir.c --------------------------------------------------*/ AtaError ATA_fileInit(AtaState *pAtaDrive, AtaFile *pAtaFile); AtaError ATA_cdRoot(AtaFile *pAtaFile); AtaError ATA_cd(AtaFile *pAtaFile); AtaError ATA_findFirst(AtaFile *pAtaFile); AtaError ATA_findNext(AtaFile *pAtaFile); int ATA_isDir(AtaFile *pAtaFile); void ATA_errorCallback(unsigned short Error); /* -----------------5/16/2000 4:19PM----------------- AtaLong.c --------------------------------------------------*/ AtaError ATA_getLongName(AtaFile *pAtaFile, char *LongName, AtaUint16 StartOffset, AtaUint16 Length); /* -----------------5/16/2000 4:19PM----------------- AtaTell.c --------------------------------------------------*/ AtaError ATA_tell(AtaFile *pAtaFile, AtaFileSize *pOffsetInFile); /* -----------------5/16/2000 4:20PM----------------- AtaWrite.c --------------------------------------------------*/ AtaError ATA_create(AtaFile *pAtaFile); AtaError ATA_createDirectory(AtaFile *pAtaFile); AtaError ATA_delete(AtaFile *pAtaFile); AtaError ATA_rename(AtaFile *pAtaFile); AtaError ATA_write(AtaFile *pAtaFile, AtaUint16 *Data, AtaUint16 Words); AtaError ATA_close(AtaFile *pAtaFile); /* -----------------07/27/2000 10:53PM--------------- AtaFormat.c (Does exist now! - Susmit) --------------------------------------------------*/ AtaError ATA_format(AtaState *pDrive, int flag); /*SUSMIT_UPDATE Adding some more user level APIs. Added in AtaDir.c*/ AtaError ATA_setFileName(AtaFile *pAtaFile, char *name, char *ext); AtaError ATA_setDirectoryName(AtaFile *pAtaFile, char *dirname); /*Added in AtaDisk.c*/ AtaUint32 ATA_diskSize(AtaState *pAtaState); AtaUint32 ATA_diskUsed(AtaState *pAtaState, AtaError *ret_stat); AtaUint32 ATA_diskFree(AtaState *pAtaState, AtaError *ret_stat); /*SUSMIT - new requirements*/ AtaError ATA_setDateTime(AtaFile *pAtaFile); AtaError ATA_setAttr(AtaFile *pAtaFile, AtaUint16 Attr); AtaError ATA_vol(AtaState *pAtaDrive, char *volname); AtaError ATA_label(AtaState *pAtaDrive, char *volname); AtaError ATA_setLongFileName( AtaFile *pAtaFile, char *LongName ); AtaError ATA_createLong(AtaFile *pAtaFile, char *longname); AtaError ATA_deleteLong(AtaFile *pAtaFile); AtaError ATA_renameLong(AtaFile *pAtaFile, char *longnamenew); AtaError ATA_setLongDirectoryName( AtaFile *pAtaFile, char *LongName ); AtaError ATA_createDirectoryLong(AtaFile *pAtaFile, char *longname); /*SUSMIT - new requirements*/ /*SUSMIT - USB_MSC Requirements*/ AtaError ATA_readSector(AtaSector PhySector, AtaState* pAtaState, AtaUint16 *Word, int ByteSwap); AtaError ATA_writeSector(AtaSector PhySector, AtaState* pAtaState, AtaUint16 *Word, int ByteSwap); /*SUSMIT - USB_MSC Requirements*/ /*SUSMIT - Configurable MFW Requirements*/ void ATA_enableMFW(AtaState *pAtaState); #ifdef ATA_HDD void ATA_enableMultiBlock(AtaState *pAtaState); #endif /* ATA_HDD */ /*SUSMIT - Configurable MFW Requirements*/ /*SUSMIT - Byte Level File Handling Requirements*/ AtaError ATA_read_b(AtaFile *pAtaFile, AtaUint16 *Data, AtaUint16 bytes); AtaError ATA_seek_b(AtaFile *pAtaFile, AtaUint32 ByteOffsetFromStart); AtaError ATA_write_b(AtaFile *pAtaFile, AtaUint16 *Data, AtaUint16 bytes); AtaError ATA_tell_b(AtaFile *pAtaFile, AtaFileSize *pByteOffsetInFile); /*SUSMIT - Byte Level File Handling Requirements*/ #endif