git.sur5r.net Git - cc65/blob - include/6502.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  6502.h                                   */
   4 /*                                                                           */
   5 /*                        6502 specific declarations                         */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-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 _6502_H
  37 #define _6502_H
  38
  39
  40
  41 /* We need size_t */
  42 #ifndef _HAVE_size_t
  43 #define _HAVE_size_t
  44 typedef unsigned size_t;
  45 #endif
  46
  47
  48
  49 /* Possible returns of getcpu() */
  50 #define CPU_6502        0
  51 #define CPU_65C02       1
  52 #define CPU_65816       2
  53 #define CPU_4510        3
  54 #define CPU_65SC02      4
  55 #define CPU_65CE02      5
  56
  57 unsigned char getcpu (void);
  58 /* Detect the CPU the program is running on */
  59
  60
  61
  62 /* Macros for CPU instructions */
  63 #define BRK()   __asm__ ("brk")
  64 #define CLI()   __asm__ ("cli")
  65 #define SEI()   __asm__ ("sei")
  66
  67
  68
  69 /* Struct that holds the registers for the sys function */
  70 struct regs {
  71     unsigned char a;            /* A register value */
  72     unsigned char x;            /* X register value */
  73     unsigned char y;            /* Y register value */
  74     unsigned char flags;        /* Flags value */
  75     unsigned      pc;           /* Program counter */
  76 };
  77
  78 /* Defines for the flags in the regs structure */
  79 #define F6502_N         0x80    /* N flag */
  80 #define F6502_V         0x40    /* V flag */
  81 #define F6502_B         0x10    /* B flag */
  82 #define F6502_D         0x08    /* D flag */
  83 #define F6502_I         0x04    /* I flag */
  84 #define F6502_Z         0x02    /* Z flag */
  85 #define F6502_C         0x01    /* C flag */
  86
  87 /* Function to call any machine language subroutine. All registers in the
  88 ** regs structure are passed into the routine and the results are passed
  89 ** out. The B flag is ignored on input. The called routine must end with
  90 ** an RTS.
  91 */
  92 void __fastcall__ _sys (struct regs* r);
  93
  94
  95
  96 /* Set and reset the break vector. The given user function is called if
  97 ** a break occurs. The values of the registers may be read from the brk_...
  98 ** variables. The value in brk_pc will point to the address that contains
  99 ** the brk instruction.
 100 ** The set_brk function will install an exit handler that will reset the
 101 ** vector if the program ends.
 102 */
 103
 104 extern unsigned char brk_a;     /* A register value */
 105 extern unsigned char brk_x;     /* X register value */
 106 extern unsigned char brk_y;     /* Y register value */
 107 extern unsigned char brk_sr;    /* Status register */
 108 extern unsigned brk_pc;         /* PC value */
 109
 110 typedef void (*brk_handler) (void);
 111 /* Type of the break handler */
 112
 113 void __fastcall__ set_brk (brk_handler f);
 114 /* Set the break vector to the given address */
 115
 116 void reset_brk (void);
 117 /* Reset the break vector to the original value */
 118
 119
 120
 121 /* Possible returns for irq_handler() */
 122 #define IRQ_NOT_HANDLED 0
 123 #define IRQ_HANDLED     1
 124
 125 typedef unsigned char (*irq_handler) (void);
 126 /* Type of the C level interrupt request handler */
 127
 128 void __fastcall__ set_irq (irq_handler f, void *stack_addr, size_t stack_size);
 129 /* Set the C level interrupt request vector to the given address */
 130
 131 void reset_irq (void);
 132 /* Reset the C level interrupt request vector */
 133
 134
 135
 136 /* End of 6502.h */
 137 #endif