Fixing API documentation, added Disk cache spec

[tpg/acess2.git] / Kernel / include / acess.h

diff --git a/Kernel/include/acess.h b/Kernel/include/acess.h
index 7bf2e48..963cb9c 100644 (file)
--- a/Kernel/include/acess.h
+++ b/Kernel/include/acess.h
@@ -6,9 +6,19 @@
 #define _COMMON_H
 
 #define NULL   ((void*)0)
+#define PACKED __attribute__ ((packed))
 
+#include <stdint.h>
 #include <arch.h>
 #include <stdarg.h>
+#include "errno.h"
+
+// --- Types ---
+typedef  int   tPID;
+typedef  int   tTID;
+typedef Uint   tUID;
+typedef Uint   tGID;
+typedef Sint64 tTimestamp;
 
 // --- Helper Macros ---
 /**
@@ -19,6 +29,8 @@
 #define EXPAND_CONCAT(x,y) CONCAT(x,y)
 #define STR(x) #x
 #define EXPAND_STR(x) STR(x)
+
+#define VER2(major,minor)      ((((major)&0xFF)<<8)|((minor)&0xFF))
 /**
  * \}
  */
@@ -73,7 +85,7 @@ typedef void (*tThreadFunction)(void*);
  */
 typedef struct sKernelSymbol {
        char    *Name;
-       unsigned int    Value;
+       Uint    Value;
 } tKernelSymbol;
 #define        EXPORT(_name)   tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)_name}
 #define        EXPORTV(_name)  tKernelSymbol _kexp_##_name __attribute__((section ("KEXPORT"),unused))={#_name, (Uint)&_name}
@@ -89,6 +101,15 @@ extern void System_Init(char *ArgString);
 // --- IRQs ---
 extern int     IRQ_AddHandler(int Num, void (*Callback)(int));
 
+// --- Logging ---
+extern void    Log_KernelPanic(char *Ident, char *Message, ...);
+extern void    Log_Panic(char *Ident, char *Message, ...);
+extern void    Log_Error(char *Ident, char *Message, ...);
+extern void    Log_Warning(char *Ident, char *Message, ...);
+extern void    Log_Notice(char *Ident, char *Message, ...);
+extern void    Log_Log(char *Ident, char *Message, ...);
+extern void    Log_Debug(char *Ident, char *Message, ...);
+
 // --- Debug ---
 /**
  * \name Debugging and Errors
@@ -103,6 +124,7 @@ extern void Debug_Enter(char *FuncName, char *ArgTypes, ...);
 extern void    Debug_Log(char *FuncName, char *Fmt, ...);
 extern void    Debug_Leave(char *FuncName, char RetType, ...);
 extern void    Debug_HexDump(char *Header, void *Data, Uint Length);
+#define UNIMPLEMENTED()        Warning("'%s' unimplemented", __func__)
 #if DEBUG
 # define ENTER(_types...)      Debug_Enter((char*)__func__, _types)
 # define LOG(_fmt...)  Debug_Log((char*)__func__, _fmt)
@@ -167,11 +189,11 @@ extern void       MM_Deallocate(tVAddr VAddr);
  */
 extern int     MM_Map(tVAddr VAddr, tPAddr PAddr);
 /**
- * \brief Get the physical address of \a VAddr
- * \param VAddr        Address of the page to get the physical address of
- * \return Physical page mapped at \a VAddr
+ * \brief Get the physical address of \a Addr
+ * \param Addr Address of the page to get the physical address of
+ * \return Physical page mapped at \a Addr
  */
-extern tPAddr  MM_GetPhysAddr(tVAddr VAddr);
+extern tPAddr  MM_GetPhysAddr(tVAddr Addr);
 /**
  * \brief Checks is a memory range is user accessable
  * \param VAddr        Base address to check
@@ -202,7 +224,7 @@ extern void MM_FreeTemp(tVAddr VAddr);
  * \param PAddr        Physical address to map in
  * \param Number       Number of pages to map
  */
