-
Notifications
You must be signed in to change notification settings - Fork 3
/
flash_io.h
171 lines (146 loc) · 5.29 KB
/
flash_io.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
#ifndef _FLASH_IO_H_
#define _FLASH_IO_H_
#include <stddef.h>
#define FLASH_MIN_ADDR 0x000000
#define FLASH_MAX_ADDR 0x01FFFF
#define FILE_MIN_ADDR 0x000000
#define FILE_MAX_ADDR 0x003FFF
/*
* RCP has only block-access (64-bit intervals) to the flash RAM.
*/
#define BLOCK_SIZE 8
#if ((FLASH_MIN_ADDR) % BLOCK_SIZE != 0 || (FLASH_MAX_ADDR) % BLOCK_SIZE != 7)
#error Unaligned RCP address range for flash memory.
#endif
#if ((FILE_MIN_ADDR) % BLOCK_SIZE != 0 || (FILE_MAX_ADDR) % BLOCK_SIZE != 7)
#error Unaligned flash memory range for save file segmentation.
#endif
#define FLASH_SIZE ((FLASH_MAX_ADDR) - (FLASH_MIN_ADDR) + 1ul)
#define FILE_SIZE ((FILE_MAX_ADDR) - (FILE_MIN_ADDR) + 1)
#define NUMBER_OF_DATA_FILES ((FLASH_SIZE) / (FILE_SIZE))
#if defined(LITTLE_ENDIAN_64_FIXED)
#define ENDIAN_SWAP_BYTE 07
#elif defined(LITTLE_ENDIAN_32_FIXED)
#define ENDIAN_SWAP_BYTE 03
#elif defined(LITTLE_ENDIAN_16_FIXED)
#define ENDIAN_SWAP_BYTE 01
#else
#define ENDIAN_SWAP_BYTE 00
#endif
/*
* GCC and the various compilers based on it (which also may define this)
* have been known to bundle "stdint.h", which does not necessarily break
* strict C89 compliance by itself, even though the existence of the header
* is guaranteed only by C99 extensions or full support.
*/
#if defined(__GNUC__)
#include <stdint.h>
#endif
#include <limits.h>
#if !defined(TRUE) && !defined(FALSE)
#define FALSE 0
#define TRUE 1
#endif
typedef int Boolean;
/*
* fread() and fwrite() converting 9-bit chars into 8-bit MIPS byte arrays...
* Sounds interesting but unfortunately like something I have no way to test.
*/
#if (CHAR_BIT != 8) || (UCHAR_MAX != 0xFFu)
#error Non-POSIX char sizes will screw the file system access up.
#endif
typedef signed char s8;
typedef unsigned char u8;
/*
* smallest C data type that is greater than or equal to 16 bits
*/
#if (SHRT_MIN >= -32767 || SHRT_MAX < +32767 || USHRT_MAX < 0xFFFFu)
#error Non-ANSI-compliant (short) data type.
#else
typedef signed short s16;
typedef unsigned short u16;
#endif
/*
* smallest C data type that is greater than or equal to 32 bits
*/
#if (SHRT_MIN < -2147483647 && SHRT_MAX >= +2147483647)
typedef signed short s32;
typedef unsigned short u32;
#elif (INT_MIN < -2147483647 && INT_MAX >= +2147483647)
typedef signed int s32;
typedef unsigned int u32;
#else
typedef signed long s32;
typedef unsigned long u32;
#endif
/*
* smallest C data type that is greater than or equal to 64 bits
*/
#if (SHRT_MIN < -9223372036854775807 && SHRT_MAX >= +9223372036854775807)
typedef signed short s64;
typedef unsigned short u64;
#elif (INT_MIN < -9223372036854775807 && INT_MAX >= +9223372036854775807)
typedef signed int s64;
typedef unsigned int u64;
#elif (LONG_MIN < -9223372036854775807 && LONG_MAX >= +9223372036854775807)
typedef signed long s64;
typedef unsigned long u64;
#elif defined(INT_LEAST64_MIN) || defined(INT_LEAST64_MAX)
typedef int_least64_t s64;
typedef uint_least64_t u64; /* POSIX's stdint.h, adopted in ISO C99 */
#elif defined(_MSC_VER)
typedef signed __int64 s64;
typedef unsigned __int64 u64; /* Microsoft-specific LLP64 ABI rules */
#else
typedef signed long long s64;
typedef unsigned long long u64; /* fallback to require C99 support */
#endif
/*
* just in case signedness does not matter at some point, for readability
*/
typedef char i8;
typedef s16 i16;
typedef s32 i32;
typedef s64 i64;
typedef union {
u64 block;
s64 doubleword;
u32 words[2];
u16 halfwords[4];
u8 bytes[8];
} RCP_block;
extern u8* flash_RAM;
/*
* reads from flash-native endian to client-native endian
* (on x86, from MIPS big-endian to little-endian return slot)
*/
extern u8 read8 (const void * address);
extern u16 read16(const void * address);
extern u32 read32(const void * address);
extern u64 read64(const void * address);
/*
* writes from client-native endian to flash-native endian
* (on x86, from little-endian source to MIPS big-endian memory storage)
*/
extern void write8 (void * dst, const u8 src);
extern void write16(void * dst, const u16 src);
extern void write32(void * dst, const u32 src);
extern void write64(void * dst, const u64 src);
/*
* memory management functions for the entire flash RAM
* The only portable construct we have for flash I/O is C file system access.
*/
extern u8* falloc(size_t flash_size);
extern long load_flash(const char * filename);
extern long save_flash(const char * filename);
extern unsigned int swap_flash(unsigned int interval);
/*
* When swap_flash() is called with 0 as the parameter, the memory is swapped
* on an automatically detected interval that is based on the current byte
* order found in the game data. However, if there is no game data in the
* entire flash memory, then automatic detection cannot occur based on this
* condition alone. We fall back to a new detection, get_client_swap_mask(),
* which uses the current hardware's native byte order as the swap mask.
*/
extern unsigned int get_client_swap_mask(void);
#endif