some support for vdp debug reg
[picodrive.git] / pico / pico.h
index ba7349e..527498e 100644 (file)
@@ -1,35 +1,50 @@
-\r
-// -------------------- Pico Library --------------------\r
-\r
-// Pico Library - Header File\r
-\r
-// (c) Copyright 2004 Dave, All rights reserved.\r
-// (c) Copyright 2006-2008 notaz, All rights reserved.\r
-// Free for non-commercial use.\r
-\r
-// For commercial use, separate licencing terms must be obtained.\r
+/*\r
+ * PicoDrive\r
+ * (c) Copyright Dave, 2004\r
+ * (C) notaz, 2006-2010\r
+ *\r
+ * This work is licensed under the terms of MAME license.\r
+ * See COPYING file in the top-level directory.\r
+ */\r
 \r
 #ifndef PICO_H\r
 #define PICO_H\r
 \r
-#include <stdio.h>\r
-\r
-// port-specific compile-time settings\r
-#include <port_config.h>\r
+#include <stdlib.h> // size_t\r
 \r
 #ifdef __cplusplus\r
 extern "C" {\r
 #endif\r
 \r
+// message log\r
+extern void lprintf(const char *fmt, ...);\r
+\r
 // external funcs for Sega/Mega CD\r
-extern int  mp3_get_bitrate(FILE *f, int size);\r
-extern void mp3_start_play(FILE *f, int pos);\r
+extern int  mp3_get_bitrate(void *f, int size);\r
+extern void mp3_start_play(void *f, int pos);\r
 extern void mp3_update(int *buffer, int length, int stereo);\r
 \r
 // this function should write-back d-cache and invalidate i-cache\r
 // on a mem region [start_addr, end_addr)\r
-// used by SVP dynarec\r
-extern void cache_flush_d_inval_i(const void *start_addr, const void *end_addr);\r
+// used by dynarecs\r
+extern void cache_flush_d_inval_i(void *start_addr, void *end_addr);\r
+\r
+// attempt to alloc mem at specified address.\r
+// alloc anywhere else if that fails (callers should handle that)\r
+extern void *plat_mmap(unsigned long addr, size_t size, int need_exec, int is_fixed);\r
+extern void *plat_mremap(void *ptr, size_t oldsize, size_t newsize);\r
+extern void  plat_munmap(void *ptr, size_t size);\r
+extern int   plat_mem_set_exec(void *ptr, size_t size);\r
+\r
+// this one should handle display mode changes\r
+extern void emu_video_mode_change(int start_line, int line_count, int is_32cols);\r
+\r
+// this must switch to 16bpp mode\r
+extern void emu_32x_startup(void);\r
+\r
+// optional 32X BIOS, should be left NULL if not used\r
+// must be 256, 2048, 1024 bytes\r
+extern void *p32x_bios_g, *p32x_bios_m, *p32x_bios_s;\r
 \r
 // Pico.c\r
 #define POPT_EN_FM          (1<< 0) // 00 000x\r
@@ -37,7 +52,7 @@ extern void cache_flush_d_inval_i(const void *start_addr, const void *end_addr);
 #define POPT_EN_Z80         (1<< 2)\r
 #define POPT_EN_STEREO      (1<< 3)\r
 #define POPT_ALT_RENDERER   (1<< 4) // 00 00x0\r
-#define POPT_6BTN_PAD       (1<< 5)\r
+// unused                   (1<< 5)\r
 // unused                   (1<< 6)\r
 #define POPT_ACC_SPRITES    (1<< 7)\r
 #define POPT_DIS_32C_BORDER (1<< 8) // 00 0x00\r
@@ -45,20 +60,27 @@ extern void cache_flush_d_inval_i(const void *start_addr, const void *end_addr);
 #define POPT_EN_MCD_PCM     (1<<10)\r
 #define POPT_EN_MCD_CDDA    (1<<11)\r
 #define POPT_EN_MCD_GFX     (1<<12) // 00 x000\r
-#define POPT_EN_MCD_PSYNC   (1<<13)\r
+// unused                   (1<<13)\r
 #define POPT_EN_SOFTSCALE   (1<<14)\r
 #define POPT_EN_MCD_RAMCART (1<<15)\r
 #define POPT_DIS_VDP_FIFO   (1<<16) // 0x 0000\r
-#define POPT_EN_SVP_DRC     (1<<17)\r
+#define POPT_EN_DRC         (1<<17)\r
 #define POPT_DIS_SPRITE_LIM (1<<18)\r
 #define POPT_DIS_IDLE_DET   (1<<19)\r
+#define POPT_EN_32X         (1<<20)\r
+#define POPT_EN_PWM         (1<<21)\r
 extern int PicoOpt; // bitfield\r
+\r
 #define PAHW_MCD  (1<<0)\r
 #define PAHW_32X  (1<<1)\r
 #define PAHW_SVP  (1<<2)\r
 #define PAHW_PICO (1<<3)\r
+#define PAHW_SMS  (1<<4)\r
 extern int PicoAHW;            // Pico active hw\r
-extern int PicoVer;\r
+\r
+#define PQUIRK_FORCE_6BTN   (1<<0)\r
+extern int PicoQuirks;\r
+\r
 extern int PicoSkipFrame;      // skip rendering frame, but still do sound (if enabled) and emulation stuff\r
 extern int PicoRegionOverride; // override the region detection 0: auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
 extern int PicoAutoRgnOrder;   // packed priority list of regions, for example 0x148 means this detection order: EUR, USA, JAP\r
@@ -67,21 +89,23 @@ void PicoInit(void);
 void PicoExit(void);\r
 void PicoPower(void);\r
 int  PicoReset(void);\r
+void PicoLoopPrepare(void);\r
 void PicoFrame(void);\r
 void PicoFrameDrawOnly(void);\r
 extern int PicoPad[2]; // Joypads, format is MXYZ SACB RLDU\r
-extern void (*PicoWriteSound)(int len); // called once per frame at the best time to send sound buffer (PsndOut) to hardware\r
+extern void (*PicoWriteSound)(int bytes); // called once per frame at the best time to send sound buffer (PsndOut) to hardware\r
 extern void (*PicoMessage)(const char *msg); // callback to output text message from emu\r
 typedef enum { PI_ROM, PI_ISPAL, PI_IS40_CELL, PI_IS240_LINES } pint_t;\r
 typedef union { int vint; void *vptr; } pint_ret_t;\r
 void PicoGetInternal(pint_t which, pint_ret_t *ret);\r
 \r
-// cd/Pico.c\r
+struct PicoEState;\r
+\r
+// cd/mcd.c\r
 extern void (*PicoMCDopenTray)(void);\r
 extern void (*PicoMCDcloseTray)(void);\r
-extern int PicoCDBuffers;\r
 \r
-// Pico/Pico.c\r
+// pico.c\r
 #define XPCM_BUFFER_SIZE (320+160)\r
 typedef struct\r
 {\r
@@ -100,20 +124,14 @@ extern picohw_state PicoPicohw;
 \r
 // area.c\r
 int PicoState(const char *fname, int is_save);\r
-int PicoStateLoadVDP(const char *fname);\r
+int PicoStateLoadGfx(const char *fname);\r
+void *PicoTmpStateSave(void);\r
+void  PicoTmpStateRestore(void *data);\r
 extern void (*PicoStateProgressCB)(const char *str);\r
 \r
-// cd/area.c\r
-int  PicoCdLoadStateGfx(void *file);\r
-\r
-// cd/buffering.c\r
-void PicoCDBufferInit(void);\r
-void PicoCDBufferFree(void);\r
-void PicoCDBufferFlush(void);\r
-\r
-// cd/cd_sys.c\r
-int Insert_CD(const char *cdimg_name, int type);\r
-void Stop_CD(void); // releases all resources taken when CD game was started.\r
+// cd/cdd.c\r
+int cdd_load(const char *filename, int type);\r
+int cdd_unload(void);\r
 \r
 // Cart.c\r
 typedef enum\r
@@ -128,38 +146,36 @@ typedef struct
        void *param;            /* additional file related field */\r
        unsigned int size;      /* size */\r
        pm_type type;\r
+       char ext[4];\r
 } pm_file;\r
 pm_file *pm_open(const char *path);\r
 size_t   pm_read(void *ptr, size_t bytes, pm_file *stream);\r
 int      pm_seek(pm_file *stream, long offset, int whence);\r
 int      pm_close(pm_file *fp);\r
-int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize);\r
-int PicoCartInsert(unsigned char *rom,unsigned int romsize);\r
-void Byteswap(unsigned char *data,int len);\r
+int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize,int is_sms);\r
+int PicoCartInsert(unsigned char *rom, unsigned int romsize, const char *carthw_cfg);\r
 void PicoCartUnload(void);\r
 extern void (*PicoCartLoadProgressCB)(int percent);\r
