src/state.h

Wed, 01 Dec 2010 22:34:15 +0000

author
Philip Pemberton <philpem@philpem.me.uk>
date
Wed, 01 Dec 2010 22:34:15 +0000
changeset 26
fef12817c5e8
parent 24
724d2f6deb37
child 32
a44afcf2354c
permissions
-rw-r--r--

move repeated R/W bit-shifting stuff into macros and fix RAM addressing issue

philpem@18 1 #ifndef _STATE_H
philpem@18 2 #define _STATE_H
philpem@18 3
philpem@18 4 #include <stddef.h>
philpem@18 5 #include <stdint.h>
philpem@18 6 #include <stdbool.h>
philpem@18 7
philpem@18 8 // Maximum size of the Boot PROMs. Must be a binary power of two.
philpem@18 9 #define ROM_SIZE 32768
philpem@18 10
philpem@18 11 /**
philpem@18 12 * @brief Emulator state storage
philpem@18 13 *
philpem@18 14 * This structure stores the internal state of the emulator.
philpem@18 15 */
philpem@18 16 typedef struct {
philpem@18 17 // Boot PROM can be up to 32Kbytes total size
philpem@18 18 uint8_t rom[ROM_SIZE]; ///< Boot PROM data buffer
philpem@18 19
philpem@18 20 // Main system RAM
philpem@18 21 uint8_t *ram; ///< RAM data buffer
philpem@18 22 size_t ram_size; ///< Size of RAM buffer in bytes
philpem@18 23
philpem@24 24 // Video RAM
philpem@24 25 uint8_t vram[0x8000]; ///< Video RAM
philpem@24 26
philpem@26 27 // Map RAM
philpem@26 28 uint8_t map[0x800]; ///< Map RAM
philpem@26 29
philpem@18 30 // GENERAL CONTROL REGISTER
philpem@18 31 /// GENCON.ROMLMAP -- false ORs the address with 0x800000, forcing the
philpem@18 32 /// 68010 to access ROM instead of RAM when booting. TRM page 2-36.
philpem@24 33 bool romlmap;
philpem@18 34 } S_state;
philpem@18 35
philpem@18 36 // Global emulator state. Yes, I know global variables are evil, please don't
philpem@18 37 // email me and lecture me about it. -philpem
philpem@18 38 #ifndef _STATE_C
philpem@18 39 extern S_state state;
philpem@18 40 #else
philpem@18 41 S_state state;
philpem@18 42 #endif
philpem@18 43
philpem@18 44 /**
philpem@18 45 * @brief Initialise system state
philpem@18 46 *
philpem@18 47 * @param ramsize RAM size in bytes -- must be a multiple of 512KiB, min 512KiB, max 4MiB.
philpem@18 48 *
philpem@18 49 * Initialises the emulator's internal state.
philpem@18 50 */
philpem@18 51 int state_init(size_t ramsize);
philpem@18 52
philpem@18 53 /**
philpem@18 54 * @brief Deinitialise system state
philpem@18 55 *
philpem@18 56 * Deinitialises the saved state, and frees all memory. Call this function
philpem@18 57 * before exiting your program to avoid memory leaks.
philpem@18 58 */
philpem@18 59 void state_done();
philpem@18 60
philpem@18 61 #endif