/*
 * Apple // emulator for *ix
 *
 * This software package is subject to the GNU General Public License
 * version 3 or later (your choice) as published by the Free Software
 * Foundation.
 *
 * Copyright 2013-2015 Aaron Culliney
 *
 */

#ifndef _CPU_REGS_H_
#define _CPU_REGS_H_

#include "cpu.h"

// ARM register mappings

// r0, r1 are scratch regs, with r0 generally as the "important byte"
#define EffectiveAddr   r2              /* 16bit Effective address    */
#define PC_Reg          r3              /* 16bit 6502 Program Counter */
#define SP_Reg          r4              /* 16bit 6502 Stack pointer   */
#define F_Reg           r5              /* 8bit 6502 flags            */
#define Y_Reg           r6              /* 8bit 6502 Y register       */
#define X_Reg           r7              /* 8bit 6502 X register       */
#define A_Reg           r8              /* 8bit 6502 A register       */
// r9 is "ARM platform register" ... used as a scratch register
// r10 is another scratch variable
#define reg_vmem_r      r11             /* cpu65_vmem_r table address */
// r12 is "ARM Intra-Procedure-call scratch register" ... used as a scratch register
// r13 ARM SP
// r14 ARM return addr
// r15 ARM PC

#ifdef __aarch64__
#   error 20150205 ARM 64bit untested!!!
#   define PTR_SHIFT        #4 // 4<<1 = 8
#   define ROR_BIT          0x8000000000000000
#else
#   define PTR_SHIFT        #2 // 2<<1 = 4
#   define ROR_BIT          0x80000000
#endif


#if !defined(__APPLE__)
#   define NO_UNDERSCORES 1
#   define STRBNE strneb
#else
#   define STRBNE strbne
#endif

#if NO_UNDERSCORES
#   define ENTRY(x)         .globl x; .arm; .balign 4; x##:
#   define CALL(x)          x
#else
#   define ENTRY(x)         .globl _##x; .arm; .balign 4; _##x##:
#   define CALL(x)          _##x
#endif

// 2015/11/08 NOTE : Android requires all apps targeting API 23 (AKA Marshmallow) to use Position Independent Code (PIC)
// that does not have TEXT segment relocations

#if !defined(__COUNTER__)
#error __COUNTER__ macro should be available in modern compilers
#endif

#if __PIC__ && !__APPLE__
// 2016/07/15 : TODO FIXME : this PIC code does not work on ARM-Darwin

#   define _SYM_ADDR_PRE(reg) \
                ldr     reg, 5f;
#   define _SYM_ADDR_OFF_THUMB(reg,ct) \
4:              add     reg, pc; \
                ldr     reg, [reg];
#   define _SYM_ADDR_OFF_ARM(reg,ct) \
4:              ldr     reg, [pc, reg];
#   define _SYM_ADDR_POST(var,poff) \
                b       6f; \
                .align  2; \
5:              .word   var(GOT_PREL)+(. - (4b + poff)); \
6:
#   if defined(THUMB)
#       define SYM(reg,var) \
                _SYM_ADDR_PRE(reg) \
                _SYM_ADDR_OFF_THUMB(reg, __COUNTER__); \
                _SYM_ADDR_POST(var,4)
#   else
#       define SYM(reg,var) \
                _SYM_ADDR_PRE(reg) \
                _SYM_ADDR_OFF_ARM(reg, __COUNTER__); \
                _SYM_ADDR_POST(var,8)
#   endif
#else
#   if NO_UNDERSCORES
#       define SYM(reg,var) \
                ldr     reg, =var
#   else
#       define SYM(reg,var) \
                ldr     reg, =_##var
#   endif
#endif


#endif // whole file