diff --git a/src/flash-multi.iss b/src/flash-multi.iss index d015213..84046d8 100644 --- a/src/flash-multi.iss +++ b/src/flash-multi.iss @@ -12,6 +12,7 @@ OutputDir=flash-multi\bin OutputBaseFilename=flash-multi-{#MyAppVersion} InfoAfterFile=.\installer_infoafter.txt DisableWelcomePage=no +LicenseFile=flash-multi\license.txt [Files] Source: "flash-multi\bin\Release\*"; Excludes: "*.pdb"; Flags: replacesameversion promptifolder recursesubdirs; DestDir: {app}; Components: main @@ -24,7 +25,7 @@ Name: "{group}\Flash Multi"; Filename: "{app}\flash-multi.exe"; IconFilename: "{ [Components] Name: "main"; Description: "Flash Multi Application"; Types: full compact custom; Flags: fixed -Name: "drivers"; Description: "Maple USB Drivers"; Types: full +Name: "drivers"; Description: "Run Maple USB Driver Installer"; Types: full [Run] ; Install the drivers - https://github.com/pbatard/libwdi/blob/master/examples/wdi-simple.iss diff --git a/src/flash-multi/ComPort.cs b/src/flash-multi/ComPort.cs new file mode 100644 index 0000000..c3b4748 --- /dev/null +++ b/src/flash-multi/ComPort.cs @@ -0,0 +1,217 @@ +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +namespace Flash_Multi +{ + using System; + using System.Collections.Generic; + using System.Diagnostics; + using System.IO.Ports; + using System.Linq; + using System.Management; + using System.Threading; + + /// + /// Class for dealing with COM ports. + /// + internal class ComPort + { + /// + /// Gets the name of the port. + /// + public string Name { get; private set; } + + /// + /// Gets the description of the port. + /// + public string Description { get; private set; } + + /// + /// Gets the displayname of the port (name + description). + /// + public string DisplayName { get; private set; } + + /// + /// Enumerates the available COM ports. + /// + /// Returns an ordered array of COM port names. + public static string[] EnumeratePorts() + { + // Get the list of COM port names + List comPorts = SerialPort.GetPortNames().ToList(); + + // Sort the list of ports + comPorts = comPorts.OrderBy(c => c.Length).ThenBy(c => c).ToList(); + + // Check if we there's a Maple device plugged in + if (MapleDevice.FindMaple().DeviceFound) + { + comPorts.Add("DFU Device"); + } + + // Return an array of COM port names + return comPorts.ToArray(); + } + + /// + /// Enumerates the available COM ports without using WMI. + /// + /// Returns an ordered list of ports . + public static List EnumeratePortList() + { + DateTime start = DateTime.Now; + Debug.WriteLine("Enumerating COM ports"); + + List comPorts = new List(); + + // Get all the COM ports + string[] comPortNames = SerialPort.GetPortNames(); + + // Add all available to the list + foreach (string portName in comPortNames) + { + ComPort thisPort = new ComPort + { + Name = portName, + Description = portName, + DisplayName = portName, + }; + comPorts.Add(thisPort); + } + + // Sort the list of ports + comPorts = comPorts.OrderBy(c => c.Name.Length).ThenBy(c => c.Name).ToList(); + + // Check if we there's a Maple device in DFU mode plugged in + if (MapleDevice.FindMaple().DfuMode) + { + ComPort dfuPort = new ComPort + { + Name = "DFU Device", + Description = "DFU Device", + DisplayName = "DFU Device", + }; + comPorts.Add(dfuPort); + } + + DateTime end = DateTime.Now; + Debug.WriteLine($"COM ports enumerated in {end - start}."); + + // Return a list of COM ports + return comPorts; + } + + /// + /// Enumerates the available COM ports using WMI, including the device description. + /// + /// Returns an ordered list of ports . + public static List EnumeratePortList2() + { + List comPorts = new List(); + + // Get all the COM ports using WMI + using (ManagementObjectSearcher searcher = new ManagementObjectSearcher( + "root\\cimv2", + "SELECT * FROM Win32_PnPEntity WHERE ClassGuid=\"{4d36e978-e325-11ce-bfc1-08002be10318}\"")) + { + // Add all available ports to the list + foreach (ManagementObject queryObj in searcher.Get()) + { + string portCaption = queryObj["Caption"].ToString(); + + if (portCaption.Contains("(COM")) + { + // Get the index number where "(COM" starts in the string + int indexOfCom = portCaption.IndexOf("(COM"); + string portName = portCaption.Substring(indexOfCom + 1, portCaption.Length - indexOfCom - 2); + string portDescription = portCaption.Substring(0, indexOfCom - 1); + + ComPort thisPort = new ComPort + { + Name = portName, + Description = portDescription, + DisplayName = $"{portName} ({portDescription})", + }; + + comPorts.Add(thisPort); + } + } + } + + // Sort the list of ports + comPorts = comPorts.OrderBy(c => c.Name.Length).ThenBy(c => c.Name).ToList(); + + // Check if we there's a Maple device in DFU mode plugged in + if (MapleDevice.FindMaple().DfuMode) + { + ComPort dfuPort = new ComPort + { + Name = "DFU Device", + Description = "Maple DFU Device", + DisplayName = "DFU Device", + }; + comPorts.Add(dfuPort); + } + + // Return a list of COM ports + return comPorts; + } + + /// + /// Checks if the COM port can be opened. + /// + /// /// The name of the port to check. + /// + /// Boolean indicating whether the port could be opened. + /// + public static bool CheckPort(string port) + { + // Skip the check and return true if the selected port is 'DFU Device' + if (port == "DFU Device") + { + return true; + } + + bool result = false; + + // Try to open the serial port, catch an exception if we fail + SerialPort serialPort = new SerialPort(port); + try + { + serialPort.Open(); + if (serialPort.IsOpen) + { + result = true; + } + } + catch (Exception ex) + { + Debug.WriteLine(ex.Message); + } + finally + { + Thread.Sleep(50); + serialPort.Close(); + } + + return result; + } + } +} diff --git a/src/flash-multi/FlashMulti.Designer.cs b/src/flash-multi/FlashMulti.Designer.cs index c4f819e..cba1fd4 100644 --- a/src/flash-multi/FlashMulti.Designer.cs +++ b/src/flash-multi/FlashMulti.Designer.cs @@ -1,4 +1,24 @@ -namespace flash_multi +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +namespace Flash_Multi { partial class FlashMulti { @@ -52,7 +72,7 @@ private void InitializeComponent() // // buttonUpload // - this.buttonUpload.Location = new System.Drawing.Point(373, 71); + this.buttonUpload.Location = new System.Drawing.Point(373, 76); this.buttonUpload.Name = "buttonUpload"; this.buttonUpload.Size = new System.Drawing.Size(75, 23); this.buttonUpload.TabIndex = 6; @@ -64,10 +84,11 @@ private void InitializeComponent() // comPortSelector // this.comPortSelector.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList; + this.comPortSelector.DropDownWidth = 90; this.comPortSelector.FormattingEnabled = true; this.comPortSelector.Location = new System.Drawing.Point(101, 48); this.comPortSelector.Name = "comPortSelector"; - this.comPortSelector.Size = new System.Drawing.Size(98, 21); + this.comPortSelector.Size = new System.Drawing.Size(90, 21); this.comPortSelector.TabIndex = 2; this.comPortSelector.SelectedIndexChanged += new System.EventHandler(this.ComPortSelector_SelectionChanged); // @@ -99,7 +120,7 @@ private void InitializeComponent() // // buttonBrowse // - this.buttonBrowse.Location = new System.Drawing.Point(373, 19); + this.buttonBrowse.Location = new System.Drawing.Point(373, 18); this.buttonBrowse.Name = "buttonBrowse"; this.buttonBrowse.Size = new System.Drawing.Size(75, 23); this.buttonBrowse.TabIndex = 1; @@ -161,7 +182,7 @@ private void InitializeComponent() // // buttonRefresh // - this.buttonRefresh.Location = new System.Drawing.Point(205, 47); + this.buttonRefresh.Location = new System.Drawing.Point(197, 47); this.buttonRefresh.Name = "buttonRefresh"; this.buttonRefresh.Size = new System.Drawing.Size(75, 23); this.buttonRefresh.TabIndex = 3; @@ -288,12 +309,12 @@ private void InitializeComponent() private System.Windows.Forms.CheckBox showVerboseOutput; private System.Windows.Forms.ProgressBar progressBar1; private System.Windows.Forms.TextBox textActivity; - private System.Windows.Forms.Button buttonRefresh; private System.Windows.Forms.LinkLabel linkLabel1; private System.Windows.Forms.LinkLabel linkLabel2; - private System.Windows.Forms.RadioButton writeBootloader_No; - private System.Windows.Forms.RadioButton writeBootloader_Yes; + internal System.Windows.Forms.RadioButton writeBootloader_No; + internal System.Windows.Forms.RadioButton writeBootloader_Yes; private System.Windows.Forms.Label label1; + private System.Windows.Forms.Button buttonRefresh; } } diff --git a/src/flash-multi/FlashMulti.cs b/src/flash-multi/FlashMulti.cs index f247cd5..68f6044 100644 --- a/src/flash-multi/FlashMulti.cs +++ b/src/flash-multi/FlashMulti.cs @@ -1,526 +1,420 @@ -using System; -using System.Diagnostics; -using System.IO.Ports; -using System.Windows.Forms; -using System.Threading; -using System.Text.RegularExpressions; -using System.Threading.Tasks; -using System.Runtime.InteropServices; -using System.IO; -using System.Reflection; -using System.Collections.Generic; -using System.Linq; -using System.Net; - -namespace flash_multi +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +namespace Flash_Multi { + using System; + using System.Collections.Generic; + using System.Diagnostics; + using System.IO; + using System.Threading.Tasks; + using System.Windows.Forms; + + /// + /// The FlashMulti Form class. + /// public partial class FlashMulti : Form { - public delegate void InvokeDelegate(); - /// - /// The main FlashMulti method. + /// Initializes a new instance of the class. /// public FlashMulti() { - InitializeComponent(); + this.InitializeComponent(); // Include the version in the window title - this.Text = String.Format("Flash Multi v{0}", Application.ProductVersion); + this.Text = string.Format("Flash Multi v{0}", Application.ProductVersion); // Set focus away from the textbox - this.ActiveControl = linkLabel2; + this.ActiveControl = this.linkLabel2; // Populate the list of serial ports - PopulateComPorts(); + this.PopulateComPorts(); // Disable the Upload button until we're ready - buttonUpload.Enabled = false; + this.buttonUpload.Enabled = false; // Register a hendler to check for a new version when the form is shown the first time - Shown += FlashMulti_Shown; - } + this.Shown += this.FlashMulti_Shown; - /// - /// Called when the form has finished loading for the first time. - /// Checks Github for a newer version. - /// - /// - /// - private void FlashMulti_Shown(object sender, EventArgs e) - { - // Check for a new version - UpdateCheck(); + // Resgister a handler to be notified when USB devices are added or removed + UsbNotification.RegisterUsbDeviceNotification(this.Handle); } /// - /// Handle USB device arrival/removal notifications. + /// Delegation method. /// - protected override void WndProc(ref Message m) - { - base.WndProc(ref m); - if (m.Msg == UsbNotification.WmDevicechange) - { - switch ((int)m.WParam) - { - case UsbNotification.DbtDeviceremovecomplete: - BeginInvoke(new InvokeDelegate(PopulateComPorts)); - break; - case UsbNotification.DbtDevicearrival: - BeginInvoke(new InvokeDelegate(PopulateComPorts)); - break; - } - } - } + public delegate void InvokeDelegate(); /// - /// Checks if the Upload button should be enabled or not. - /// Called by changes to the file name or COM port selector + /// Handles the standard and error output from a running command. + /// Updates the verbose output text box. /// - private void CheckControls() + /// The process sending the output. + /// The data from the event. + public void OutputHandler(object sendingProcess, DataReceivedEventArgs eventArgs) { - if (textFileName.Text != "" && comPortSelector.SelectedItem != null && (writeBootloader_No.Checked || writeBootloader_Yes.Checked)) - { - buttonUpload.Enabled = true; - } - else - { - buttonUpload.Enabled = false; - } + // Append to the verbose log box + this.AppendVerbose(eventArgs.Data); + Debug.WriteLine(eventArgs.Data); } /// - /// Checks if the COM port can be opened. + /// Appends a string to the verbose output text box. /// - /// - /// Boolean indicating whether the port could be opened. - /// - private bool PortCheck(string port) + /// String to append. + public void AppendVerbose(string text) { - // Skip the check and return true if the selected port is 'DFU Device' - if (port == "DFU Device") - { - return true; - } - - bool result = false; - - // Try to open the serial port, catch an exception if fail - SerialPort serialPort = new SerialPort(port); - try - { - serialPort.Open(); - if (serialPort.IsOpen) - { - result = true; - } - } - catch (Exception ex) - { - Debug.WriteLine(ex.Message); - } - finally + // Check if we're called from another thread + if (this.InvokeRequired) { - Thread.Sleep(50); - serialPort.Close(); + this.Invoke(new Action(this.AppendVerbose), new object[] { text }); + return; } - return result; + // Append the text + this.textVerbose.AppendText(text + "\r\n"); } /// - /// Populates the list of COM ports. + /// Appends a string to the output text box. /// - private void PopulateComPorts() + /// String to append. + public void AppendLog(string text) { - // Cache the selected item so we can try to re-select it later - object selectedItem = null; - selectedItem = comPortSelector.SelectedItem; - - // Get the list of COM port names - string[] comPorts = SerialPort.GetPortNames(); - - // Sort the list of ports - var orderedComPorts = comPorts.OrderBy(c => c.Length).ThenBy(c => c).ToList(); - - // Clear the existing list - comPortSelector.Items.Clear(); - - // Add the ports one by one - foreach (string port in orderedComPorts) - { - comPortSelector.Items.Add(port); - } - - // Short pause to give a DFU device time to show up - Thread.Sleep(50); - - // Check if we there's a Maple device plugged in - MapleTools.FindMapleResult mapleCheck = MapleTools.FindMaple(); - - if (mapleCheck.MapleFound) - { - // Set the Write Bootloader radio button and disable the controls if a Maple device is present - // Required so that the firmware size is calculated correctly - writeBootloader_Yes.Checked = true; - writeBootloader_Yes.Enabled = false; - writeBootloader_No.Enabled = false; - - // If the Maple device is in DFU mode add a DFU device to the list - // Required in case there are no other serial devices present as the user need to select something from the list - if (mapleCheck.Device.DfuMode) - { - comPortSelector.Items.Add("DFU Device"); - } - } else + // Check if we're called from another thread + if (this.InvokeRequired) { - writeBootloader_Yes.Enabled = true; - writeBootloader_No.Enabled = true; + this.Invoke(new Action(this.AppendLog), new object[] { text }); + return; } - // Re-select the previously selected item - comPortSelector.SelectedItem = selectedItem; - - // Make sure the Update button is disabled if there is no port selected - CheckControls(); + // Append the text + this.textActivity.AppendText(text); } /// - /// Main method where all the action happens. - /// Called by the Upload button. + /// Enable or disable the controls. /// - private void ButtonUpload_Click(object sender, EventArgs e) + /// True to enable, False to disable. + public void EnableControls(bool arg) { - // Clear the output box - Debug.WriteLine("Clearing the output textboxes..."); - textActivity.Clear(); - textVerbose.Clear(); - progressBar1.Value = 0; - - // Check if the file exists - if (! File.Exists(textFileName.Text)) - { - AppendLog(String.Format("File {0} does not exist", textFileName.Text)); - MessageBox.Show("Firmware file does not exist.", "Write Firmware", MessageBoxButtons.OK, MessageBoxIcon.Error); - EnableControls(true); - return; - } - - // Check that the file size is OK - // Max size is 120,832B (118KB) with bootloader, 129,024B (126KB) without - int maxFileSize = 129024; - if (writeBootloader_Yes.Checked) + // Enable the buttons + if (arg) { - maxFileSize = 120832; + Debug.WriteLine("Re-enabling the controls..."); } - - long length = new System.IO.FileInfo(textFileName.Text).Length; - - if (length > maxFileSize) + else { - AppendLog(String.Format("Firmware file is too large.\r\nFile is {1:n0} KB, maximum size is {2:n0} KB.", textFileName.Text, length/1024, maxFileSize/1024)); - MessageBox.Show("Firmware file is too large.", "Write Firmware", MessageBoxButtons.OK, MessageBoxIcon.Error); - EnableControls(true); - return; + Debug.WriteLine("Disabling the controls..."); } - // Get the selected COM port - string comPort = comPortSelector.SelectedItem.ToString(); - - // Check if the port can be opened - if (!PortCheck(comPort)) + if (arg) { - AppendLog(String.Format("Couldn't open port {0}", comPort)); - MessageBox.Show(String.Format("Couldn't open port {0}", comPort), "Write Firmware", MessageBoxButtons.OK, MessageBoxIcon.Error); - EnableControls(true); - return; + // Populate the COM ports + this.PopulateComPortsAsync(); } - // Disable the buttons until this flash attempt is complete - Debug.WriteLine("Disabling the controls..."); - EnableControls(false); + // Check if there is a Maple device attached + MapleDevice mapleCheck = MapleDevice.FindMaple(); - // Determine if we should use Maple or serial interface - MapleTools.FindMapleResult mapleResult = MapleTools.FindMaple(); + // Toggle the controls + this.buttonUpload.Enabled = arg; + this.buttonBrowse.Enabled = arg; + this.buttonRefresh.Enabled = arg; + this.textFileName.Enabled = arg; + this.comPortSelector.Enabled = arg; - if (mapleResult.MapleFound == true) + // Keep the Write Bootloader controls disabled if a Maple device is plugged in. + if (mapleCheck.DeviceFound) { - AppendLog(String.Format("Maple device found in {0} mode\r\n", mapleResult.Device.Mode)); + this.writeBootloader_Yes.Checked = true; + this.writeBootloader_Yes.Enabled = false; + this.writeBootloader_No.Enabled = false; } - - // Do the selected flash using the appropriate method - if (mapleResult.MapleFound == true) + else { - MapleFlashWrite(textFileName.Text, comPort); + this.writeBootloader_Yes.Enabled = arg; + this.writeBootloader_No.Enabled = arg; } - else + + // Check a couple of things if we're re-enabling + if (arg) { - SerialFlashWrite(textFileName.Text, comPort); + // Check if the Upload button can be enabled + this.CheckControls(); } } /// - /// Enable or disable the controls. + /// Opens a URL in the default browser. /// - private void EnableControls(bool arg) + /// The URL to open. + public void OpenLink(string url) { - // Enable the buttons - if (arg) + try { - Debug.WriteLine("Re-enabling the controls..."); + System.Diagnostics.Process.Start(url); } - else + catch (Exception ex) { - Debug.WriteLine("Disabling the controls..."); + Debug.WriteLine(ex.Message); } + } - // Toggle the controls - buttonUpload.Enabled = arg; - buttonBrowse.Enabled = arg; - buttonRefresh.Enabled = arg; - textFileName.Enabled = arg; - comPortSelector.Enabled = arg; - writeBootloader_Yes.Enabled = arg; - writeBootloader_No.Enabled = arg; - - // Check a couple of things if we're re-enabling - if (arg) + /// + /// Re-populate the COM port list when a USB device is plugged or unplugged. + /// + /// The message. + protected override void WndProc(ref Message m) + { + base.WndProc(ref m); + if (m.Msg == UsbNotification.WmDevicechange) { - // Keep the Write Bootloader controls disabled if a Maple device is plugged in. - if (MapleTools.FindMaple().MapleFound) + switch ((int)m.WParam) { - writeBootloader_Yes.Checked = true; - writeBootloader_Yes.Enabled = false; - writeBootloader_No.Enabled = false; + case UsbNotification.DbtDeviceremovecomplete: + // Update the COM port list + this.BeginInvoke(new InvokeDelegate(this.PopulateComPortsAsync)); + break; + case UsbNotification.DbtDevicearrival: + // Update the COM port list + this.BeginInvoke(new InvokeDelegate(this.PopulateComPortsAsync)); + break; } - - // Check if the Upload button can be enabled - CheckControls(); } } /// - /// Writes the firmware to a Maple serial or DFU device + /// Override method to handle the application closing. + /// Unregisters device change notifications. /// - private async void MapleFlashWrite(string fileName, string comPort) + /// The event. + protected override void OnFormClosing(FormClosingEventArgs e) { - string command; - string commandArgs; - int returnCode = -1; + // Call the base method + base.OnFormClosing(e); - AppendLog("Starting Multimodule update\r\n"); + // Unregister for USB notifications + UsbNotification.UnregisterUsbDeviceNotification(); + } - string mapleMode = MapleTools.FindMaple().Device.Mode; + /// + /// Called when the form has finished loading for the first time. + /// Checks Github for a newer version. + /// + /// Event sender. + /// Event data. + private void FlashMulti_Shown(object sender, EventArgs e) + { + // Check for a new version + UpdateCheck.DoCheck(this); + } - if (mapleMode == "USB") + /// + /// Checks if the Upload button should be enabled or not. + /// Called by changes to the file name, COM port selector, or bootloader radio buttons. + /// + private void CheckControls() + { + if (this.textFileName.Text != string.Empty && this.comPortSelector.SelectedItem != null && (this.writeBootloader_No.Checked || this.writeBootloader_Yes.Checked)) { - AppendLog("Switching Multimodule into DFU mode ..."); - command = ".\\tools\\maple-reset.exe"; - commandArgs = comPort; - await Task.Run(() => { returnCode = RunCommand(command, commandArgs); }); - if (returnCode != 0) - { - EnableControls(true); - AppendLog(" failed!"); - MessageBox.Show("Failed to get module to DFU mode.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); - return; - } - AppendLog(" done\r\n"); - - // Check for a Maple DFU device - AppendLog("Waiting for DFU device ..."); - bool dfuCheck = false; - int counter = 0; - - dfuCheck = MapleTools.FindMaple().Device.DfuMode; - - while (dfuCheck == false && counter < 20) - { - Thread.Sleep(50); - dfuCheck = MapleTools.FindMaple().Device.DfuMode; - counter++; - } - - if (dfuCheck) - { - AppendLog(" got it\r\n"); - } - else - { - AppendLog(" failed!"); - MessageBox.Show("Failed to find module in DFU mode.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); - EnableControls(true); - return; - } + this.buttonUpload.Enabled = true; } - - // Flash firmware - AppendLog("Writing firmware to Multimodule ..."); - command = ".\\tools\\dfu-util.exe"; - commandArgs = String.Format("-R -a 2 -d 1EAF:0003 -D \"{0}\"", fileName, comPort); - await Task.Run(() => { returnCode = RunCommand(command, commandArgs); }); - if (returnCode != 0) + else { - EnableControls(true); - AppendLog(" failed!"); - MessageBox.Show("Failed to write the firmware.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); - return; + this.buttonUpload.Enabled = false; } - AppendLog(" done\r\n"); - - AppendLog("\r\nMultimodule updated sucessfully"); + } - MessageBox.Show("Multimodule updated sucessfully.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Information); - EnableControls(true); + private async void PopulateComPortsAsync() + { + await Task.Run(() => { this.PopulateComPorts(); }); } /// - /// Writes the firmware to a serial (FTDI) device. + /// Populates the list of COM ports. /// - private async void SerialFlashWrite(string fileName, string comPort) + private void PopulateComPorts() { - string command = ".\\tools\\stm32flash.exe"; - string bootLoaderPath = ".\\bootloaders\\StmMulti4in1.bin"; - string commandArgs; - - int returnCode = -1; - int flashStep = 1; - int flashSteps = 2; - - int flashStart = 0; - string executionAddress = "0x8000000"; - - if (writeBootloader_Yes.Checked) + if (this.InvokeRequired) { - flashSteps = 3; + this.Invoke(new Action(this.PopulateComPorts)); + return; } - AppendLog("Starting Multimodule update\r\n"); - - // Erase - AppendLog($"[{flashStep}/{flashSteps}] Erasing flash memory..."); - commandArgs = String.Format("-o -S 0x8000000:129024 -b 115200 {0}", comPort); - await Task.Run(() => { returnCode = RunCommand(command, commandArgs); }); - if (returnCode != 0) + // Don't refresh if the control is not enabled + if (!this.comPortSelector.Enabled) { - EnableControls(true); - AppendLog(" failed!"); - MessageBox.Show("Failed to erase flash memory.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); return; } - AppendLog(" done\r\n"); - if (writeBootloader_Yes.Checked) + // Get the current list from the combobox so we can auto-select the new device + var oldPortList = this.comPortSelector.Items; + + // Cache the selected item so we can try to re-select it later + object selectedValue = null; + selectedValue = this.comPortSelector.SelectedValue; + + // Enumerate the COM ports and bind the COM port selector + List comPorts = new List(); + comPorts = ComPort.EnumeratePortList(); + + // Check if we have a Maple device + MapleDevice mapleCheck = MapleDevice.FindMaple(); + + this.comPortSelector.DataSource = comPorts; + this.comPortSelector.DisplayMember = "Name"; + this.comPortSelector.ValueMember = "Name"; + + // If we had an old list, compare it to the new one and pick the first item which is new + if (oldPortList.Count > 0) { - // Flash bootloader - flashStep ++; - AppendLog($"[{flashStep}/{flashSteps}] Writing bootloader..."); - commandArgs = $"-v -e 0 -g {executionAddress} -b 115200 -w \"{bootLoaderPath}\" {comPort}"; - await Task.Run(() => { returnCode = RunCommand(command, commandArgs); }); - if (returnCode != 0) + foreach (ComPort newPort in comPorts) { - EnableControls(true); - AppendLog(" failed!"); - MessageBox.Show("Failed to write the bootloader.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); - return; - } - AppendLog(" done\r\n"); + bool found = false; + foreach (ComPort oldPort in oldPortList) + { + if (newPort.Name == oldPort.Name) + { + found = true; + } + } - // Set the flash address for a flash with bootloader - flashStart = 8; - executionAddress = "0x8002000"; + if (found == false) + { + Debug.WriteLine($"{newPort.Name} was added."); + selectedValue = newPort.Name; + } + } } - // Flash firmware - flashStep++; - AppendLog($"[{flashStep}/{flashSteps}] Writing Multimodule firmware..."); - commandArgs = $"-v -s {flashStart} -e 0 -g {executionAddress} -b 115200 -w \"{fileName}\" {comPort}"; - await Task.Run(() => { returnCode = RunCommand(command, commandArgs); }); - if (returnCode != 0) + // Re-select the previously selected item + if (selectedValue != null) { - EnableControls(true); - AppendLog(" failed!"); - MessageBox.Show("Failed to write the firmware.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); - return; + this.comPortSelector.SelectedValue = selectedValue; + } + else + { + this.comPortSelector.SelectedItem = null; } - AppendLog(" done\r\n"); - AppendLog("\r\nMultimodule updated sucessfully"); + // Check if we there's a Maple device plugged in + if (mapleCheck.DeviceFound) + { + // Set the Write Bootloader radio button and disable the controls if a Maple device is present + // Required so that the firmware size is calculated correctly + this.writeBootloader_Yes.Checked = true; + this.writeBootloader_Yes.Enabled = false; + this.writeBootloader_No.Enabled = false; + } + else + { + this.writeBootloader_Yes.Enabled = true; + this.writeBootloader_No.Enabled = true; + } - MessageBox.Show("Multimodule updated sucessfully.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Information); - EnableControls(true); + // Set the width of the dropdown + // this.comPortSelector.DropDownWidth = comPorts.Select(c => c.DisplayName).ToList().Max(x => TextRenderer.MeasureText(x, this.comPortSelector.Font).Width); + // Make sure the Update button is disabled if there is no port selected + this.CheckControls(); } /// - /// Runs a command with arguments + /// Main method where all the action happens. + /// Called by the Upload button. /// - private int RunCommand(string command, string args) + private void ButtonUpload_Click(object sender, EventArgs e) { - Debug.WriteLine("\n" + command + " " + args + "\n"); - AppendVerbose(command + " " + args + "\r\n"); + // Clear the output box + Debug.WriteLine("Clearing the output textboxes..."); + this.textActivity.Clear(); + this.textVerbose.Clear(); + this.progressBar1.Value = 0; // Check if the file exists - if (!File.Exists(command)) + if (!File.Exists(this.textFileName.Text)) { - AppendVerbose(String.Format("{0} does not exist", command)); - return -1; + this.AppendLog(string.Format("File {0} does not exist", this.textFileName.Text)); + MessageBox.Show("Firmware file does not exist.", "Write Firmware", MessageBoxButtons.OK, MessageBoxIcon.Error); + this.EnableControls(true); + return; } - Process myProcess = new Process(); + // Check that the file size is OK + // Max size is 120,832B (118KB) with bootloader, 129,024B (126KB) without + int maxFileSize = 129024; + if (this.writeBootloader_Yes.Checked) + { + maxFileSize = 120832; + } - // Process process = new Process(); - myProcess.StartInfo.FileName = command; - myProcess.StartInfo.Arguments = args; - myProcess.StartInfo.UseShellExecute = false; - myProcess.StartInfo.RedirectStandardOutput = true; - myProcess.StartInfo.RedirectStandardError = true; - myProcess.StartInfo.CreateNoWindow = true; + long length = new System.IO.FileInfo(this.textFileName.Text).Length; - //* Set your output and error (asynchronous) handlers - myProcess.OutputDataReceived += new DataReceivedEventHandler(OutputHandler); - myProcess.ErrorDataReceived += new DataReceivedEventHandler(OutputHandler); + if (length > maxFileSize) + { + this.AppendLog(string.Format("Firmware file is too large.\r\nFile is {1:n0} KB, maximum size is {2:n0} KB.", this.textFileName.Text, length / 1024, maxFileSize / 1024)); + MessageBox.Show("Firmware file is too large.", "Write Firmware", MessageBoxButtons.OK, MessageBoxIcon.Error); + this.EnableControls(true); + return; + } - //* Start process and handlers - myProcess.Start(); + // Get the selected COM port + string comPort = this.comPortSelector.SelectedValue.ToString(); - //* Read the output - myProcess.BeginOutputReadLine(); - myProcess.BeginErrorReadLine(); + // Check if the port can be opened + if (!ComPort.CheckPort(comPort)) + { + this.AppendLog(string.Format("Couldn't open port {0}", comPort)); + MessageBox.Show(string.Format("Couldn't open port {0}", comPort), "Write Firmware", MessageBoxButtons.OK, MessageBoxIcon.Error); + this.EnableControls(true); + return; + } - // Loop until the process finishes - myProcess.WaitForExit(); + // Disable the buttons until this flash attempt is complete + Debug.WriteLine("Disabling the controls..."); + this.EnableControls(false); - //* Return the exit code from the process - return myProcess.ExitCode; - } + // Determine if we should use Maple or serial interface + MapleDevice mapleResult = MapleDevice.FindMaple(); - /// - /// Handles the standard and error output from a running command. - /// Updates the verbose output text box. - /// - private void OutputHandler(object sendingProcess, DataReceivedEventArgs outLine) - { - //* Do your stuff with the output - Debug.WriteLine(outLine.Data); - /* - // Update the progress bar if there is a percentage in the output - Regex regex = new Regex(@"\((\d+)\.\d\d\%\)"); - if (outLine.Data != null) - { - Match match = regex.Match(outLine.Data); - if (match.Success) - { - UpdateProgress(int.Parse(match.Groups[1].Value)); - } + if (mapleResult.DeviceFound == true) + { + this.AppendLog(string.Format("Maple device found in {0} mode\r\n", mapleResult.Mode)); } - */ - AppendVerbose(outLine.Data); + // Do the selected flash using the appropriate method + if (mapleResult.DeviceFound == true) + { + // MapleFlashWrite(textFileName.Text, comPort); + MapleDevice.WriteFlash(this, this.textFileName.Text, comPort); + } + else + { + SerialDevice.WriteFlash(this, this.textFileName.Text, comPort); + } } /// - /// Selects a firmware file to flash + /// Selects a firmware file to flash. /// private void ButtonBrowse_Click(object sender, EventArgs e) { @@ -536,22 +430,22 @@ private void ButtonBrowse_Click(object sender, EventArgs e) if (openFileDialog.ShowDialog() == DialogResult.OK) { // Set the text box to the selected file name - textFileName.Text = openFileDialog.FileName; + this.textFileName.Text = openFileDialog.FileName; } } // Check the file name and pre-set the Write Bootloader option - if (textFileName.Text.IndexOf("_FTDI_") > -1) + if (this.textFileName.Text.IndexOf("_FTDI_") > -1) { - writeBootloader_No.Checked = true; + this.writeBootloader_No.Checked = true; } - else if (textFileName.Text.IndexOf("_TXFLASH_") > -1) + else if (this.textFileName.Text.IndexOf("_TXFLASH_") > -1) { - writeBootloader_Yes.Checked = true; + this.writeBootloader_Yes.Checked = true; } // Check if the Upload button should be enabled yet - CheckControls(); + this.CheckControls(); } /// @@ -560,7 +454,7 @@ private void ButtonBrowse_Click(object sender, EventArgs e) private void ComPortSelector_SelectionChanged(object sender, EventArgs e) { // Check if the Upload button should be enabled yet - CheckControls(); + this.CheckControls(); } /// @@ -569,45 +463,13 @@ private void ComPortSelector_SelectionChanged(object sender, EventArgs e) private void TextFileName_OnChange(object sender, EventArgs e) { // Check if the Upload button should be enabled yet - CheckControls(); + this.CheckControls(); } private void WriteBootloader_OnChange(object sender, EventArgs e) { // Check if the Upload button should be enabled yet - CheckControls(); - } - - /// - /// Appends a string to the verbose output text box. - /// - private void AppendVerbose(string text) - { - // Check if we're called from another thread - if (InvokeRequired) - { - this.Invoke(new Action(AppendVerbose), new object[] { text }); - return; - } - - // Append the text - textVerbose.AppendText(text + "\r\n"); - } - - /// - /// Appends a string to the log output text box. - /// - private void AppendLog(string text) - { - // Check if we're called from another thread - if (InvokeRequired) - { - this.Invoke(new Action(AppendLog), new object[] { text }); - return; - } - - // Append the text - textActivity.AppendText(text); + this.CheckControls(); } /// @@ -615,12 +477,13 @@ private void AppendLog(string text) /// private void UpdateProgress(int value) { - if (InvokeRequired) + if (this.InvokeRequired) { - this.Invoke(new Action(UpdateProgress), new object[] { value }); + this.Invoke(new Action(this.UpdateProgress), new object[] { value }); return; } - progressBar1.Value = value; + + this.progressBar1.Value = value; } /// @@ -629,7 +492,7 @@ private void UpdateProgress(int value) /// private void ShowVerboseOutput_OnChange(object sender, EventArgs e) { - if (showVerboseOutput.Checked == true) + if (this.showVerboseOutput.Checked == true) { this.Height = 520; } @@ -645,7 +508,7 @@ private void ShowVerboseOutput_OnChange(object sender, EventArgs e) /// private void ButtonRefresh_Click(object sender, EventArgs e) { - PopulateComPorts(); + this.PopulateComPortsAsync(); } /// @@ -653,22 +516,7 @@ private void ButtonRefresh_Click(object sender, EventArgs e) /// private void RepoLink_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e) { - try - { - VisitGitRepoLink(); - } - catch (Exception ex) - { - Debug.WriteLine(ex.Message); - } - } - - /// - /// Opens the Github repo link in the default browser. - /// - private void VisitGitRepoLink() - { - System.Diagnostics.Process.Start("https://github.com/benlye/flash-multi"); + this.OpenLink("https://github.com/benlye/flash-multi"); } /// @@ -676,172 +524,7 @@ private void VisitGitRepoLink() /// private void ReleasesLink_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e) { - try - { - VisitReleaseLink(); - } - catch (Exception ex) - { - Debug.WriteLine(ex.Message); - } - } - - /// - /// Opens the Multi firmware repo releases link in the default browser. - /// - private void VisitReleaseLink() - { - System.Diagnostics.Process.Start("https://github.com/pascallanger/DIY-Multiprotocol-TX-Module/releases"); - } - - /// - /// Opens a URL in the default browser. - /// - private void OpenLink(string url) - { - System.Diagnostics.Process.Start(url); - } - - /// - /// Compares the latest Github version to the current one and prompts the user to update if necessary. - /// - private void UpdateCheck() - { - // Get check for the latest version on Github - UpdateCheckResult check = GetLatestVersion(); - - // If the check completed successfully - if (check.CheckSuccess) - { - // Get the current version - Version currentVersion = Version.Parse(Application.ProductVersion); - - // Get the version available on Github - Version latestVersion = check.LatestVersion; - - // Check if the current version is older than the latest Github release version - if (currentVersion.CompareTo(latestVersion) == -1) - { - // A newer version is available to show the user a prompt - Debug.WriteLine($"App version is older than latest version: {currentVersion} < {latestVersion}"); - DialogResult showUpdate = MessageBox.Show( - $"A newer version of Flash Multi is available.\n\nYou have v{currentVersion.ToString()} and v{latestVersion.ToString()} is available.\n\nSee the latest release on Github?", - "Flash Multi Update Available", - MessageBoxButtons.YesNo, - MessageBoxIcon.Information - ); - - // Show the Github release page for the new version if the user clicked Yes - if (showUpdate == DialogResult.Yes) - { - try - { - OpenLink(check.ReleaseUrl); - } - catch (Exception ex) - { - Debug.WriteLine(ex.Message); - } - } - } - } - } - - /// - /// Checks Github for the latest release. - /// Returns a boolean indicating if the check succeeds, the latest version number, and the latest release URL. - /// - private UpdateCheckResult GetLatestVersion() - { - // Somewhere to store the results - UpdateCheckResult results = new UpdateCheckResult - { - CheckSuccess = false - }; - - try - { - // The API URL to check for the latest release - // Returns a JSON payload containing all the details of the latest release - string releasesUrl = "https://api.github.com/repos/benlye/flash-multi/releases/latest"; - - // Set TLS1.2, as required by the Github API - System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12; - - // Create the WebRequest - HttpWebRequest webRequest = (HttpWebRequest)WebRequest.Create(releasesUrl); - - // Set the UserAgent, as required by the Github API - webRequest.UserAgent = $"flash-multi-{Application.ProductVersion}"; - - // Disable keepalive so we don't hold a connection open - webRequest.KeepAlive = false; - - // Get the response and read it - using (WebResponse myResponse = webRequest.GetResponse()) - using (StreamReader sr = new StreamReader(myResponse.GetResponseStream(), System.Text.Encoding.UTF8)) - { - // Read all of the output from the StreamReader - string result = sr.ReadToEnd(); - - // Parse the release tag out of the JSON - // This contains the version string - int tagStart = result.IndexOf("\"tag_name\":"); - int tagEnd = result.IndexOf(",", tagStart); - string tagLine = result.Substring(tagStart, tagEnd - tagStart); - string tag = tagLine.Split('"')[3]; - - // Add the release tag to the results - results.LatestVersion = Version.Parse(tag); - - // Parse the release URL out of the JSON - // This is the URL of the Github page containing details of the latest release - int urlStart = result.IndexOf("\"html_url\":"); - int urlEnd = result.IndexOf(",", urlStart); - string urlLine = result.Substring(urlStart, urlEnd - urlStart); - string url = urlLine.Split('"')[3]; - - // Add the release URL to the results - results.ReleaseUrl = url; - } - - // Define a regular expression to test the version number looks how we expect it to - Regex versionRegex = new Regex(@"\d+\.\d+\.\d+"); - - // Check that the URL and version number are as we expect - if (results.ReleaseUrl.StartsWith("https://github.com/benlye/flash-multi/releases/") && versionRegex.Match(results.LatestVersion.ToString()).Success) - { - // All looks good; the check succeeded - results.CheckSuccess = true; - } - - } - catch ( Exception ex) - { - Debug.WriteLine($"Error getting latest version: {ex.Message}"); - } - - // Return the results - return results; + this.OpenLink("https://github.com/pascallanger/DIY-Multiprotocol-TX-Module/releases"); } } - - /// - /// Class to store the results of a Github version check. - /// - public class UpdateCheckResult - { - /// - /// Gets or sets a boolean indicating whether or not the Github version check succeeded. - /// - public bool CheckSuccess { get; set; } - /// - /// Gets or sets a Version containing the version of the latest release. - /// - public Version LatestVersion { get; set; } - /// - /// Gets or sets a string containing the URL of the latest release - /// - public string ReleaseUrl { get; set; } - } } diff --git a/src/flash-multi/MapleDevice.cs b/src/flash-multi/MapleDevice.cs new file mode 100644 index 0000000..6905012 --- /dev/null +++ b/src/flash-multi/MapleDevice.cs @@ -0,0 +1,196 @@ +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +namespace Flash_Multi +{ + using System; + using System.Threading; + using System.Threading.Tasks; + using System.Windows.Forms; + + /// + /// Class for working with Maple USB devices. + /// + internal class MapleDevice + { + /// + /// Initializes a new instance of the class. + /// + /// Indicates if a device was found. + /// The device ID. + /// Indicates if the device is in DFU mode. + /// Indicates if the device is in USB mode. + /// The device mode. + public MapleDevice(bool deviceFound = false, string deviceId = null, bool dfuMode = false, bool usbMode = false, string mode = null) + { + this.DeviceFound = deviceFound; + this.DeviceId = deviceId; + this.DfuMode = dfuMode; + this.UsbMode = usbMode; + this.Mode = mode; + } + + /// + /// Gets a value indicating whether a Maple device was found. + /// + public bool DeviceFound { get; private set; } + + /// + /// Gets a string contaiing the device ID. + /// + public string DeviceId { get; private set; } + + /// + /// Gets a value indicating whether the device is in DFU mode. + /// + public bool DfuMode { get; private set; } + + /// + /// Gets a value indicating whether the device is in USB mode. + /// + public bool UsbMode { get; private set; } + + /// + /// Gets a string indicating the device mode. + /// + public string Mode { get; private set; } + + /// + /// Finds a Maple device in either USB or DFU mode. + /// + /// Returns a . + public static MapleDevice FindMaple() + { + MapleDevice result = new MapleDevice(false); + + var usbDevices = UsbDeviceInfo.GetUSBDevices(); + + foreach (var usbDevice in usbDevices) + { + switch (usbDevice.PnpDeviceID.Substring(0, 21)) + { + case "USB\\VID_1EAF&PID_0003": + result = new MapleDevice(true, "USB\\VID_1EAF&PID_0003", true, false, "DFU"); + break; + case "USB\\VID_1EAF&PID_0004": + result = new MapleDevice(true, "USB\\VID_1EAF&PID_0004", false, true, "USB"); + break; + default: + break; + } + } + + return result; + } + + /// + /// Waits for a Maple DFU device to be present. + /// + /// Timeout in milliseconds. + /// Boolean indicating whether or not a DFU device appeared within the timeout. + public static bool WaitForDFU(int timeout = 500) + { + DateTime start = DateTime.Now; + bool dfuCheck = MapleDevice.FindMaple().DfuMode; + + double elapsedMs = (DateTime.Now - start).TotalMilliseconds; + + while (dfuCheck == false && elapsedMs < timeout) + { + Thread.Sleep(50); + dfuCheck = MapleDevice.FindMaple().DfuMode; + elapsedMs = (DateTime.Now - start).TotalMilliseconds; + } + + return true; + } + + /// + /// Writes the firmware to a Maple serial or DFU device. + /// + /// An instance of the class. + /// The path of the file to flash. + /// The COM port where the Maple USB device can be found. + public static async void WriteFlash(FlashMulti flashMulti, string fileName, string comPort) + { + string command; + string commandArgs; + int returnCode = -1; + + flashMulti.AppendLog("Starting Multimodule update\r\n"); + + string mapleMode = MapleDevice.FindMaple().Mode; + + if (mapleMode == "USB") + { + flashMulti.AppendLog("Switching Multimodule into DFU mode ..."); + command = ".\\tools\\maple-reset.exe"; + commandArgs = comPort; + await Task.Run(() => { returnCode = RunCommand.Run(flashMulti, command, commandArgs); }); + if (returnCode != 0) + { + flashMulti.EnableControls(true); + flashMulti.AppendLog(" failed!"); + MessageBox.Show("Failed to get module to DFU mode.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); + return; + } + + flashMulti.AppendLog(" done\r\n"); + + // Check for a Maple DFU device + flashMulti.AppendLog("Waiting for DFU device ..."); + bool dfuCheck = false; + + await Task.Run(() => { dfuCheck = WaitForDFU(1000); }); + + if (dfuCheck) + { + flashMulti.AppendLog(" got it\r\n"); + } + else + { + flashMulti.AppendLog(" failed!"); + MessageBox.Show("Failed to find module in DFU mode.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); + flashMulti.EnableControls(true); + return; + } + } + + // Flash firmware + flashMulti.AppendLog("Writing firmware to Multimodule ..."); + command = ".\\tools\\dfu-util.exe"; + commandArgs = string.Format("-R -a 2 -d 1EAF:0003 -D \"{0}\"", fileName, comPort); + await Task.Run(() => { returnCode = RunCommand.Run(flashMulti, command, commandArgs); }); + if (returnCode != 0) + { + flashMulti.EnableControls(true); + flashMulti.AppendLog(" failed!"); + MessageBox.Show("Failed to write the firmware.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); + return; + } + + flashMulti.AppendLog(" done\r\n"); + flashMulti.AppendLog("\r\nMultimodule updated sucessfully"); + + MessageBox.Show("Multimodule updated sucessfully.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Information); + flashMulti.EnableControls(true); + } + } +} diff --git a/src/flash-multi/MapleTools.cs b/src/flash-multi/MapleTools.cs deleted file mode 100644 index b931cf3..0000000 --- a/src/flash-multi/MapleTools.cs +++ /dev/null @@ -1,154 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Management; -using System.IO.Ports; -using System.Threading; -using System.Diagnostics; - -namespace flash_multi -{ - class MapleTools - { - /* - public static void ResetMaple(string port) - { - Debug.WriteLine(String.Format("Resetting Maple on {0}", port)); - // Create a new SerialPort object with default settings. - SerialPort serialPort = new SerialPort(port); - serialPort.BaudRate = 9600; - serialPort.DataBits = 8; - serialPort.Parity = Parity.None; - serialPort.StopBits = StopBits.One; - serialPort.Encoding = System.Text.Encoding.ASCII; - //serialPort.Handshake = Handshake.RequestToSend; - - //serialPort.RtsEnable = true; - serialPort.DtrEnable = false; - - // Open the serial port - serialPort.Open(); - if (serialPort.IsOpen) - { - Debug.WriteLine("Serial port is open"); - - } else - { - Debug.WriteLine("Serial port is not open."); - } - - Debug.WriteLine("Setting DTR to true"); - serialPort.DtrEnable = true; - - Debug.WriteLine("Setting DTR to False"); - serialPort.DtrEnable = false; - - Thread.Sleep(50); - Debug.WriteLine(String.Format("Sending '1EAF' to {0}", port)); - //var bytes = new byte[] { 0x31, 0x45, 0x41, 0x46 }; - //serialPort.Write(bytes,0,4); - - //serialPort.NewLine = "\0"; - serialPort.Write("1EAF"); - - Debug.WriteLine("Closing port"); - serialPort.Close(); - - } - */ - - - - public static FindMapleResult FindMaple() - { - FindMapleResult result = new FindMapleResult(); - MapleDevice device = new MapleDevice(); - - var usbDevices = GetUSBDevices(); - - foreach (var usbDevice in usbDevices) - { - switch (usbDevice.PnpDeviceID.Substring(0, 21)) - { - case "USB\\VID_1EAF&PID_0003": - result.MapleFound = true; - device.Mode = "DFU"; - device.DfuMode = true; - device.UsbMode = false; - device.DeviceId = "USB\\VID_1EAF&PID_0003"; - break; - case "USB\\VID_1EAF&PID_0004": - result.MapleFound = true; - device.Mode = "USB"; - device.DfuMode = false; - device.UsbMode = true; - device.DeviceId = "USB\\VID_1EAF&PID_0004"; - break; - default: - break; - } - } - - result.Device = device; - - return result; - } - - public class FindMapleResult - { - public bool MapleFound { get; set; } - public MapleDevice Device { get; set; } - } - - public class MapleDevice - { - public string DeviceId { get; set; } - public bool DfuMode { get; set; } - public bool UsbMode { get; set; } - public string Mode { get; set; } - } - - static List GetUSBDevices() - { - List devices = new List(); - - ManagementObjectCollection collection; - using (var searcher = new ManagementObjectSearcher(@"Select * From Win32_PnPEntity WHERE DeviceID like '%VID_1EAF&%'")) - collection = searcher.Get(); - - foreach (var device in collection) - { - devices.Add(new USBDeviceInfo( - (string)device.GetPropertyValue("DeviceID"), - (string)device.GetPropertyValue("PNPDeviceID"), - (string)device.GetPropertyValue("Description"), - (string)device.GetPropertyValue("Manufacturer"), - (string)device.GetPropertyValue("Name"), - (string)device.GetPropertyValue("Status") - - )); - } - - collection.Dispose(); - return devices; - } - } - - class USBDeviceInfo - { - public USBDeviceInfo(string deviceID, string pnpDeviceID, string description, string manufacturer, string name, string status) - { - this.DeviceID = deviceID; - this.PnpDeviceID = pnpDeviceID; - this.Description = description; - this.Manufacturer = manufacturer; - this.Name = name; - this.Status = status; - } - public string DeviceID { get; private set; } - public string PnpDeviceID { get; private set; } - public string Description { get; private set; } - public string Manufacturer { get; private set; } - public string Name { get; private set; } - public string Status { get; private set; } - } -} diff --git a/src/flash-multi/Program.cs b/src/flash-multi/Program.cs index 5637ef3..ebcf352 100644 --- a/src/flash-multi/Program.cs +++ b/src/flash-multi/Program.cs @@ -1,17 +1,38 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Windows.Forms; +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- -namespace flash_multi +namespace Flash_Multi { - static class Program + using System; + using System.Windows.Forms; + + /// + /// The main class. + /// + public static class Program { /// /// The main entry point for the application. /// [STAThread] - static void Main() + private static void Main() { Application.EnableVisualStyles(); Application.SetCompatibleTextRenderingDefault(false); diff --git a/src/flash-multi/Properties/AssemblyInfo.cs b/src/flash-multi/Properties/AssemblyInfo.cs index a58e711..b145baf 100644 --- a/src/flash-multi/Properties/AssemblyInfo.cs +++ b/src/flash-multi/Properties/AssemblyInfo.cs @@ -1,5 +1,24 @@ -using System.Reflection; -using System.Runtime.CompilerServices; +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +using System.Reflection; using System.Runtime.InteropServices; // General Information about an assembly is controlled through the following diff --git a/src/flash-multi/Properties/Resources.Designer.cs b/src/flash-multi/Properties/Resources.Designer.cs index 791ceff..ed6fe6c 100644 --- a/src/flash-multi/Properties/Resources.Designer.cs +++ b/src/flash-multi/Properties/Resources.Designer.cs @@ -8,7 +8,7 @@ // //------------------------------------------------------------------------------ -namespace flash_multi.Properties { +namespace Flash_Multi.Properties { using System; @@ -39,7 +39,7 @@ internal Resources() { internal static global::System.Resources.ResourceManager ResourceManager { get { if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("flash_multi.Properties.Resources", typeof(Resources).Assembly); + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Flash_Multi.Properties.Resources", typeof(Resources).Assembly); resourceMan = temp; } return resourceMan; diff --git a/src/flash-multi/Properties/Settings.Designer.cs b/src/flash-multi/Properties/Settings.Designer.cs index ca5a200..8883bec 100644 --- a/src/flash-multi/Properties/Settings.Designer.cs +++ b/src/flash-multi/Properties/Settings.Designer.cs @@ -8,11 +8,11 @@ // //------------------------------------------------------------------------------ -namespace flash_multi.Properties { +namespace Flash_Multi.Properties { [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "15.9.0.0")] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "15.3.0.0")] internal sealed partial class Settings : global::System.Configuration.ApplicationSettingsBase { private static Settings defaultInstance = ((Settings)(global::System.Configuration.ApplicationSettingsBase.Synchronized(new Settings()))); diff --git a/src/flash-multi/RunCommand.cs b/src/flash-multi/RunCommand.cs new file mode 100644 index 0000000..0886264 --- /dev/null +++ b/src/flash-multi/RunCommand.cs @@ -0,0 +1,78 @@ +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +namespace Flash_Multi +{ + using System.Diagnostics; + using System.IO; + + /// + /// Class for running commands. + /// + internal class RunCommand + { + /// + /// Runs a command with arguments. + /// + /// An instance of the class. + /// The command to run. + /// Arguments for the command. + /// The exit code returned by the command. + public static int Run(FlashMulti flashMulti, string command, string args) + { + Debug.WriteLine("\n" + command + " " + args + "\n"); + flashMulti.AppendVerbose(command + " " + args + "\r\n"); + + // Check if the file exists + if (!File.Exists(command)) + { + flashMulti.AppendVerbose(string.Format("{0} does not exist", command)); + return -1; + } + + Process myProcess = new Process(); + + // Process process = new Process(); + myProcess.StartInfo.FileName = command; + myProcess.StartInfo.Arguments = args; + myProcess.StartInfo.UseShellExecute = false; + myProcess.StartInfo.RedirectStandardOutput = true; + myProcess.StartInfo.RedirectStandardError = true; + myProcess.StartInfo.CreateNoWindow = true; + + // Set your output and error (asynchronous) handlers + myProcess.OutputDataReceived += new DataReceivedEventHandler(flashMulti.OutputHandler); + myProcess.ErrorDataReceived += new DataReceivedEventHandler(flashMulti.OutputHandler); + + // Start process and handlers + myProcess.Start(); + + // Read the output + myProcess.BeginOutputReadLine(); + myProcess.BeginErrorReadLine(); + + // Loop until the process finishes + myProcess.WaitForExit(); + + // Return the exit code from the process + return myProcess.ExitCode; + } + } +} diff --git a/src/flash-multi/SerialDevice.cs b/src/flash-multi/SerialDevice.cs new file mode 100644 index 0000000..5b302e6 --- /dev/null +++ b/src/flash-multi/SerialDevice.cs @@ -0,0 +1,114 @@ +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +namespace Flash_Multi +{ + using System; + using System.Threading.Tasks; + using System.Windows.Forms; + + /// + /// Class for working with serial devices. + /// + internal class SerialDevice + { + /// + /// Writes the firmware to a serial device. + /// + /// An instance of the class. + /// The path of the file to flash. + /// The COM port where the serial device can be found. + public static async void WriteFlash(FlashMulti flashMulti, string fileName, string comPort) + { + string command = ".\\tools\\stm32flash.exe"; + string bootLoaderPath = ".\\bootloaders\\StmMulti4in1.bin"; + string commandArgs; + + int returnCode = -1; + int flashStep = 1; + int flashSteps = 2; + + int flashStart = 0; + string executionAddress = "0x8000000"; + + if (flashMulti.writeBootloader_Yes.Checked) + { + flashSteps = 3; + } + + flashMulti.AppendLog("Starting Multimodule update\r\n"); + + // Erase + flashMulti.AppendLog($"[{flashStep}/{flashSteps}] Erasing flash memory..."); + commandArgs = string.Format("-o -S 0x8000000:129024 -b 115200 {0}", comPort); + await Task.Run(() => { returnCode = RunCommand.Run(flashMulti, command, commandArgs); }); + if (returnCode != 0) + { + flashMulti.EnableControls(true); + flashMulti.AppendLog(" failed!"); + MessageBox.Show("Failed to erase flash memory.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); + return; + } + + flashMulti.AppendLog(" done\r\n"); + + if (flashMulti.writeBootloader_Yes.Checked) + { + // Flash bootloader + flashStep++; + flashMulti.AppendLog($"[{flashStep}/{flashSteps}] Writing bootloader..."); + commandArgs = $"-v -e 0 -g {executionAddress} -b 115200 -w \"{bootLoaderPath}\" {comPort}"; + await Task.Run(() => { returnCode = RunCommand.Run(flashMulti, command, commandArgs); }); + if (returnCode != 0) + { + flashMulti.EnableControls(true); + flashMulti.AppendLog(" failed!"); + MessageBox.Show("Failed to write the bootloader.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); + return; + } + + flashMulti.AppendLog(" done\r\n"); + + // Set the flash address for a flash with bootloader + flashStart = 8; + executionAddress = "0x8002000"; + } + + // Flash firmware + flashStep++; + flashMulti.AppendLog($"[{flashStep}/{flashSteps}] Writing Multimodule firmware..."); + commandArgs = $"-v -s {flashStart} -e 0 -g {executionAddress} -b 115200 -w \"{fileName}\" {comPort}"; + await Task.Run(() => { returnCode = RunCommand.Run(flashMulti, command, commandArgs); }); + if (returnCode != 0) + { + flashMulti.EnableControls(true); + flashMulti.AppendLog(" failed!"); + MessageBox.Show("Failed to write the firmware.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Error); + return; + } + + flashMulti.AppendLog(" done\r\n"); + flashMulti.AppendLog("\r\nMultimodule updated sucessfully"); + + MessageBox.Show("Multimodule updated sucessfully.", "Firmware Update", MessageBoxButtons.OK, MessageBoxIcon.Information); + flashMulti.EnableControls(true); + } + } +} diff --git a/src/flash-multi/UpdateCheck.cs b/src/flash-multi/UpdateCheck.cs new file mode 100644 index 0000000..c58289e --- /dev/null +++ b/src/flash-multi/UpdateCheck.cs @@ -0,0 +1,168 @@ +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +namespace Flash_Multi +{ + using System; + using System.Diagnostics; + using System.IO; + using System.Net; + using System.Text.RegularExpressions; + using System.Threading.Tasks; + using System.Windows.Forms; + + /// + /// Class for performing application update checks. + /// + internal class UpdateCheck + { + /// + /// Gets a value indicating whether or not the Github version check succeeded. + /// + public bool CheckSuccess { get; private set; } + + /// + /// Gets a containing the version of the latest release. + /// + public Version LatestVersion { get; private set; } + + /// + /// Gets a string containing the URL of the latest release. + /// + public string ReleaseUrl { get; private set; } + + /// + /// Prompt the user if a newer version is available. + /// + /// An instance of the class. + public static async void DoCheck(FlashMulti flashMulti) + { + // Get check for the latest version on Github + UpdateCheck check = new UpdateCheck(); + await Task.Run(() => { check = GetLatestVersion(); }); + + // If the check completed successfully + if (check.CheckSuccess) + { + // Get the current version + Version currentVersion = Version.Parse(Application.ProductVersion); + + // Get the version available on Github + Version latestVersion = check.LatestVersion; + + // Check if the current version is older than the latest Github release version + if (currentVersion.CompareTo(latestVersion) == -1) + { + // A newer version is available to show the user a prompt + Debug.WriteLine($"App version is older than latest version: {currentVersion} < {latestVersion}"); + DialogResult showUpdate = MessageBox.Show( + $"A newer version of Flash Multi is available.\n\nYou have Flash Multi v{currentVersion.ToString()} and Flash Multi v{latestVersion.ToString()} is available.\n\nSee the latest release on Github?", + "Flash Multi Update Available", + MessageBoxButtons.YesNo, + MessageBoxIcon.Information); + + // Show the Github release page for the new version if the user clicked Yes + if (showUpdate == DialogResult.Yes) + { + flashMulti.OpenLink(check.ReleaseUrl); + } + } + } + } + + /// + /// Gets the latest release tag from Github. + /// + /// Returns an . + private static UpdateCheck GetLatestVersion() + { + // Somewhere to store the results + UpdateCheck results = new UpdateCheck + { + CheckSuccess = false, + }; + + try + { + // The API URL to check for the latest release + // Returns a JSON payload containing all the details of the latest release + string releasesUrl = "https://api.github.com/repos/benlye/flash-multi/releases/latest"; + + // Set TLS1.2, as required by the Github API + System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12; + + // Create the WebRequest + HttpWebRequest webRequest = (HttpWebRequest)WebRequest.Create(releasesUrl); + + // Set the UserAgent, as required by the Github API + webRequest.UserAgent = $"flash-multi-{Application.ProductVersion}"; + + // Disable keepalive so we don't hold a connection open + webRequest.KeepAlive = false; + + // Get the response and read it + using (WebResponse myResponse = webRequest.GetResponse()) + using (StreamReader sr = new StreamReader(myResponse.GetResponseStream(), System.Text.Encoding.UTF8)) + { + // Read all of the output from the StreamReader + string result = sr.ReadToEnd(); + + // Parse the release tag out of the JSON + // This contains the version string + int tagStart = result.IndexOf("\"tag_name\":"); + int tagEnd = result.IndexOf(",", tagStart); + string tagLine = result.Substring(tagStart, tagEnd - tagStart); + string tag = tagLine.Split('"')[3]; + + // Add the release tag to the results + results.LatestVersion = Version.Parse(tag); + + // Parse the release URL out of the JSON + // This is the URL of the Github page containing details of the latest release + int urlStart = result.IndexOf("\"html_url\":"); + int urlEnd = result.IndexOf(",", urlStart); + string urlLine = result.Substring(urlStart, urlEnd - urlStart); + string url = urlLine.Split('"')[3]; + + // Add the release URL to the results + results.ReleaseUrl = url; + } + + // Define a regular expression to test the version number looks how we expect it to + Regex versionRegex = new Regex(@"\d+\.\d+\.\d+"); + + // Check that the URL and version number are as we expect + if (results.ReleaseUrl.StartsWith("https://github.com/benlye/flash-multi/releases/") && versionRegex.Match(results.LatestVersion.ToString()).Success) + { + // All looks good; the check succeeded + Debug.WriteLine($"Update check succeeded. Latest version is {results.LatestVersion}"); + results.CheckSuccess = true; + } + } + catch (Exception ex) + { + Debug.WriteLine($"Error getting latest version: {ex.Message}"); + } + + // Return the results + return results; + } + } +} diff --git a/src/flash-multi/UsbDeviceInfo.cs b/src/flash-multi/UsbDeviceInfo.cs new file mode 100644 index 0000000..4330dec --- /dev/null +++ b/src/flash-multi/UsbDeviceInfo.cs @@ -0,0 +1,110 @@ +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- + +namespace Flash_Multi +{ + using System.Collections.Generic; + using System.Management; + + /// + /// Class for retrieving information about connected USB devices. + /// + internal class UsbDeviceInfo + { + /// + /// Initializes a new instance of the class. + /// + /// The USB device ID. + /// The PNP Device ID. + /// Description of the device. + /// Device manufacturer. + /// Device name. + /// Device status. + public UsbDeviceInfo(string deviceID, string pnpDeviceID, string description, string manufacturer, string name, string status) + { + this.DeviceID = deviceID; + this.PnpDeviceID = pnpDeviceID; + this.Description = description; + this.Manufacturer = manufacturer; + this.Name = name; + this.Status = status; + } + + /// + /// Gets the device ID. + /// + public string DeviceID { get; private set; } + + /// + /// Gets the PnP device ID. + /// + public string PnpDeviceID { get; private set; } + + /// + /// Gets the device description. + /// + public string Description { get; private set; } + + /// + /// Gets the device manufacturer. + /// + public string Manufacturer { get; private set; } + + /// + /// Gets the device name. + /// + public string Name { get; private set; } + + /// + /// Gets the device status. + /// + public string Status { get; private set; } + + /// + /// Gets a list of devices matching the Maple DeviceID. + /// + /// Returns a list of devices. + public static List GetUSBDevices() + { + // Create a list to store the output + List devices = new List(); + + // Use WMI to find all the Maple devices + ManagementObjectCollection collection; + using (var searcher = new ManagementObjectSearcher(@"Select * From Win32_PnPEntity WHERE DeviceID like '%VID_1EAF&%'")) + using (collection = searcher.Get()) + { + foreach (var device in collection) + { + devices.Add(new UsbDeviceInfo( + (string)device.GetPropertyValue("DeviceID"), + (string)device.GetPropertyValue("PNPDeviceID"), + (string)device.GetPropertyValue("Description"), + (string)device.GetPropertyValue("Manufacturer"), + (string)device.GetPropertyValue("Name"), + (string)device.GetPropertyValue("Status"))); + } + } + + // Return the list of devices + return devices; + } + } +} diff --git a/src/flash-multi/UsbNotifications.cs b/src/flash-multi/UsbNotification.cs similarity index 52% rename from src/flash-multi/UsbNotifications.cs rename to src/flash-multi/UsbNotification.cs index 14d2674..38e4999 100644 --- a/src/flash-multi/UsbNotifications.cs +++ b/src/flash-multi/UsbNotification.cs @@ -1,20 +1,57 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +// ------------------------------------------------------------------------------- +// +// Copyright 2019 Ben Lye +// +// This file is part of Flash Multi. +// +// Flash Multi is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free Software +// Foundation, either version 3 of the License, or(at your option) any later +// version. +// +// Flash Multi 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 General Public License for more details. +// +// You should have received a copy of the GNU General Public License along with +// Flash Multi. If not, see http://www.gnu.org/licenses/. +// +// ------------------------------------------------------------------------------- -namespace flash_multi +namespace Flash_Multi { using System; using System.Runtime.InteropServices; + + /// + /// Class for handling USB devices being plugged / unplugged. + /// internal static class UsbNotification { - public const int DbtDevicearrival = 0x8000; // system detected a new device - public const int DbtDeviceremovecomplete = 0x8004; // device is gone - public const int WmDevicechange = 0x0219; // device change event + /// + /// Constant indicating a new device. + /// + public const int DbtDevicearrival = 0x8000; // system detected a new device + + /// + /// Constant indicating a device has been removed. + /// + public const int DbtDeviceremovecomplete = 0x8004; + + /// + /// Constant indicating a device change event. + /// + public const int WmDevicechange = 0x0219; + + /// + /// Device type. + /// private const int DbtDevtypDeviceinterface = 5; - private static readonly Guid GuidDevinterfaceUSBDevice = new Guid("A5DCBF10-6530-11D2-901F-00C04FB951ED"); // USB devices + + /// + /// GUID for USB devices. + /// + private static readonly Guid GuidDevinterfaceUSBDevice = new Guid("A5DCBF10-6530-11D2-901F-00C04FB951ED"); private static IntPtr notificationHandle; /// @@ -28,7 +65,7 @@ public static void RegisterUsbDeviceNotification(IntPtr windowHandle) DeviceType = DbtDevtypDeviceinterface, Reserved = 0, ClassGuid = GuidDevinterfaceUSBDevice, - Name = 0 + Name = 0, }; dbi.Size = Marshal.SizeOf(dbi); @@ -39,7 +76,7 @@ public static void RegisterUsbDeviceNotification(IntPtr windowHandle) } /// - /// Unregisters the window for USB device notifications + /// Unregisters the window for USB device notifications. /// public static void UnregisterUsbDeviceNotification() { diff --git a/src/flash-multi/flash-multi.csproj b/src/flash-multi/flash-multi.csproj index 8b3b970..65ea1d1 100644 --- a/src/flash-multi/flash-multi.csproj +++ b/src/flash-multi/flash-multi.csproj @@ -6,7 +6,7 @@ AnyCPU {72D5A55C-CC93-422C-A12F-CCE99E1C7300} WinExe - flash_multi + Flash_Multi flash-multi v4.5 512 @@ -51,16 +51,21 @@ + Form FlashMulti.cs - + - + + + + + FlashMulti.cs @@ -89,6 +94,9 @@ + + Always + diff --git a/src/flash-multi/license.txt b/src/flash-multi/license.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/src/flash-multi/license.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/src/make_release.bat b/src/make_release.bat index 63aa957..539d72f 100644 --- a/src/make_release.bat +++ b/src/make_release.bat @@ -1,15 +1,21 @@ @ECHO OFF -DEL .\flash-multi\bin\*.zip -DEL .\flash-multi\bin\*.exe +REM Import the Visual Studio command line build environment, remembering the current working directory +PUSHD %cd% +CALL "%ProgramFiles(x86)%\Microsoft Visual Studio\2017\Professional\Common7\Tools\VsDevCmd.bat" +POPD + +REM Delete any existing build output +rmdir /s /q .\flash-multi\bin + +REM Run the build command +msbuild /t:Clean /p:Configuration=Release +msbuild /t:Build /p:Configuration=Release REM Get the version FOR /F "USEBACKQ" %%F IN (`powershell -NoLogo -NoProfile -Command ^(Get-Item ".\flash-multi\bin\Release\flash-multi.exe"^).VersionInfo.FileVersion`) DO (SET fileVersion=%%F) echo File version: %fileVersion% -REM Delete an existing archive -DEL .\flash-multi\bin\flash-multi-%fileVersion%.zip - REM Create the zip archive "C:\Program Files\7-Zip\7z.exe" a -r -x!*.pdb .\flash-multi\bin\flash-multi-%fileVersion%.zip .\flash-multi\bin\Release @@ -18,3 +24,11 @@ REM Rename the root folder in the zip REM Create the installer package "C:\Program Files (x86)\Inno Setup 6\iscc.exe" /Qp /DMyAppVersion=%fileVersion% flash-multi.iss + +REM Get the SH256 hashes from the files +ECHO. +FOR /F "USEBACKQ" %%F IN (`powershell -NoLogo -NoProfile -Command ^(Get-FileHash ".\flash-multi\bin\flash-multi-%fileVersion%.zip"^).Hash`) DO (SET fileHash=%%F) +ECHO flash-multi-%fileVersion%.zip: %fileHash% + +FOR /F "USEBACKQ" %%F IN (`powershell -NoLogo -NoProfile -Command ^(Get-FileHash ".\flash-multi\bin\flash-multi-%fileVersion%.exe"^).Hash`) DO (SET fileHash=%%F) +ECHO flash-multi-%fileVersion%.exe: %fileHash%