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