New API for access to extended memory

[cc65] / include / em / em-kernel.h

diff --git a/include/em/em-kernel.h b/include/em/em-kernel.h
new file mode 100644 (file)
index 0000000..63939e0
--- /dev/null
+++ b/include/em/em-kernel.h
@@ -0,0 +1,93 @@
+/*****************************************************************************/
+/*                                                                           */
+/*                                em-kernel.h                                */
+/*                                                                           */
+/*                       Internally used EM functions                        */
+/*                                                                           */
+/*                                                                           */
+/*                                                                           */
+/* (C) 2002      Ullrich von Bassewitz                                       */
+/*               Wacholderweg 14                                             */
+/*               D-70597 Stuttgart                                           */
+/* EMail:        uz@musoftware.de                                            */
+/*                                                                           */
+/*                                                                           */
+/* This software is provided 'as-is', without any expressed or implied       */
+/* warranty.  In no event will the authors be held liable for any damages    */
+/* arising from the use of this software.                                    */
+/*                                                                           */
+/* Permission is granted to anyone to use this software for any purpose,     */
+/* including commercial applications, and to alter it and redistribute it    */
+/* freely, subject to the following restrictions:                            */
+/*                                                                           */
+/* 1. The origin of this software must not be misrepresented; you must not   */
+/*    claim that you wrote the original software. If you use this software   */
+/*    in a product, an acknowledgment in the product documentation would be  */
+/*    appreciated but is not required.                                       */
+/* 2. Altered source versions must be plainly marked as such, and must not   */
+/*    be misrepresented as being the original software.                      */
+/* 3. This notice may not be removed or altered from any source              */
+/*    distribution.                                                          */
+/*                                                                           */
+/*****************************************************************************/
+
+
+
+#ifndef _EM_KERNEL_H
+#define _EM_KERNEL_H
+
+
+
+/*****************************************************************************/
+/*                                   Data                                    */
+/*****************************************************************************/
+
+
+
+/* A structure that describes the header of an extended memory driver loaded
+ * into memory.
+ */
+typedef struct {
+
+    /* Driver header */
+    char                id[3];          /* Contains 0x65, 0x6d, 0x64 ("emd") */
+    unsigned char       version;        /* Interface version */
+
+    /* Jump vectors. Note that these are not C callable */
+    void*               install;        /* INSTALL routine */
+    void*               deinstall;      /* DEINSTALL routine */
+    void*               pagecount;      /* PAGECOUNT routine */
+    void*               map;            /* MAP routine */
+    void*               mapclean;       /* MAPCLEAN routine */
+    void*              copyfrom;       /* COPYFROM routine */
+    void*               copyto;         /* COPYTO routine */
+
+} em_drv_header;
+
+
+
+/* EM kernel variables */
+extern em_drv_header*          em_drv;         /* Pointer to driver */
+
+
+
+
+/*****************************************************************************/
+/*                                Functions                                 */
+/*****************************************************************************/
+
+
+
+unsigned char __fastcall__ em_install (void* driver);
+/* Install the driver once it is loaded, return an error code. */
+
+void __fastcall__ em_deinstall (void);
+/* Deinstall the driver before unloading it */
+
+
+
+/* End of em-kernel.h */
+#endif
+
+
+