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 /* common.h */
  42 #include "coll.h"
  43
  44 /* sim65 */
  45 #include "chipdata.h"
  46 #include "simdata.h"
  47
  48
  49
  50 /*****************************************************************************/
  51 /*                                     Data                                  */
  52 /*****************************************************************************/
  53
  54
  55
  56 /* Forwards */
  57 struct CfgData;
  58 typedef struct ChipInstance ChipInstance;
  59 typedef struct Chip Chip;
  60 typedef struct ChipLibrary ChipLibrary;
  61
  62 /* One instance of a chip */
  63 struct ChipInstance {
  64     Chip*               C;              /* Pointer to corresponding chip */
  65     unsigned            Addr;           /* Start address of range */
  66     unsigned            Size;           /* Size of range */
  67     void*               Data;           /* Chip instance data */
  68 };
  69
  70 /* Chip structure */
  71 struct Chip {
  72     struct ChipLibrary* Library;        /* Pointer to library data structure */
  73     const ChipData*     Data;           /* Chip data as given by the library */
  74     Collection          Instances;      /* Pointer to chip instances */
  75 };
  76
  77 /* ChipLibrary structure */
  78 struct ChipLibrary {
  79     char*                   LibName;    /* Name of the library as given */
  80     char*                   PathName;   /* Name of library including path */
  81     void*                   Handle;     /* Pointer to libary handle */
  82     Collection              Chips;      /* Chips in this library */
  83 };
  84
  85
  86
  87 /*****************************************************************************/
  88 /*                                   Code                                    */
  89 /*****************************************************************************/
  90
  91
  92
  93 ChipInstance* NewChipInstance (const char* ChipName, unsigned Addr,
  94                                unsigned Size, Collection* Attributes);
  95 /* Allocate a new chip instance for the chip. */
  96
  97 ChipInstance* MirrorChipInstance (const ChipInstance* Orig, unsigned Addr);
  98 /* Generate a chip instance mirror and return it. */
  99
 100 void SortChips (void);
 101 /* Sort all chips by name. Called after loading */
 102
 103 void LoadChipLibrary (const char* LibName);
 104 /* Load a chip library. This includes loading the shared libary, allocating
 105  * and initializing the data structure, and loading all chip data from the
 106  * library.
 107  */
 108
 109
 110
 111 /* End of chip.h */
 112
 113 #endif
 114
 115
 116