pimafile.h

dz3000_51.0.0.4.rar

/*++

Copyright (c) 2001 Sunplus Technology Co., Ltd.

Module Name:

        pimafile.h

Abstract:

        Header file related to PIMA 15740 PTP with file system

Environment:

        Keil C51 Compiler

Revision History:

        08/28/2001      Chi-Yeh Tsai    created                 

--*/
//------------------------------------------------------------------------------
//Constant
//------------------------------------------------------------------------------

//Storage ID
#define K_PIMADATA_IDStorage			0x05050505

#define K_PIMADATA_StorageIDsSize		0x00000001
typedef struct _PIMADATA_STORAGE_ID
{
	ULONG   storageIDsSize;
	ULONG   storageIDs[K_PIMADATA_StorageIDsSize];
} PIMADATA_STORAGE_ID, *PPIMADATA_STORAGE_ID;


//Storage Info
#define K_PIMADATA_MaxCapacitySize		0x08
#define K_PIMADATA_FreeSpaceInByteSize		0x08
typedef struct _PIMADATA_STORAGE_INFO
{
        USHORT  storageType;
        USHORT  filesystemType;
        USHORT  accessCapability;
        UCHAR   maxCapacity[K_PIMADATA_MaxCapacitySize];
        UCHAR   freeSpaceInByte[K_PIMADATA_FreeSpaceInByteSize];
	ULONG   freeSpaceInImage;
        //STR0x00 storageDescription;
        //STR0x00 volumnLabel;
        UCHAR   storageDescription;
        UCHAR   volumnLabel;
} PIMADATA_STORAGE_INFO, *PPIMADATA_STORAGE_INFO;

#define K_PIMADATA_StorageType_Undefined	0x0000
#define K_PIMADATA_StorageType_FixedRom		0x0100
#define K_PIMADATA_StorageType_RemovableRom	0x0200
#define K_PIMADATA_StorageType_FixedRam		0x0300
#define K_PIMADATA_StorageType_RemovableRam	0x0400

#define K_PIMADATA_FilesystemType_Undefined	0x0000
#define K_PIMADATA_FilesystemType_GenericFlat	0x0100
#define K_PIMADATA_FilesystemType_GenericHier	0x0200
#define K_PIMADATA_FilesystemType_DCF		0x0300

#define K_PIMADATA_AccessCapability_ReadWrite			0x0000
#define K_PIMADATA_AccessCapability_ReadOnlyWithoutDelete	0x0100
#define K_PIMADATA_AccessCapability_ReadOnlyWitDelete		0x0200

#define K_PIMADATA_StorageDescriptionSize	0x00            //size of storage desc 
#define K_PIMADATA_VolumnLabelSize		0x00            //size of volumn label 

//Object Info
#define K_PIMADATA_ObjectInfoFileNameBufSize	0x1A0
typedef struct _PIMADATA_OBJECT_INFO
{
        ULONG	storageID;
        USHORT  objectFormat;
        USHORT	protectionStatus;
        ULONG	objectCompressedSize;
        USHORT	thumbFormat;
	ULONG	thumbCompressedSize;
	ULONG	thumbPixWidth;
	ULONG	thumbPixHeight;
	ULONG	imagePixWidth;
	ULONG	imagePixHeight;
	ULONG	imageBitDepth;
	ULONG	parentObject;
	USHORT	associationType;
	ULONG	associationDesc;
	ULONG	sequenceNumber;
	UCHAR	fileNameBuf[K_PIMADATA_ObjectInfoFileNameBufSize];
        //STR0x00 
} PIMADATA_OBJECT_INFO, *PPIMADATA_OBJECT_INFO;

//------------------------------------------------------------------------------
//External Link
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//Function Prototype
//------------------------------------------------------------------------------
UCHAR PIMAFILE_GetStorageIDs(PULONG pSize, PUCHAR pPayload);
UCHAR PIMAFILE_GetStorageInfo(ULONG storageID, PULONG pSize, PUCHAR pPayload);
UCHAR PIMAFILE_GetNumObjects(ULONG storageID, ULONG objFormatCode, ULONG objHandle, PULONG pNumObjects);
//richie@si1227
UCHAR PIMAFILE_GetObjectHandles(ULONG storageID, ULONG objFormatCode, ULONG objHandle, PULONG pSize, PUCHAR pPayload);
UCHAR PIMAFILE_GetObject(ULONG objHandle, PULONG pSize);
UCHAR PIMAFILE_GetThumb(ULONG objHandle, PULONG pSize);
UCHAR PIMAFILE_DeleteObject(ULONG objHandle, ULONG objFormatCode);
UCHAR PIMAFILE_GetPartialObject(ULONG objHandle, ULONG offsetInBytes, ULONG maxBytesObtained, PULONG pSize);