/**

 * $Id: sh4core.h,v 1.22 2007-09-11 02:14:46 nkeynes Exp $

 * 

 * This file defines the internal functions exported/used by the SH4 core, 

 * except for disassembly functions defined in sh4dasm.h

 *

 * Copyright (c) 2005 Nathan Keynes.

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 */

#ifndef sh4core_H

#define sh4core_H 1

#include <glib/gtypes.h>

#include <stdint.h>

#include <stdio.h>

#ifdef __cplusplus

extern "C" {

#if 0

}

#endif

#endif

/**

 * SH4 is running normally 

 */

#define SH4_STATE_RUNNING 1

/**

 * SH4 is not executing instructions but all peripheral modules are still

 * running

 */

#define SH4_STATE_SLEEP 2

/**

 * SH4 is not executing instructions, DMAC is halted, but all other peripheral

 * modules are still running

 */

#define SH4_STATE_DEEP_SLEEP 3

/**

 * SH4 is not executing instructions and all peripheral modules are also

 * stopped. As close as you can get to powered-off without actually being

 * off.

 */

#define SH4_STATE_STANDBY 4

#define PENDING_IRQ 1

#define PENDING_EVENT 2

struct sh4_registers {

    uint32_t r[16];

    uint32_t sr, pr, pc, fpscr;

    uint32_t t, m, q, s; /* really boolean - 0 or 1 */

    int32_t fpul;

    float *fr_bank;

    float fr[2][16];

    uint64_t mac;

    uint32_t gbr, ssr, spc, sgr, dbr, vbr;

    uint32_t r_bank[8]; /* hidden banked registers */

    int32_t store_queue[16]; /* technically 2 banks of 32 bytes */

    uint32_t new_pc; /* Not a real register, but used to handle delay slots */

    uint32_t event_pending; /* slice cycle time of the next pending event, or FFFFFFFF

                             when no events are pending */

    uint32_t event_types; /* bit 0 = IRQ pending, bit 1 = general event pending */

    int in_delay_slot; /* flag to indicate the current instruction is in

                             * a delay slot (certain rules apply) */

    uint32_t slice_cycle; /* Current nanosecond within the timeslice */

    int sh4_state; /* Current power-on state (one of the SH4_STATE_* values ) */

};

extern struct sh4_registers sh4r;

/* Public functions */

void sh4_init( void );

void sh4_reset( void );

void sh4_run( void );

void sh4_runto( uint32_t pc, uint32_t count );

void sh4_runfor( uint32_t count );

int sh4_isrunning( void );

void sh4_stop( void );

void sh4_set_pc( int );

gboolean sh4_execute_instruction( void );

gboolean sh4_raise_exception( int );

gboolean sh4_raise_slot_exception( int, int );

gboolean sh4_raise_tlb_exception( int );

void sh4_set_breakpoint( uint32_t pc, int type );

gboolean sh4_clear_breakpoint( uint32_t pc, int type );

int sh4_get_breakpoint( uint32_t pc );

#define BREAK_ONESHOT 1

#define BREAK_PERM 2

/* SH4 Memory */

int32_t sh4_read_long( uint32_t addr );

int32_t sh4_read_word( uint32_t addr );

int32_t sh4_read_byte( uint32_t addr );

void sh4_write_long( uint32_t addr, uint32_t val );

void sh4_write_word( uint32_t addr, uint32_t val );

void sh4_write_byte( uint32_t addr, uint32_t val );

int32_t sh4_read_phys_word( uint32_t addr );

void sh4_flush_store_queue( uint32_t addr );

/* SH4 Support methods */

uint32_t sh4_read_sr(void);

void sh4_write_sr(uint32_t val);

/* Peripheral functions */

void CPG_reset( void );

void TMU_run_slice( uint32_t );

void TMU_update_clocks( void );

void TMU_reset( void );

void TMU_save_state( FILE * );

int TMU_load_state( FILE * );

void DMAC_reset( void );

void DMAC_run_slice( uint32_t );

void DMAC_save_state( FILE * );

int DMAC_load_state( FILE * );

void SCIF_reset( void );

void SCIF_run_slice( uint32_t );

void SCIF_save_state( FILE *f );

int SCIF_load_state( FILE *f );

void INTC_reset( void );

void INTC_save_state( FILE *f );

int INTC_load_state( FILE *f );

void MMU_init( void );

void MMU_reset( void );

void MMU_save_state( FILE *f );

int MMU_load_state( FILE *f );

#define SIGNEXT4(n) ((((int32_t)(n))<<28)>>28)

#define SIGNEXT8(n) ((int32_t)((int8_t)(n)))

#define SIGNEXT12(n) ((((int32_t)(n))<<20)>>20)