-extern void (*PicoCDLoadProgressCB)(int percent);\r
+extern void (*PicoCDLoadProgressCB)(const char *fname, int percent);\r
+extern int PicoGameLoaded;\r
 \r
 // Draw.c\r
-void PicoDrawSetColorFormat(int which); // 0=BGR444, 1=RGB555, 2=8bit(HighPal pal)\r
-extern void *DrawLineDest;\r
-#if OVERRIDE_HIGHCOL\r
-extern unsigned char *HighCol;\r
-#else\r
-extern unsigned char  HighCol[8+320+8];\r
-#endif\r
-extern int (*PicoScanBegin)(unsigned int num);\r
-extern int (*PicoScanEnd)(unsigned int num);\r
+// for line-based renderer, set conversion\r
+// from internal 8 bit representation in 'HighCol' to:\r
+typedef enum\r
+{\r
+       PDF_NONE = 0,    // no conversion\r
+       PDF_RGB555,      // RGB/BGR output, depends on compile options\r
+       PDF_8BIT,        // 8-bit out (handles shadow/hilight mode, sonic water)\r
+} pdso_t;\r
+void PicoDrawSetOutFormat(pdso_t which, int use_32x_line_mode);\r
+void PicoDrawSetOutBuf(void *dest, int increment);\r
+void PicoDrawSetCallbacks(int (*begin)(unsigned int num), int (*end)(unsigned int num));\r
 // utility\r
 #ifdef _ASM_DRAW_C\r
 void vidConvCpyRGB565(void *to, void *from, int pixels);\r
 #endif\r
