Welcome to mirror list, hosted at ThFree Co, Russian Federation.

FlashHelper.cs « FlashWriters « FamicomDumper - github.com/ClusterM/famicom-dumper-client.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 512a21f807e7c3648952478c0146b548275e04ab (plain)
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
using com.clusterrr.Famicom.DumperConnection;
using System;
using System.IO;
using System.Linq;

namespace com.clusterrr.Famicom.Dumper.FlashWriters
{
    static class FlashHelper
    {
        private enum FlashDeviceInterface
        {
            x8_only = 0x0000,
            x16_only = 0x0001,
            x8_and_x16_via_byte_pin = 0x0002,
            x32_only = 0x0003,
            x8_and_x16_via_word_pin = 0x0004,
        }

        public static void ResetFlash(IFamicomDumperConnection dumper)
        {
            // Exit command set entry if any
            dumper.WriteCpu(0x8000, 0x90);
            dumper.WriteCpu(0x8000, 0x00);
            // Reset
            dumper.WriteCpu(0x8000, 0xF0);
        }

        public static CFIInfo GetCFIInfo(IFamicomDumperConnection dumper)
        {
            try
            {
                ResetFlash(dumper);
                dumper.WriteCpu(0x8AAA, 0x98); // CFI mode
                var cfiRaw = dumper.ReadCpu(0x8000, 0x100);
                var cfi = new CFIInfo(cfiRaw, CFIInfo.ParseMode.Every2Bytes);
                return cfi;
            }
            finally
            {
                dumper.WriteCpu(0x8000, 0xF0);
            }
        }

        public static void PrintCFIInfo(CFIInfo cfi)
        {
            Console.WriteLine($"Primary algorithm command set and control interface ID code: {cfi.PrimaryAlgorithmCommandSet:X4}h");
            Console.WriteLine($"Alternative algorithm command set and control interface ID code: {cfi.AlternativeAlgorithmCommandSet:X4}h");
            Console.WriteLine($"Vcc logic supply sinimum program / erase voltage: {cfi.VccLogicSupplyMinimumProgramErase:F1}v");
            Console.WriteLine($"Vcc logic supply maximum program / erase voltage: {cfi.VccLogicSupplyMaximumProgramErase:F1}v");
            Console.WriteLine($"Vpp [programming] supply minimum program / erase voltage: {cfi.VppSupplyMinimumProgramErasevoltage:F1}v");
            Console.WriteLine($"Vpp [programming] supply maximum program / erase voltage: {cfi.VppSupplyMaximumProgramErasevoltage:F1}v");
            Console.WriteLine($"Typical timeout for single byte/word/D-word program: {cfi.TypicalTimeoutPerSingleProgram}us");
            Console.WriteLine($"Typical timeout for maximum-size multi-byte program: {cfi.TypicalTimeoutForMaximumSizeMultiByteProgram}us");
            Console.WriteLine($"Typical timeout for individual block erase: {cfi.TypicalTimeoutPerIndividualBlockErase}ms");
            Console.WriteLine($"Typical timeout for full chip erase: {cfi.TypicalTimeoutForFullChipErase}ms");
            Console.WriteLine($"Maximum timeout for single byte/word/D-word program: {cfi.MaximumTimeoutPerSingleProgram}us");
            Console.WriteLine($"Maximum timeout for maximum-size multi-byte program: {cfi.MaximumTimeoutForMaximumSizeMultiByteProgram}us");
            Console.WriteLine($"Maximum timeout for individual block erase: {cfi.MaximumTimeoutPerIndividualBlockErase}ms");
            Console.WriteLine($"Maximum timeout for full chip erase: {cfi.MaximumTimeoutForFullChipErase}ms");
            Console.WriteLine($"Device size: {cfi.DeviceSize / 1024 / 1024} MByte / {cfi.DeviceSize / 1024 / 1024 * 8} Mbit");
            Console.WriteLine($"Flash device interface: {cfi.FlashDeviceInterfaceCodeDescription.ToString().Replace("_", " ")}");
            Console.WriteLine($"Maximum number of bytes in multi-byte program: {cfi.MaximumNumberOfBytesInMultiProgram}");
            for (int eraseBlockRegion = 0; eraseBlockRegion < cfi.EraseBlockRegionsInfo.Length; eraseBlockRegion++)
            {
                Console.WriteLine($"Erase block region #{eraseBlockRegion}:");
                Console.WriteLine($" - Sectors size: {cfi.EraseBlockRegionsInfo[eraseBlockRegion].SizeOfBlocks} Bytes");
                Console.WriteLine($" - Sectors count: {cfi.EraseBlockRegionsInfo[eraseBlockRegion].NumberOfBlocks}");
            }
        }

        public static void PasswordProgramm(FamicomDumperLocal dumper, byte[] password)
        {
            if (password.Length != 8)
                throw new InvalidDataException("Invalid password length");
            Console.Write("Programming password... ");
            // Password Protection Set Entry
            dumper.WriteCpu(0x8AAA, 0xAA);
            dumper.WriteCpu(0x8555, 0x55);
            dumper.WriteCpu(0x8AAA, 0x60);
            try
            {
                for (byte i = 0; i < password.Length; i++)
                {
                    dumper.WriteCpu(0x8000, 0xA0);
                    dumper.WriteCpu((ushort)(0x8000 + i), password[i]);
                }
                var verify = dumper.ReadCpu(0x8000, 8);
                for (byte i = 0; i < password.Length; i++)
                    if (password[i] != verify[i])
                        throw new InvalidDataException("Password verification failed");
            }
            finally
            {
                ResetFlash(dumper);
            }
            Console.WriteLine("OK");

            Console.Write("Programming lock register... ");
            // Lock Register Set Entry
            dumper.WriteCpu(0x8AAA, 0xAA);
            dumper.WriteCpu(0x8555, 0x55);
            dumper.WriteCpu(0x8AAA, 0x40);
            try
            {
                // Bits Program
                dumper.WriteCpu(0x8000, 0xA0);
                dumper.WriteCpu(0x8000, 1 << 2 ^ 0xFF); // password protection
                var r = dumper.ReadCpu(0x8000);
                if ((r & 7) != 3)
                    throw new InvalidDataException("Lock bit verification failed");
            }
            finally
            {
                ResetFlash(dumper);
            }
            Console.WriteLine("OK");
        }

