src/state.h

Mon, 29 Nov 2010 00:20:40 +0000

author
Philip Pemberton <philpem@philpem.me.uk>
date
Mon, 29 Nov 2010 00:20:40 +0000
changeset 18
320dc6206f52
child 24
724d2f6deb37
permissions
-rw-r--r--

split state handling into state.[ch]

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@18 24 // GENERAL CONTROL REGISTER
philpem@18 25 /// GENCON.ROMLMAP -- false ORs the address with 0x800000, forcing the
philpem@18 26 /// 68010 to access ROM instead of RAM when booting. TRM page 2-36.
philpem@18 27 bool romlmap;
philpem@18 28 } S_state;
philpem@18 29
philpem@18 30 // Global emulator state. Yes, I know global variables are evil, please don't
philpem@18 31 // email me and lecture me about it. -philpem
philpem@18 32 #ifndef _STATE_C
philpem@18 33 extern S_state state;
philpem@18 34 #else
philpem@18 35 S_state state;
philpem@18 36 #endif
philpem@18 37
philpem@18 38 /**
philpem@18 39 * @brief Initialise system state
philpem@18 40 *
philpem@18 41 * @param ramsize RAM size in bytes -- must be a multiple of 512KiB, min 512KiB, max 4MiB.
philpem@18 42 *
philpem@18 43 * Initialises the emulator's internal state.
philpem@18 44 */
philpem@18 45 int state_init(size_t ramsize);
philpem@18 46
philpem@18 47 /**
philpem@18 48 * @brief Deinitialise system state
philpem@18 49 *
philpem@18 50 * Deinitialises the saved state, and frees all memory. Call this function
philpem@18 51 * before exiting your program to avoid memory leaks.
philpem@18 52 */
philpem@18 53 void state_done();
philpem@18 54
philpem@18 55 #endif