-void PicoDoHighPal555(int sh);\r
-extern int PicoDrawMask;\r
-#define PDRAW_LAYERB_ON      (1<<2)\r
-#define PDRAW_LAYERA_ON      (1<<3)\r
-#define PDRAW_SPRITES_LOW_ON (1<<4)\r
-#define PDRAW_SPRITES_HI_ON  (1<<7)\r
+void PicoDoHighPal555(int sh, int line, struct PicoEState *est);\r
 // internals\r
 #define PDRAW_SPRITES_MOVED (1<<0) // (asm)\r
 #define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
@@ -169,27 +185,75 @@ extern int PicoDrawMask;
 #define PDRAW_SONIC_MODE    (1<<5) // mid-frame palette changes for 8bit renderer\r
 #define PDRAW_PLANE_HI_PRIO (1<<6) // have layer with all hi prio tiles (mk3)\r
 #define PDRAW_SHHI_DONE     (1<<7) // layer sh/hi already processed\r
-extern int rendstatus;\r
-extern unsigned short HighPal[0x100];\r
+#define PDRAW_32_COLS       (1<<8) // 32 column mode\r
+extern int rendstatus_old;\r
+extern int rendlines;\r
 \r
-// Draw2.c\r
+// draw.c\r
+void PicoDrawUpdateHighPal(void);\r
+void PicoDrawSetInternalBuf(void *dest, int line_increment);\r
+\r
+// draw2.c\r
 // stuff below is optional\r
-extern unsigned char  *PicoDraw2FB;  // buffer for fast renderer in format (8+320)x(8+224+8) (eights for borders)\r
 extern unsigned short *PicoCramHigh; // pointer to CRAM buff (0x40 shorts), converted to native device color (works only with 16bit for now)\r
 extern void (*PicoPrepareCram)();    // prepares PicoCramHigh for renderer to use\r
 \r
+// pico.c (32x)\r
+#ifndef NO_32X\r
+\r
+void Pico32xSetClocks(int msh2_hz, int ssh2_hz);\r
+\r
+#else\r
+\r
+#define Pico32xSetClocks(msh2_khz, ssh2_khz)\r
+\r
+#endif\r
+\r
+// normally 68k clock (7670442) * 3, in reality but much lower\r
+// because of high memory latencies\r
+#define PICO_MSH2_HZ ((int)(7670442.0 * 2.4))\r
+#define PICO_SSH2_HZ ((int)(7670442.0 * 2.4))\r
+\r
 // sound.c\r
 extern int PsndRate,PsndLen;\r
 extern short *PsndOut;\r
 extern void (*PsndMix_32_to_16l)(short *dest, int *src, int count);\r
 void PsndRerate(int preserve_state);\r
 \r
-// Utils.c\r
-extern int PicuAnd;\r
-int PicuQuick(unsigned short *dest,unsigned short *src);\r
-int PicuShrink(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
-int PicuShrinkReverse(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
-int PicuMerge(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
+// media.c\r
+enum media_type_e {\r
+  PM_BAD_DETECT = -1,\r
+  PM_ERROR = -2,\r
+  PM_BAD_CD = -3,\r
+  PM_BAD_CD_NO_BIOS = -4,\r
+  PM_MD_CART = 1,      /* also 32x */\r
+  PM_MARK3,\r
+  PM_CD,\r
+};\r
+\r
+enum cd_img_type\r
+{\r
+  CIT_NOT_CD = 0,\r
+  CIT_ISO,\r
+  CIT_BIN,\r
+  CIT_CUE\r
+};\r
+\r
+enum media_type_e PicoLoadMedia(const char *filename,\r
+  const char *carthw_cfg_fname,\r
+  const char *(*get_bios_filename)(int *region, const char *cd_fname),\r
+  void (*do_region_override)(const char *media_filename));\r
+int PicoCdCheck(const char *fname_in, int *pregion);\r
+\r
+extern unsigned char media_id_header[0x100];\r
+\r
+// memory.c\r
+enum input_device {\r
+  PICO_INPUT_NOTHING,\r
+  PICO_INPUT_PAD_3BTN,\r
+  PICO_INPUT_PAD_6BTN,\r
+};\r
+void PicoSetInputDevice(int port, enum input_device device);\r
 \r
 #ifdef __cplusplus\r
 } // End of extern "C"\r