-extern tVAddr  MM_MapHWPage(tPAddr PAddr, Uint Number);
+extern tVAddr  MM_MapHWPages(tPAddr PAddr, Uint Number);
 /**
  * \brief Allocates DMA physical memory
  * \param Pages        Number of pages required
@@ -216,7 +238,7 @@ extern tVAddr       MM_AllocDMA(int Pages, int MaxBits, tPAddr *PhysAddr);
  * \param VAddr        Virtual address allocate by ::MM_MapHWPage or ::MM_AllocDMA
  * \param Number       Number of pages to free
  */
-extern void    MM_UnmapHWPage(tVAddr VAddr, Uint Number);
+extern void    MM_UnmapHWPages(tVAddr VAddr, Uint Number);
 /**
  * \brief Allocate a single physical page
  * \return Physical address allocated
@@ -247,11 +269,11 @@ extern void       MM_DerefPhys(tPAddr PAddr);
  * \name Memory Manipulation
  * \{
  */
-extern int     memcmp(const void *m1, const void *m2, Uint count);
-extern void *memcpy(void *dest, const void *src, Uint count);
-extern void *memcpyd(void *dest, const void *src, Uint count);
-extern void *memset(void *dest, int val, Uint count);
-extern void *memsetd(void *dest, Uint val, Uint count);
+extern int     memcmp(const void *m1, const void *m2, size_t count);
+extern void *memcpy(void *dest, const void *src, size_t count);
+extern void *memcpyd(void *dest, const void *src, size_t count);
+extern void *memset(void *dest, int val, size_t count);
+extern void *memsetd(void *dest, Uint32 val, size_t count);
 /**
  * \}
  */
@@ -283,8 +305,11 @@ extern Uint32      BigEndian32(Uint32 Val);
  * \name Strings
  * \{
  */
+extern int     vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
+extern int     sprintf(char *__s, const char *__format, ...);
 extern Uint    strlen(const char *Str);
 extern char    *strcpy(char *__dest, const char *__src);
+extern char    *strncpy(char *__dest, const char *__src, size_t max);
 extern int     strcmp(const char *__str1, const char *__str2);
 extern int     strncmp(const char *Str1, const char *Str2, size_t num);
 extern int     strucmp(const char *Str1, const char *Str2);
@@ -292,15 +317,18 @@ extern char       *strdup(const char *Str);
 extern int     strpos(const char *Str, char Ch);
 extern int     strpos8(const char *str, Uint32 search);
 extern void    itoa(char *buf, Uint num, int base, int minLength, char pad);
+extern int     atoi(const char *string);
 extern int     ReadUTF8(Uint8 *str, Uint32 *Val);
 extern int     WriteUTF8(Uint8 *str, Uint32 Val);
-extern int     LookupString(char **Array, char *Needle);
+extern int     ModUtil_SetIdent(char *Dest, char *Value);
+extern int     ModUtil_LookupString(char **Array, char *Needle);
 extern Uint8   ByteSum(void *Ptr, int Size);
 /**
  * \}
  */
 
 extern Uint    rand();
+extern int     CallWithArgArray(void *Function, int NArgs, Uint *Args);
 
 // --- Heap ---
 /**
@@ -354,10 +382,14 @@ extern int        Proc_Spawn(char *Path);
 extern void    Threads_Exit();
 extern void    Threads_Yield();
 extern void    Threads_Sleep();
-extern int     Threads_GetUID();
-extern int     Threads_GetGID();
+extern void    Threads_WakeTID(tTID Thread);
+extern tPID    Threads_GetPID();
+extern tTID    Threads_GetTID();
+extern tUID    Threads_GetUID();
+extern tGID    Threads_GetGID();
 extern int     SpawnTask(tThreadFunction Function, void *Arg);
 extern Uint    *Threads_GetCfgPtr(int Id);
+extern int     Threads_SetName(char *NewName);
 /**
  * \}
  */