git.sur5r.net Git - cc65/blob - src/sim65/cpudata.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 cpudata.h                                 */
   4 /*                                                                           */
   5 /*                   CPU data passed from the CPU plugins                    */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2012,      Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                D-70794 Filderstadt                                        */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef CPUDATA_H
  37 #define CPUDATA_H
  38
  39
  40
  41 /*****************************************************************************/
  42 /*                                     Data                                  */
  43 /*****************************************************************************/
  44
  45
  46
  47 /* Version defines */
  48 #define CPUDATA_VER_MAJOR       1U
  49 #define CPUDATA_VER_MINOR       0U
  50
  51 /* Forwards */
  52 struct SimData;
  53
  54 /* CPUData structure */
  55 typedef struct CPUData CPUData;
  56 struct CPUData {
  57     const char*     CPUName;            /* Name of the chip */
  58     unsigned        MajorVersion;       /* Version information */
  59     unsigned        MinorVersion;
  60
  61     /* -- Exported functions -- */
  62
  63     void (*Init) (const struct SimData* Data);
  64     /* Initialize the CPU module */
  65
  66     void* (*CreateInstance) (void* CfgInfo);
  67     /* Create an instance of the CPU. Return the instance data pointer */
  68
  69     void (*DestroyInstance) (void* Data);
  70     /* Destroy an instance of the CPU */
  71
  72     void (*Reset) (void* Data);
  73     /* Generate a CPU RESET */
  74
  75     void (*IRQRequest) (void* Data);
  76     /* Generate an IRQ */
  77
  78     void (*NMIRequest) (void* Data);
  79     /* Generate an NMI */
  80
  81     unsigned (*ExecuteInsn) (void* Data);
  82     /* Execute one CPU instruction. Return the number of clock cycles for the
  83      * executed instruction.
  84      */
  85
  86     unsigned long (*GetCycles) (void* Data);
  87     /* Return the total number of clock cycles executed */
  88 };
  89
  90
  91
  92 /* End of cpudata.h */
  93
  94 #endif
  95
  96
  97