/*****************************************************************************/
/*                                                                           */
/*                                  chipdata.h                               */
/*                                                                           */
/*                        Chip description data structure                    */
/*                                                                           */
/*                                                                           */
/*                                                                           */
/* (C) 2002-2003 Ullrich von Bassewitz                                       */
/*               Römerstrasse 52                                             */
/*               D-70794 Filderstadt                                         */
/* EMail:        uz@cc65.org                                                 */
/*                                                                           */
/*                                                                           */
/* 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 CHIPDATA_H
#define CHIPDATA_H



/*****************************************************************************/
/*                                     Data                                  */
/*****************************************************************************/



/* Chip type and version information. */
#define CHIPDATA_TYPE_CHIP      0U
#define CHIPDATA_TYPE_CPU       1U
#define CHIPDATA_VER_MAJOR      1U
#define CHIPDATA_VER_MINOR      0U

/* Forwards */
struct CfgData;
struct SimData;

/* ChipDesc structure */
typedef struct ChipData ChipData;
struct ChipData {
    const char* ChipName;       /* Name of the chip */
    unsigned    Type;           /* Type of the chip */
    unsigned    MajorVersion;   /* Version information */
    unsigned    MinorVersion;

    /* -- Exported functions -- */
    int           (*InitChip) (const struct SimData* Data);
    void*         (*CreateInstance) (unsigned Addr, unsigned Range, void* CfgInfo);
    void	  (*DestroyInstance) (void* Data);
    void          (*WriteCtrl) (void* Data, unsigned Offs, unsigned char Val);
    void          (*Write) (void* Data, unsigned Offs, unsigned char Val);
    unsigned char (*ReadCtrl) (void* Data, unsigned Offs);
    unsigned char (*Read) (void* Data, unsigned Offs);
};



/* End of chipdata.h */

#endif



