kos.h

Go to the documentation of this file.

//& *** (c) 2006-2011 The HPGCC3 Team ***
//& Claudio Lapilli
//& Ingo Blank
//&
//& This file is licensed under the terms and conditions of the
//& HPGCC3 license that is included with the source distribution.
//& *** (c) 2006-2011 The HPGCC3 Team ***

// $Id: kos.h 517 2007-11-19 04:09:04Z claudio $

#ifndef _KOS_H
#define _KOS_H



typedef unsigned int U32;
typedef int S32;
typedef unsigned short U16;
typedef short S16;
typedef unsigned char U8,*P_U8;
typedef char S8;
typedef char BYTE;
typedef char *P_BYTE;
typedef int BOOL;
typedef void *P_VOID;

#ifndef size_t
#define size_t unsigned int
#endif /* size_t */

#ifndef SIZE_T
#define SIZE_T size_t
#endif


//Al 19th Nov '04
#ifndef NULL
#define NULL 0
#endif

// < ibl ; 2004-10-28 >
#define TIME_T unsigned int 

typedef U32 (*FUNC_PTR)();
typedef U32 (*FUNC0PTR)();
typedef U32 (*FUNC1PTR)(U32);
typedef U32 (*FUNC2PTR)(U32,U32);
typedef U32 (*FUNC3PTR)(U32,U32,U32);



#ifndef FALSE
#define FALSE 0
#define TRUE (! FALSE)
#endif




typedef struct
{
    U16 year;    
    U8 month;    
    U8 day;        
}
KDATE;

typedef struct
{
    U8 hours;        
    U8 minutes;        
    U8 seconds;        
    U8 unknown1;    
    U32 unknown2;    
} KTIME;

// The KOS Date&Time Structure (nesting)
typedef struct
{
    KDATE date;        
    KTIME time;        
}
KDATETIME, *P_KDATETIME;




// memory alloc type define
#define KOS_MEM_FREE                        0x0000
// memory not allocated
#define KOS_MEM_GLOBAL                      0x1000
// global memory type
#define KOS_MEM_LOCAL                       0x2000
// local (task) memory type
#define KOS_MEM_HEAP0                       0x0100
// heap number

#define KOS_MODULE_FILESYSTEM 1

#define KOS_FUNC_FOPEN    0
#define KOS_FUNC_FREAD    1
#define KOS_FUNC_FWRITE    2
#define KOS_FUNC_FCLOSE    3
#define KOS_FUNC_FSEEK    4
#define KOS_FUNC_FDELETE 5
// < Benjamin ; 2005-06-12 >
#define KOS_FUNC_FRENAME        6
#define KOS_FUNC_CHDIR            7
#define KOS_FUNC_GETFILEINFO    8
#define KOS_FUNC_GETFIRSTDIR    9
#define KOS_FUNC_GETNEXTDIR        10
#define KOS_FUNC_GETPREVDIR        11
#define KOS_FUNC_GETFIRSTFILE    12
#define KOS_FUNC_GETNEXTFILE    13
#define KOS_FUNC_GETPREVFILE    14
#define KOS_FUNC_FATTR            15
#define KOS_FUNC_GETSIZE        16
#define KOS_FUNC_CHECKINSERT    17
#define KOS_FUNC_CHECKPROTECT    18



#define KOS_READMODE 1        
#define KOS_WRITEMODE 2

// Filesystem (fs.h)

// we don't have that...
// #include "kgeneraldef.h"

#define FAT32_SUPPORT  1


#define NEW_FILE_NAME

// < Benjamin ; 2005-06-12 >
typedef struct 
//__file_dir_info
{
       KDATETIME       last_modifier;
       KDATETIME       create_date;
       KDATE           last_access_date;
#ifdef  NEW_FILE_NAME
       BYTE            file_name[13];    
#else
       BYTE            extension[4];
       BYTE            name[9];
#endif

       U8               attribute;    
       U16             ext_attr;    
       U32             size;        
}
FILE_INFO, DIR_INFO, *P_FILE_INFO, *P_DIR_INFO;



typedef S32     H_FILE;

// < Benjamin ; 2005-06-12 >
// Attributes for FILE_INFO/DIR_INFO
#define KOS_READONLY_ATTRIBUTE (1)

#define KOS_HIDDEN_ATTRIBUTE (1<<1)

