// /*************************************************************************** // The Disc Image Chef // ---------------------------------------------------------------------------- // // Filename : D88.cs // Author(s) : Natalia Portillo // // Component : Disk image plugins. // // --[ Description ] ---------------------------------------------------------- // // Manages Quasi88 disk images. // // --[ License ] -------------------------------------------------------------- // // This library is free software; you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as // published by the Free Software Foundation; either version 2.1 of the // License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License along with this library; if not, see . // // ---------------------------------------------------------------------------- // Copyright © 2011-2018 Natalia Portillo // ****************************************************************************/ using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Runtime.InteropServices; using System.Text; using DiscImageChef.CommonTypes; using DiscImageChef.CommonTypes.Enums; using DiscImageChef.CommonTypes.Exceptions; using DiscImageChef.CommonTypes.Interfaces; using DiscImageChef.CommonTypes.Structs; using DiscImageChef.Console; using DiscImageChef.Decoders.Floppy; using Schemas; namespace DiscImageChef.DiscImages { // Information from Quasi88's FORMAT.TXT file // Japanese comments copied from there // TODO: Solve media types public class D88 : IMediaImage { const byte READ_ONLY = 0x10; readonly byte[] reservedEmpty = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; ImageInfo imageInfo; List sectorsData; public D88() { imageInfo = new ImageInfo { ReadableSectorTags = new List(), ReadableMediaTags = new List(), HasPartitions = false, HasSessions = false, Version = null, Application = null, ApplicationVersion = null, Creator = null, Comments = null, MediaManufacturer = null, MediaModel = null, MediaSerialNumber = null, MediaBarcode = null, MediaPartNumber = null, MediaSequence = 0, LastMediaSequence = 0, DriveManufacturer = null, DriveModel = null, DriveSerialNumber = null, DriveFirmwareRevision = null }; } public string Name => "D88 Disk Image"; public Guid Id => new Guid("669EDC77-EC41-4720-A88C-49C38CFFBAA0"); public ImageInfo Info => imageInfo; public string Format => "D88 disk image"; public List Partitions => throw new FeatureUnsupportedImageException("Feature not supported by image format"); public List Tracks => throw new FeatureUnsupportedImageException("Feature not supported by image format"); public List Sessions => throw new FeatureUnsupportedImageException("Feature not supported by image format"); public bool Identify(IFilter imageFilter) { Stream stream = imageFilter.GetDataForkStream(); stream.Seek(0, SeekOrigin.Begin); // Even if disk name is supposedly ASCII, I'm pretty sure most emulators allow Shift-JIS to be used :p Encoding shiftjis = Encoding.GetEncoding("shift_jis"); D88Header d88Hdr = new D88Header(); if(stream.Length < Marshal.SizeOf(d88Hdr)) return false; byte[] hdrB = new byte[Marshal.SizeOf(d88Hdr)]; stream.Read(hdrB, 0, hdrB.Length); GCHandle handle = GCHandle.Alloc(hdrB, GCHandleType.Pinned); d88Hdr = (D88Header)Marshal.PtrToStructure(handle.AddrOfPinnedObject(), typeof(D88Header)); handle.Free(); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.name = \"{0}\"", StringHandlers.CToString(d88Hdr.name, shiftjis)); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.reserved is empty? = {0}", d88Hdr.reserved.SequenceEqual(reservedEmpty)); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.write_protect = 0x{0:X2}", d88Hdr.write_protect); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.disk_type = {0} ({1})", d88Hdr.disk_type, (byte)d88Hdr.disk_type); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.disk_size = {0}", d88Hdr.disk_size); if(d88Hdr.disk_size != stream.Length) return false; if(d88Hdr.disk_type != DiskType.D2 && d88Hdr.disk_type != DiskType.Dd2 && d88Hdr.disk_type != DiskType.Hd2) return false; if(!d88Hdr.reserved.SequenceEqual(reservedEmpty)) return false; int counter = 0; foreach(int t in d88Hdr.track_table) { if(t > 0) counter++; if(t < 0 || t > stream.Length) return false; } DicConsole.DebugWriteLine("D88 plugin", "{0} tracks", counter); return counter > 0; } public bool Open(IFilter imageFilter) { Stream stream = imageFilter.GetDataForkStream(); stream.Seek(0, SeekOrigin.Begin); // Even if disk name is supposedly ASCII, I'm pretty sure most emulators allow Shift-JIS to be used :p Encoding shiftjis = Encoding.GetEncoding("shift_jis"); D88Header d88Hdr = new D88Header(); if(stream.Length < Marshal.SizeOf(d88Hdr)) return false; byte[] hdrB = new byte[Marshal.SizeOf(d88Hdr)]; stream.Read(hdrB, 0, hdrB.Length); GCHandle handle = GCHandle.Alloc(hdrB, GCHandleType.Pinned); d88Hdr = (D88Header)Marshal.PtrToStructure(handle.AddrOfPinnedObject(), typeof(D88Header)); handle.Free(); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.name = \"{0}\"", StringHandlers.CToString(d88Hdr.name, shiftjis)); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.reserved is empty? = {0}", d88Hdr.reserved.SequenceEqual(reservedEmpty)); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.write_protect = 0x{0:X2}", d88Hdr.write_protect); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.disk_type = {0} ({1})", d88Hdr.disk_type, (byte)d88Hdr.disk_type); DicConsole.DebugWriteLine("D88 plugin", "d88hdr.disk_size = {0}", d88Hdr.disk_size); if(d88Hdr.disk_size != stream.Length) return false; if(d88Hdr.disk_type != DiskType.D2 && d88Hdr.disk_type != DiskType.Dd2 && d88Hdr.disk_type != DiskType.Hd2) return false; if(!d88Hdr.reserved.SequenceEqual(reservedEmpty)) return false; int trkCounter = 0; foreach(int t in d88Hdr.track_table) { if(t > 0) trkCounter++; if(t < 0 || t > stream.Length) return false; } DicConsole.DebugWriteLine("D88 plugin", "{0} tracks", trkCounter); if(trkCounter == 0) return false; SectorHeader sechdr = new SectorHeader(); hdrB = new byte[Marshal.SizeOf(sechdr)]; stream.Seek(d88Hdr.track_table[0], SeekOrigin.Begin); stream.Read(hdrB, 0, hdrB.Length); handle = GCHandle.Alloc(hdrB, GCHandleType.Pinned); sechdr = (SectorHeader)Marshal.PtrToStructure(handle.AddrOfPinnedObject(), typeof(SectorHeader)); handle.Free(); DicConsole.DebugWriteLine("D88 plugin", "sechdr.c = {0}", sechdr.c); DicConsole.DebugWriteLine("D88 plugin", "sechdr.h = {0}", sechdr.h); DicConsole.DebugWriteLine("D88 plugin", "sechdr.r = {0}", sechdr.r); DicConsole.DebugWriteLine("D88 plugin", "sechdr.n = {0}", sechdr.n); DicConsole.DebugWriteLine("D88 plugin", "sechdr.spt = {0}", sechdr.spt); DicConsole.DebugWriteLine("D88 plugin", "sechdr.density = {0}", sechdr.density); DicConsole.DebugWriteLine("D88 plugin", "sechdr.deleted_mark = {0}", sechdr.deleted_mark); DicConsole.DebugWriteLine("D88 plugin", "sechdr.status = {0}", sechdr.status); DicConsole.DebugWriteLine("D88 plugin", "sechdr.size_of_data = {0}", sechdr.size_of_data); short spt = sechdr.spt; IBMSectorSizeCode bps = sechdr.n; bool allEqual = true; sectorsData = new List(); for(int i = 0; i < trkCounter; i++) { stream.Seek(d88Hdr.track_table[i], SeekOrigin.Begin); stream.Read(hdrB, 0, hdrB.Length); SortedDictionary sectors = new SortedDictionary(); handle = GCHandle.Alloc(hdrB, GCHandleType.Pinned); sechdr = (SectorHeader)Marshal.PtrToStructure(handle.AddrOfPinnedObject(), typeof(SectorHeader)); handle.Free(); if(sechdr.spt != spt || sechdr.n != bps) { DicConsole.DebugWriteLine("D88 plugin", "Disk tracks are not same size. spt = {0} (expected {1}), bps = {2} (expected {3}) at track {4} sector {5}", sechdr.spt, spt, sechdr.n, bps, i, 0); allEqual = false; } short maxJ = sechdr.spt; byte[] secB; for(short j = 1; j < maxJ; j++) { secB = new byte[sechdr.size_of_data]; stream.Read(secB, 0, secB.Length); sectors.Add(sechdr.r, secB); stream.Read(hdrB, 0, hdrB.Length); handle = GCHandle.Alloc(hdrB, GCHandleType.Pinned); sechdr = (SectorHeader)Marshal.PtrToStructure(handle.AddrOfPinnedObject(), typeof(SectorHeader)); handle.Free(); if(sechdr.spt == spt && sechdr.n == bps) continue; DicConsole.DebugWriteLine("D88 plugin", "Disk tracks are not same size. spt = {0} (expected {1}), bps = {2} (expected {3}) at track {4} sector {5}", sechdr.spt, spt, sechdr.n, bps, i, j, sechdr.deleted_mark); allEqual = false; } secB = new byte[sechdr.size_of_data]; stream.Read(secB, 0, secB.Length); sectors.Add(sechdr.r, secB); foreach(KeyValuePair kvp in sectors) sectorsData.Add(kvp.Value); } DicConsole.DebugWriteLine("D88 plugin", "{0} sectors", sectorsData.Count); imageInfo.MediaType = MediaType.Unknown; if(allEqual) if(trkCounter == 154 && spt == 26 && bps == IBMSectorSizeCode.EighthKilo) imageInfo.MediaType = MediaType.NEC_8_SD; else if(bps == IBMSectorSizeCode.QuarterKilo) switch(trkCounter) { case 80 when spt == 16: imageInfo.MediaType = MediaType.NEC_525_SS; break; case 154 when spt == 26: imageInfo.MediaType = MediaType.NEC_8_DD; break; case 160 when spt == 16: imageInfo.MediaType = MediaType.NEC_525_DS; break; } else if(trkCounter == 154 && spt == 8 && bps == IBMSectorSizeCode.Kilo) imageInfo.MediaType = MediaType.NEC_525_HD; else if(bps == IBMSectorSizeCode.HalfKilo) switch(d88Hdr.track_table.Length) { case 40: { switch(spt) { case 8: imageInfo.MediaType = MediaType.DOS_525_SS_DD_8; break; case 9: imageInfo.MediaType = MediaType.DOS_525_SS_DD_9; break; } } break; case 80: { switch(spt) { case 8: imageInfo.MediaType = MediaType.DOS_525_DS_DD_8; break; case 9: imageInfo.MediaType = MediaType.DOS_525_DS_DD_9; break; } } break; case 160: { switch(spt) { case 15: imageInfo.MediaType = MediaType.NEC_35_HD_15; break; case 9: imageInfo.MediaType = MediaType.DOS_35_DS_DD_9; break; case 18: imageInfo.MediaType = MediaType.DOS_35_HD; break; case 36: imageInfo.MediaType = MediaType.DOS_35_ED; break; } } break; case 480: if(spt == 38) imageInfo.MediaType = MediaType.NEC_35_TD; break; } DicConsole.DebugWriteLine("D88 plugin", "MediaType: {0}", imageInfo.MediaType); imageInfo.ImageSize = (ulong)d88Hdr.disk_size; imageInfo.CreationTime = imageFilter.GetCreationTime(); imageInfo.LastModificationTime = imageFilter.GetLastWriteTime(); imageInfo.MediaTitle = Path.GetFileNameWithoutExtension(imageFilter.GetFilename()); imageInfo.Sectors = (ulong)sectorsData.Count; imageInfo.Comments = StringHandlers.CToString(d88Hdr.name, shiftjis); imageInfo.XmlMediaType = XmlMediaType.BlockMedia; imageInfo.SectorSize = (uint)(128 << (int)bps); switch(imageInfo.MediaType) { case MediaType.NEC_525_SS: imageInfo.Cylinders = 80; imageInfo.Heads = 1; imageInfo.SectorsPerTrack = 16; break; case MediaType.NEC_8_SD: case MediaType.NEC_8_DD: imageInfo.Cylinders = 77; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 26; break; case MediaType.NEC_525_DS: imageInfo.Cylinders = 80; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 16; break; case MediaType.NEC_525_HD: imageInfo.Cylinders = 77; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 8; break; case MediaType.DOS_525_SS_DD_8: imageInfo.Cylinders = 40; imageInfo.Heads = 1; imageInfo.SectorsPerTrack = 8; break; case MediaType.DOS_525_SS_DD_9: imageInfo.Cylinders = 40; imageInfo.Heads = 1; imageInfo.SectorsPerTrack = 9; break; case MediaType.DOS_525_DS_DD_8: imageInfo.Cylinders = 40; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 8; break; case MediaType.DOS_525_DS_DD_9: imageInfo.Cylinders = 40; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 9; break; case MediaType.NEC_35_HD_15: imageInfo.Cylinders = 80; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 15; break; case MediaType.DOS_35_DS_DD_9: imageInfo.Cylinders = 80; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 9; break; case MediaType.DOS_35_HD: imageInfo.Cylinders = 80; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 18; break; case MediaType.DOS_35_ED: imageInfo.Cylinders = 80; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 36; break; case MediaType.NEC_35_TD: imageInfo.Cylinders = 240; imageInfo.Heads = 2; imageInfo.SectorsPerTrack = 38; break; } return true; } public byte[] ReadSector(ulong sectorAddress) { return ReadSectors(sectorAddress, 1); } public byte[] ReadSectors(ulong sectorAddress, uint length) { if(sectorAddress > imageInfo.Sectors - 1) throw new ArgumentOutOfRangeException(nameof(sectorAddress), "Sector address not found"); if(sectorAddress + length > imageInfo.Sectors) throw new ArgumentOutOfRangeException(nameof(length), "Requested more sectors than available"); MemoryStream buffer = new MemoryStream(); for(int i = 0; i < length; i++) buffer.Write(sectorsData[(int)sectorAddress + i], 0, sectorsData[(int)sectorAddress + i].Length); return buffer.ToArray(); } public byte[] ReadDiskTag(MediaTagType tag) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectorTag(ulong sectorAddress, SectorTagType tag) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSector(ulong sectorAddress, uint track) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectorTag(ulong sectorAddress, uint track, SectorTagType tag) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectorsTag(ulong sectorAddress, uint length, SectorTagType tag) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectors(ulong sectorAddress, uint length, uint track) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectorsTag(ulong sectorAddress, uint length, uint track, SectorTagType tag) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectorLong(ulong sectorAddress) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectorLong(ulong sectorAddress, uint track) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectorsLong(ulong sectorAddress, uint length) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public byte[] ReadSectorsLong(ulong sectorAddress, uint length, uint track) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public List GetSessionTracks(Session session) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public List GetSessionTracks(ushort session) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public bool? VerifySector(ulong sectorAddress) { return null; } public bool? VerifySector(ulong sectorAddress, uint track) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public bool? VerifySectors(ulong sectorAddress, uint length, out List failingLbas, out List unknownLbas) { failingLbas = new List(); unknownLbas = new List(); for(ulong i = 0; i < imageInfo.Sectors; i++) unknownLbas.Add(i); return null; } public bool? VerifySectors(ulong sectorAddress, uint length, uint track, out List failingLbas, out List unknownLbas) { throw new FeatureUnsupportedImageException("Feature not supported by image format"); } public bool? VerifyMediaImage() { return null; } public List DumpHardware => null; public CICMMetadataType CicmMetadata => null; enum DiskType : byte { D2 = 0x00, Dd2 = 0x10, Hd2 = 0x20 } enum DensityType : byte { Mfm = 0x00, Fm = 0x40 } /// /// Status as returned by PC-98 BIOS /// ステータスは、PC-98x1 のBIOS が返してくるステータスで、 /// enum StatusType : byte { /// /// Normal /// 正常 /// Normal = 0x00, /// /// Deleted /// 正常(DELETED DATA) /// Deleted = 0x10, /// /// CRC error in address fields /// ID CRC エラー /// IdError = 0xA0, /// /// CRC error in data block /// データ CRC エラー /// DataError = 0xB0, /// /// Address mark not found /// アドレスマークなし /// AddressMarkNotFound = 0xE0, /// /// Data mark not found /// データマークなし /// DataMarkNotFound = 0xF0 } [StructLayout(LayoutKind.Sequential, Pack = 1)] struct D88Header { /// /// Disk name, nul-terminated ASCII /// ディスクの名前(ASCII + '\0') /// [MarshalAs(UnmanagedType.ByValArray, SizeConst = 17)] public byte[] name; /// /// Reserved /// ディスクの名前(ASCII + '\0') /// [MarshalAs(UnmanagedType.ByValArray, SizeConst = 9)] public byte[] reserved; /// /// Write protect status /// ライトプロテクト: 0x00 なし、0x10 あり /// public byte write_protect; /// /// Disk type /// ディスクの種類: 0x00 2D、 0x10 2DD、 0x20 2HD /// public DiskType disk_type; /// /// Disk image size /// ディスクのサイズ /// public int disk_size; /// /// Track pointers /// トラック部のオフセットテーブル 0 Track ~ 163 Track /// [MarshalAs(UnmanagedType.ByValArray, SizeConst = 164)] public int[] track_table; } [StructLayout(LayoutKind.Sequential, Pack = 1)] struct SectorHeader { /// /// Cylinder /// ID の C /// public byte c; /// /// Head /// ID の H /// public byte h; /// /// Sector number /// ID の R /// public byte r; /// /// Sector size /// ID の N /// public IBMSectorSizeCode n; /// /// Number of sectors in this track /// このトラック内に存在するセクタの数 /// public short spt; /// /// Density: 0x00 MFM, 0x40 FM /// 記録密度: 0x00 倍密度、0x40 単密度 /// public DensityType density; /// /// Deleted sector, 0x00 not deleted, 0x10 deleted /// DELETED MARK: 0x00 ノーマル、 0x10 DELETED /// public byte deleted_mark; /// /// Sector status /// ステータス /// public byte status; /// /// Reserved /// リザーブ /// [MarshalAs(UnmanagedType.ByValArray, SizeConst = 5)] public byte[] reserved; /// /// Size of data following this field /// このセクタ部のデータサイズ /// public short size_of_data; } } }