        public static void PasswordUnlock(FamicomDumperLocal dumper, byte[] password)
        {
            try
            {
                if (password.Length != 8)
                    throw new InvalidDataException("Invalid password length");
                Console.Write("Unlocking password... ");
                // Password Protection Set Entry
                dumper.WriteCpu(0x8AAA, 0xAA);
                dumper.WriteCpu(0x8555, 0x55);
                dumper.WriteCpu(0x8AAA, 0x60);
                // Password unlock
                dumper.WriteCpu(0x8000, 0x25);
                dumper.WriteCpu(0x8000, 0x03);
                for (byte i = 0; i < password.Length; i++)
                    dumper.WriteCpu((ushort)(0x8000 + i), password[i]);
                dumper.WriteCpu(0x8000, 0x29);
                Console.WriteLine("OK");
            }
            finally
            {
                ResetFlash(dumper);
            }
        }

        public static void LockBitsCheckPrint(IFamicomDumperConnection dumper)
        {
            try
            {
                // Lock Register Set Entry
                dumper.WriteCpu(0x8AAA, 0xAA);
                dumper.WriteCpu(0x8555, 0x55);
                dumper.WriteCpu(0x8AAA, 0x40);
                var lockRegister = dumper.ReadCpu(0x8000);
                if ((lockRegister & 1) == 0)
                    Console.WriteLine("WARNING: Secured Silicon Sector Protection Bit is set!");
                if ((lockRegister & 2) == 0)
                    Console.WriteLine("WARNING: Persistent Protection Mode Lock Bit is set!");
                if ((lockRegister & 4) == 0)
                    Console.WriteLine("WARNING: Password Protection Mode Lock Bit is set!");
            }
            finally
            {
                ResetFlash(dumper);
            }
        }

        public static void PPBLockBitCheckPrint(IFamicomDumperConnection dumper)
        {
            try
            {
                // PPB Lock Command Set Entry
                dumper.WriteCpu(0x8AAA, 0xAA);
                dumper.WriteCpu(0x8555, 0x55);
                dumper.WriteCpu(0x8AAA, 0x50);
                var ppbLockStatus = dumper.ReadCpu(0x8000);
                if (ppbLockStatus == 0)
                    Console.WriteLine("WARNING: PPB Lock Bit is set!");
            }
            finally
            {
                ResetFlash(dumper);
            }
        }

        public static byte PPBRead(IFamicomDumperConnection dumper)
        {
            try
            {
                // PPB Command Set Entry
                dumper.WriteCpu(0x8AAA, 0xAA);
                dumper.WriteCpu(0x8555, 0x55);
                dumper.WriteCpu(0x8AAA, 0xC0);
                // PPB Status Read
                return dumper.ReadCpu(0x8000);
            }
            finally
            {
                ResetFlash(dumper);
            }
        }

        public static void PPBSet(IFamicomDumperConnection dumper)
        {
            Console.Write("Writing PPB for sector... ");
            // PPB Command Set Entry
            dumper.WriteCpu(0x8AAA, 0xAA);
            dumper.WriteCpu(0x8555, 0x55);
            dumper.WriteCpu(0x8AAA, 0xC0);
            // PPB Program
            dumper.WriteCpu(0x8000, 0xA0);
            dumper.WriteCpu(0x8000, 0x00);
            // Check
            try
            {
                DateTime startTime = DateTime.Now;
                while (true)
                {
                    byte b = dumper.ReadCpu(0x8000);
                    if (b == 0x00)
                        break;
                    if ((DateTime.Now - startTime).TotalMilliseconds >= 1500)
                        throw new IOException("PPB write failed");
                }
            }
            finally
            {
                ResetFlash(dumper);
            }
            Console.WriteLine("OK");
        }

        public static void PPBClear(IFamicomDumperConnection dumper)
        {
            LockBitsCheckPrint(dumper);
            PPBLockBitCheckPrint(dumper);
            Console.Write($"Erasing all PPBs... ");
            // PPB Command Set Entry
            dumper.WriteCpu(0x8AAA, 0xAA);
            dumper.WriteCpu(0x8555, 0x55);
            dumper.WriteCpu(0x8AAA, 0xC0);
            // All PPB Erase
            dumper.WriteCpu(0x8000, 0x80);
            dumper.WriteCpu(0x8000, 0x30);
            // Check
            try
            {
                DateTime startTime = DateTime.Now;
                while (true)
                {
                    byte b = dumper.ReadCpu(0x8000);
                    if (b == 0x01)
                        break;
                    if ((DateTime.Now - startTime).TotalMilliseconds >= 1500)
                        throw new IOException("PPB clear failed");
                }
            }
            finally
            {
                ResetFlash(dumper);
            }
            Console.WriteLine("OK");
        }
    }
}