platform/inc/stbhwdsk.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error

#ifndef _STBHWDSK_H

#define _STBHWDSK_H

//---Constant and macro definitions for public use-----------------------------

#define INVALID_DISK_ID       0xffff

//---Enumerations for public use-----------------------------------------------

typedef enum
{
   FILE_MODE_READ,
   FILE_MODE_WRITE,
   FILE_MODE_OVERWRITE
} E_STB_DSK_FILE_MODE;

typedef enum
{
   FILE_POSITION_START,
   FILE_POSITION_END,
   FILE_POSITION_CURRENT
} E_STB_DSK_FILE_POSITION;

typedef enum
{
   DIR_ENTRY_FILE,
   DIR_ENTRY_DIRECTORY,
   DIR_ENTRY_OTHER
} E_STB_DIR_ENTRY_TYPE;


//---Global type defs for public use-------------------------------------------

//---Global Function prototypes for public use---------------------------------
void STB_DSKInitialise(void);

U16BIT STB_DSKGetNumDisks(void);

U16BIT STB_DSKGetDiskIdByIndex(U16BIT index);

BOOLEAN STB_DSKIsRemoveable(U16BIT disk_id);

BOOLEAN STB_DSKIsMounted(U16BIT disk_id);

BOOLEAN STB_DSKMountDisk(U16BIT disk_id);

BOOLEAN STB_DSKUnmountDisk(U16BIT disk_id);

BOOLEAN STB_DSKGetDiskName(U16BIT disk_id, U8BIT *name, U16BIT name_len);

void STB_DSKSetStandby(BOOLEAN state);

void* STB_DSKOpenFile(U16BIT disk_id, U8BIT *name, E_STB_DSK_FILE_MODE mode);

U32BIT STB_DSKReadFile(void *file, U8BIT *data, U32BIT size);

U32BIT STB_DSKWriteFile(void *file, U8BIT *data, U32BIT size);

BOOLEAN STB_DSKSeekFile(void *file, E_STB_DSK_FILE_POSITION position, S32BIT offset);

BOOLEAN STB_DSKTellFile(void *file, U32BIT *offset);

void STB_DSKCloseFile(void *file);

BOOLEAN STB_DSKDeleteFile(U16BIT disk_id, U8BIT *filename);

BOOLEAN STB_DSKFileExists(U16BIT disk_id, U8BIT *filename);

BOOLEAN STB_DSKFileSize(U16BIT disk_id, U8BIT *filename, U32BIT *filesize);

void* STB_DSKOpenDirectory(U16BIT disk_id, U8BIT *dir_name);

BOOLEAN STB_DSKReadDirectory(void *dir, U8BIT *filename, U16BIT filename_len,
   E_STB_DIR_ENTRY_TYPE *entry_type);

void STB_DSKCloseDirectory(void *dir);

BOOLEAN STB_DSKCreateDirectory(U16BIT disk_id, U8BIT *dir_path);

BOOLEAN STB_DSKDeleteDirectory(U16BIT disk_id, U8BIT *dir_name);

BOOLEAN STB_DSKFullPathname(U16BIT disk_id, U8BIT *filename, U8BIT *pathname, U16BIT max_pathname_len);

U32BIT STB_DSKGetSize(U16BIT disk_id);

U32BIT STB_DSKGetUsed(U16BIT disk_id);

void STB_DSKFormat(U16BIT disk_id);

U8BIT STB_DSKGetFormatProgress(U16BIT disk_id);

BOOLEAN STB_DSKIsFormatted(U16BIT disk_id);

void STB_DSKRepair(U16BIT disk_id);

U8BIT STB_DSKGetRepairProgress(U16BIT disk_id);

BOOLEAN STB_DSKGetIntegrity(U16BIT disk_id);

#endif //  _STBHWDSK_H