#define SIGNEXT16(n) ((int32_t)((int16_t)(n)))

#define SIGNEXT32(n) ((int64_t)((int32_t)(n)))

#define SIGNEXT48(n) ((((int64_t)(n))<<16)>>16)

/* Status Register (SR) bits */

#define SR_MD    0x40000000 /* Processor mode ( User=0, Privileged=1 ) */ 

#define SR_RB    0x20000000 /* Register bank (priviledged mode only) */

#define SR_BL    0x10000000 /* Exception/interupt block (1 = masked) */

#define SR_FD    0x00008000 /* FPU disable */

#define SR_M     0x00000200

#define SR_Q     0x00000100

#define SR_IMASK 0x000000F0 /* Interrupt mask level */

#define SR_S     0x00000002 /* Saturation operation for MAC instructions */

#define SR_T     0x00000001 /* True/false or carry/borrow */

#define SR_MASK  0x700083F3

#define SR_MQSTMASK 0xFFFFFCFC /* Mask to clear the flags we're keeping separately */

#define IS_SH4_PRIVMODE() (sh4r.sr&SR_MD)

#define SH4_INTMASK() ((sh4r.sr&SR_IMASK)>>4)

#define SH4_EVENT_PENDING() (sh4r.event_pending <= sh4r.slice_cycle && !sh4r.in_delay_slot)

#define FPSCR_FR     0x00200000 /* FPU register bank */

#define FPSCR_SZ     0x00100000 /* FPU transfer size (0=32 bits, 1=64 bits) */

#define FPSCR_PR     0x00080000 /* Precision (0=32 bites, 1=64 bits) */

#define FPSCR_DN     0x00040000 /* Denormalization mode (1 = treat as 0) */

#define FPSCR_CAUSE  0x0003F000

#define FPSCR_ENABLE 0x00000F80

#define FPSCR_FLAG   0x0000007C

#define FPSCR_RM     0x00000003 /* Rounding mode (0=nearest, 1=to zero) */

#define IS_FPU_DOUBLEPREC() (sh4r.fpscr&FPSCR_PR)

#define IS_FPU_DOUBLESIZE() (sh4r.fpscr&FPSCR_SZ)

#define IS_FPU_ENABLED() ((sh4r.sr&SR_FD)==0)

#define FR(x) sh4r.fr_bank[(x)^1]

#define DRF(x) ((double *)sh4r.fr_bank)[x]

#define XF(x) sh4r.fr[((~sh4r.fpscr)&FPSCR_FR)>>21][(x)^1]

#define XDR(x) ((double *)(sh4r.fr[((~sh4r.fpscr)&FPSCR_FR)>>21]))[x]

#define DRb(x,b) ((double *)(sh4r.fr[((b ? (~sh4r.fpscr) : sh4r.fpscr)&FPSCR_FR)>>21]))[x]

#define DR(x) DRb((x>>1), (x&1))

#define FPULf   *((float *)&sh4r.fpul)

#define FPULi    (sh4r.fpul)

/* CPU-generated exception code/vector pairs */

#define EXC_POWER_RESET    0x000 /* vector special */

#define EXC_MANUAL_RESET   0x020

#define EXC_DATA_ADDR_READ 0x0E0

#define EXC_DATA_ADDR_WRITE 0x100

#define EXC_SLOT_ILLEGAL   0x1A0

#define EXC_ILLEGAL        0x180

#define EXC_TRAP           0x160

#define EXC_FPU_DISABLED   0x800

#define EXC_SLOT_FPU_DISABLED 0x820

/* Exceptions (for use with sh4_raise_exception) */

#define EX_ILLEGAL_INSTRUCTION 0x180, 0x100

#define EX_SLOT_ILLEGAL        0x1A0, 0x100

#define EX_TLB_MISS_READ       0x040, 0x400

#define EX_TLB_MISS_WRITE      0x060, 0x400

#define EX_INIT_PAGE_WRITE     0x080, 0x100

#define EX_TLB_PROT_READ       0x0A0, 0x100

#define EX_TLB_PROT_WRITE      0x0C0, 0x100

#define EX_DATA_ADDR_READ      0x0E0, 0x100

#define EX_DATA_ADDR_WRITE     0x100, 0x100

#define EX_FPU_EXCEPTION       0x120, 0x100

#define EX_TRAPA               0x160, 0x100

#define EX_BREAKPOINT          0x1E0, 0x100

#define EX_FPU_DISABLED        0x800, 0x100

#define EX_SLOT_FPU_DISABLED   0x820, 0x100

#define SH4_WRITE_STORE_QUEUE(addr,val) sh4r.store_queue[(addr>>2)&0xF] = val;

#ifdef __cplusplus

}

#endif

#endif