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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                    chip.h                                 */
   4 /*                                                                           */
   5 /*                        Interface for the chip plugins                     */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2002      Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@musoftware.de                                            */
  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 CHIP_H
  37 #define CHIP_H
  38
  39
  40
  41 /*****************************************************************************/
  42 /*                                     Data                                  */
  43 /*****************************************************************************/
  44
  45
  46
  47 /* Forward */
  48 struct SimData;
  49
  50 /* Chip structure */
  51 typedef struct Chip Chip;
  52 struct Chip {
  53     char*       Name;                   /* Name - must be unique */
  54     char*       LibName;                /* Name of the associated library */
  55     void*       Handle;                 /* Library handle or pointer to it */
  56
  57     /* -- Exported functions -- */
  58     unsigned        (*InitChip) (const struct SimData* Data);
  59     const char*     (*GetName) (void);
  60     unsigned        (*GetVersion) (void);
  61
  62     void            (*WriteCtrl) (unsigned Addr, unsigned char Val);
  63     void            (*Write) (unsigned Addr, unsigned char Val);
  64
  65     unsigned char   (*ReadCtrl) (unsigned Addr);
  66     unsigned char   (*Read) (unsigned Addr);
  67 };
  68
  69
  70
  71 /*****************************************************************************/
  72 /*                                   Code                                    */
  73 /*****************************************************************************/
  74
  75
  76
  77 void LoadChip (const char* LibName);
  78 /* Load a chip. This includes loading the shared libary, allocating and
  79  * initializing the data structure.
  80  */
  81
  82 void InitChips (void);
  83 /* Initialize the chips. Must be called *after* all chips are loaded */
  84
  85 const Chip* GetChip (const char* Name);
  86 /* Find a chip by name. Returns the Chip data structure or NULL if the chip
  87  * could not be found.
  88  */
  89
  90
  91
  92 /* End of chip.h */
  93
  94 #endif
  95
  96
  97