#define KOS_SYSTEM_ATTRIBUTE (1<<2)

#define KOS_ARCHIVE_ATTRIBUTE (1<<5)

#define FILE_READONLY   0x00000001      //mode parameter in kos_fopen
#define FILE_READWRITE  0x00000002
#define FILE_APPEND     0x00000003

#define FS_SEEK_SET             0
#define FS_SEEK_CUR             1
#define FS_SEEK_END             2

#define ERR_FS_INVALID_NAME                     -1
#define ERR_FS_FILE_OPENED                      -2
#define ERR_FS_INVALID_HANDLE                   -3
#define ERR_FS_INVALID_INDEX                    -4
#define ERR_FS_INVALID_MODE                     -5
#define ERR_FS_DISK_FULL                        -6
#define ERR_FS_DISK_ERROR                       -7
#define ERR_FS_DISK_CHANGE                      -8
#define ERR_FS_NO_SDCARD                        -9
#define ERR_FS_NO_MEMORY                       -10
#define ERR_FS_NOT_SUPPORT                     -11
#define ERR_FS_PROTECT                         -13
#define ERR_FS_NOTFIND                         -14
#define ERR_FS_DISK_REMOVE                     -15
#define ERR_FS_FILE_NOTEXIST                   -16
#define ERR_FS_UNKNOWN                        -100



// Errors

#define SUCCESS 0
#define EOF -1
#define KOS_ERR_INVALIDPTR    -200 // FIXME: random guess

// Kernel

FUNC_PTR kos_GetFuncEntry(U32 module, U32 index);

// Filesystem

H_FILE kos_fopen(P_BYTE fname, U8 mode);
SIZE_T kos_fread(H_FILE fd, P_BYTE buf, U32 length);
SIZE_T kos_fwrite(H_FILE fd, P_BYTE buf, U32 length);
S32 kos_fseek(H_FILE fd, S32 offset, U32 mode);
S32 kos_fclose(H_FILE fd);
S32 kos_fdelete(P_BYTE fname);


// CHANGED TO A MACRO
#define fdelete(a) kos_fdelete(a);







// < Benjamin ; 2005-06-12 >

S32 kos_frename(P_BYTE oldname, P_BYTE newname);


S32 kos_chdir(P_BYTE pDir);

S32 kos_GetSpecialFileInfo(P_BYTE fname, P_FILE_INFO pInfo);


S32 kos_GetFirstDirInfo(P_DIR_INFO pInfo);


S32 kos_GetNextDirInfo(P_DIR_INFO pInfo, U32 index);


S32 kos_GetPrevDirInfo(P_DIR_INFO pInfo, U32 index);


S32 kos_GetFirstFileInfo(P_FILE_INFO pInfo);


S32 kos_GetNextFileInfo(P_FILE_INFO pInfo, U32 index);


S32 kos_GetPrevFileInfo(P_FILE_INFO pInfo, U32 index);


S32 kos_fattr(P_BYTE fname, U8 attr);



S32 kos_GetDiskFreeSize(void);


S32 kos_CheckDiskInsert(void);


S32 kos_CheckDiskProtect(void);


void kos_ResetSD(void);






//Edit by Al 19th October
//Include more of HP's KOS functions

//TODO: Add the rest (except maybe the dangerous ones)

//memory management

void *kos_malloc(SIZE_T size); //malloc. ~100kb free on 49g+, <30k free on 39g+
S32 kos_free(void *pMemory); //free
 

//display routines

void kos_ClearLcd(void); //clears the LCD
U32 kos_PutString(U32 dx, U32 dy, P_VOID ptr); //writes a string, in large 5 x 8 font
void kos_PutHexNumber(U32 dx, U32 dy, U32 value); //write a number in hex
void kos_PutDecNumber(U32 dx, U32 dy, U32 value, U32 bit); //writes a number in base-10

U32 kos_LCDGetContrast(void); //gets and sets LCD contrast
void kos_LCDSetContrast(U32 contrast);

//misc routines

P_BYTE kos_getSerialNumber(void); //seems to return garbage, and a Kinpo copyright. 
void kos_Reset(void); // reset OS + emulator?
S32 kos_beep(U32 freq, TIME_T time, U32 override);

// Time

U32 kos_GetSysTickTime();



#endif