telegps: Add flash device functionality
[fw/altos] / altosuilib / AltosFlashUI.java
diff --git a/altosuilib/AltosFlashUI.java b/altosuilib/AltosFlashUI.java
new file mode 100644 (file)
index 0000000..3f12061
--- /dev/null
@@ -0,0 +1,438 @@
+/*
+ * Copyright © 2010 Keith Packard <keithp@keithp.com>
+ *
+ * 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; version 2 of the License.
+ *
+ * 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, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ */
+
+package org.altusmetrum.altosuilib_2;
+
+import java.awt.*;
+import java.awt.event.*;
+import javax.swing.*;
+import javax.swing.filechooser.FileNameExtensionFilter;
+import java.io.*;
+import java.util.concurrent.*;
+import org.altusmetrum.altoslib_4.*;
+
+public class AltosFlashUI
+       extends AltosUIDialog
+       implements ActionListener
+{
+       Container       pane;
+       Box             box;
+       JLabel          serial_label;
+       JLabel          serial_value;
+       JLabel          file_label;
+       JLabel          file_value;
+       JProgressBar    pbar;
+       JButton         cancel;
+
+       AltosUIFrame    frame;
+
+       // Hex file with rom image
+       File            file;
+
+       // Debug connection
+       AltosDevice     device;
+
+       AltosLink       link;
+
+       // Desired Rom configuration
+       AltosRomconfig  rom_config;
+
+       // Flash controller
+       AltosProgrammer programmer;
+
+       private static String[] pair_programmed = {
+               "teleballoon",
+               "telebt",
+               "teledongle",
+               "telefire",
+               "telemetrum-v0",
+               "telemetrum-v1",
+               "telemini",
+               "telenano",
+               "teleshield",
+               "teleterra"
+       };
+
+       private boolean is_pair_programmed() {
+
+               if (file != null) {
+                       String  name = file.getName();
+                       for (int i = 0; i < pair_programmed.length; i++) {
+                               if (name.startsWith(pair_programmed[i]))
+                                       return true;
+                       }
+               }
+               if (device != null) {
+                       if (!device.matchProduct(AltosLib.product_altusmetrum) &&
+                           (device.matchProduct(AltosLib.product_teledongle) ||
+                            device.matchProduct(AltosLib.product_telebt)))
+                               return true;
+               }
+               return false;
+       }
+
+       public void actionPerformed(ActionEvent e) {
+               if (e.getSource() == cancel) {
+                       if (programmer != null)
+                               programmer.abort();
+                       setVisible(false);
+                       dispose();
+               } else {
+                       String  cmd = e.getActionCommand();
+                       if (e.getID() == -1) {
+                               JOptionPane.showMessageDialog(frame,
+                                                             e.getActionCommand(),
+                                                             file.toString(),
+                                                             JOptionPane.ERROR_MESSAGE);
+                               setVisible(false);
+                               dispose();
+                       } else if (cmd.equals("done")) {
+                               setVisible(false);
+                               dispose();
+                       } else if (cmd.equals("start")) {
+                               setVisible(true);
+                       } else {
+                               pbar.setValue(e.getID());
+                               pbar.setString(cmd);
+                       }
+               }
+       }
+
+       public void build_dialog() {
+               GridBagConstraints c;
+               Insets il = new Insets(4,4,4,4);
+               Insets ir = new Insets(4,4,4,4);
+
+               pane = getContentPane();
+               pane.setLayout(new GridBagLayout());
+
+               c = new GridBagConstraints();
+               c.gridx = 0; c.gridy = 0;
+               c.fill = GridBagConstraints.NONE;
+               c.anchor = GridBagConstraints.LINE_START;
+               c.insets = il;
+               serial_label = new JLabel("Serial:");
+               pane.add(serial_label, c);
+
+               c = new GridBagConstraints();
+               c.gridx = 1; c.gridy = 0;
+               c.fill = GridBagConstraints.HORIZONTAL;
+               c.weightx = 1;
+               c.anchor = GridBagConstraints.LINE_START;
+               c.insets = ir;
+               serial_value = new JLabel("");
+               pane.add(serial_value, c);
+
+               c = new GridBagConstraints();
+               c.fill = GridBagConstraints.NONE;
+               c.gridx = 0; c.gridy = 1;
+               c.anchor = GridBagConstraints.LINE_START;
+               c.insets = il;
+               file_label = new JLabel("File:");
+               pane.add(file_label, c);
+
+               c = new GridBagConstraints();
+               c.fill = GridBagConstraints.HORIZONTAL;
+               c.weightx = 1;
+               c.gridx = 1; c.gridy = 1;
+               c.anchor = GridBagConstraints.LINE_START;
+               c.insets = ir;
+               file_value = new JLabel(file.toString());
+               pane.add(file_value, c);
+
+               pbar = new JProgressBar();
+               pbar.setMinimum(0);
+               pbar.setMaximum(100);
+               pbar.setValue(0);
+               pbar.setString("");
+               pbar.setStringPainted(true);
+               pbar.setPreferredSize(new Dimension(600, 20));
+               c = new GridBagConstraints();
+               c.fill = GridBagConstraints.HORIZONTAL;
+               c.anchor = GridBagConstraints.CENTER;
+               c.gridx = 0; c.gridy = 2;
+               c.gridwidth = GridBagConstraints.REMAINDER;
+               Insets ib = new Insets(4,4,4,4);
+               c.insets = ib;
+               pane.add(pbar, c);
+
+               cancel = new JButton("Cancel");
+               c = new GridBagConstraints();
+               c.fill = GridBagConstraints.NONE;
+               c.anchor = GridBagConstraints.CENTER;
+               c.gridx = 0; c.gridy = 3;
+               c.gridwidth = GridBagConstraints.REMAINDER;
+               Insets ic = new Insets(4,4,4,4);
+               c.insets = ic;
+               pane.add(cancel, c);
+               cancel.addActionListener(this);
+               pack();
+               setLocationRelativeTo(frame);
+       }
+
+       void set_serial(int serial_number) {
+               serial_value.setText(String.format("%d", serial_number));
+       }
+
+       static class AltosHexfileFilter extends javax.swing.filechooser.FileFilter {
+               int product;
+               String head;
+               String description;
+
+               public AltosHexfileFilter(int product, String head, String description) {
+                       this.product = product;
+                       this.head = head;
+                       this.description = description;
+               }
+
+               public boolean accept(File file) {
+                       return !file.isFile() || (file.getName().startsWith(head) && file.getName().endsWith(".ihx"));
+               }
+
+               public String getDescription() {
+                       return description;
+               }
+       }
+
+       static AltosHexfileFilter[] filters = {
+               new AltosHexfileFilter(AltosLib.product_telemetrum, "telemetrum", "TeleMetrum Image"),
+               new AltosHexfileFilter(AltosLib.product_teledongle, "teledongle", "TeleDongle Image"),
+               new AltosHexfileFilter(AltosLib.product_telemega, "telemega", "TeleMega Image"),
+               new AltosHexfileFilter(AltosLib.product_easymini, "easymini", "EasyMini Image"),
+       };
+
+       boolean select_source_file() {
+               JFileChooser    hexfile_chooser = new JFileChooser();
+
+               File firmwaredir = AltosUIPreferences.firmwaredir();
+               if (firmwaredir != null)
+                       hexfile_chooser.setCurrentDirectory(firmwaredir);
+
+               hexfile_chooser.setDialogTitle("Select Flash Image");
+
+               for (int i = 0; i < filters.length; i++) {
+                       hexfile_chooser.addChoosableFileFilter(filters[i]);
+               }
+               javax.swing.filechooser.FileFilter ihx_filter = new FileNameExtensionFilter("Flash Image", "ihx");
+               hexfile_chooser.addChoosableFileFilter(ihx_filter);
+               hexfile_chooser.setFileFilter(ihx_filter);
+
+               if (!is_pair_programmed() && !device.matchProduct(AltosLib.product_altusmetrum)) {
+                       for (int i = 0; i < filters.length; i++) {
+                               if (device != null && device.matchProduct(filters[i].product))
+                                       hexfile_chooser.setFileFilter(filters[i]);
+                       }
+               }
+
+               int returnVal = hexfile_chooser.showOpenDialog(frame);
+
+               if (returnVal != JFileChooser.APPROVE_OPTION)
+                       return false;
+               file = hexfile_chooser.getSelectedFile();
+               if (file == null)
+                       return false;
+               AltosUIPreferences.set_firmwaredir(file.getParentFile());
+
+               return true;
+       }
+
+       boolean select_device() {
+               int     product = AltosLib.product_any;
+
+               device = AltosDeviceUIDialog.show(frame, AltosLib.product_any);
+
+               if (device == null)
+                       return false;
+               return true;
+       }
+
+       boolean update_rom_config_info(AltosRomconfig existing_config) {
+               AltosRomconfig  new_config;
+               new_config = AltosRomconfigUI.show(frame, existing_config);
+               if (new_config == null)
+                       return false;
+               rom_config = new_config;
+               set_serial(rom_config.serial_number);
+               setVisible(true);
+               return true;
+       }
+
+       void exception (Exception e) {
+               if (e instanceof FileNotFoundException) {
+                       JOptionPane.showMessageDialog(frame,
+                                                     ((FileNotFoundException) e).getMessage(),
+                                                     "Cannot open file",
+                                                     JOptionPane.ERROR_MESSAGE);
+               } else if (e instanceof AltosSerialInUseException) {
+                       JOptionPane.showMessageDialog(frame,
+                                                     String.format("Device \"%s\" already in use",
+                                                                   device.toShortString()),
+                                                     "Device in use",
+                                                     JOptionPane.ERROR_MESSAGE);
+               } else if (e instanceof IOException) {
+                       JOptionPane.showMessageDialog(frame,
+                                                     e.getMessage(),
+                                                     file.toString(),
+                                                     JOptionPane.ERROR_MESSAGE);
+               }
+       }
+
+       class flash_task implements Runnable, AltosFlashListener {
+               AltosFlashUI    ui;
+               Thread          t;
+               AltosProgrammer programmer;
+
+               public void position(String in_s, int in_percent) {
+                       final String s = in_s;
+                       final int percent = in_percent;
+                       Runnable r = new Runnable() {
+                                       public void run() {
+                                               try {
+                                                       ui.actionPerformed(new ActionEvent(this,
+                                                                                          percent,
+                                                                                          s));
+                                               } catch (Exception ex) {
+                                               }
+                                       }
+                               };
+                       SwingUtilities.invokeLater(r);
+               }
+
+               public void run () {
+                       try {
+                               if (ui.is_pair_programmed())
+                                       programmer = new AltosFlash(ui.file, link, this);
+                               else
+                                       programmer = new AltosSelfFlash(ui.file, link, this);
+
+                               final AltosRomconfig    current_config = programmer.romconfig();
+
+                               final Semaphore await_rom_config = new Semaphore(0);
+                               SwingUtilities.invokeLater(new Runnable() {
+                                               public void run() {
+                                                       ui.programmer = programmer;
+                                                       ui.update_rom_config_info(current_config);
+                                                       await_rom_config.release();
+                                               }
+                                       });
+                               await_rom_config.acquire();
+
+                               if (ui.rom_config != null) {
+                                       programmer.set_romconfig(ui.rom_config);
+                                       programmer.flash();
+                               }
+                       } catch (InterruptedException ee) {
+                               final Exception e = ee;
+                               SwingUtilities.invokeLater(new Runnable() {
+                                               public void run() {
+                                                       ui.exception(e);
+                                               }
+                                       });
+                       } catch (IOException ee) {
+                               final Exception e = ee;
+                               SwingUtilities.invokeLater(new Runnable() {
+                                               public void run() {
+                                                       ui.exception(e);
+                                               }
+                                       });
+                       } finally {
+                               if (programmer != null)
+                                       programmer.close();
+                       }
+               }
+
+               public flash_task(AltosFlashUI in_ui) {
+                       ui = in_ui;
+                       t = new Thread(this);
+                       t.start();
+               }
+       }
+
+       flash_task      flasher;
+
+       private boolean open_device() throws InterruptedException {
+               try {
+                       link = new AltosSerial(device);
+                       if (is_pair_programmed())
+                               return true;
+
+                       if (link == null)
+                               throw new IOException(String.format("%s: open failed", device.toShortString()));
+
+                       while (!link.is_loader()) {
+                               link.to_loader();
+
+                               java.util.List<AltosDevice> devices = null;
+
+                               for (int tries = 0; tries < 10; tries++) {
+                                       Thread.sleep(100);
+                                       devices = AltosUSBDevice.list(AltosLib.product_altusmetrum);
+                                       if (devices.size() != 0)
+                                               break;
+                               }
+
+                               if (devices.size() == 1)
+                                       device = devices.get(0);
+                               else {
+                                       device = AltosDeviceUIDialog.show(frame, AltosLib.product_altusmetrum);
+                                       if (device == null)
+                                               return false;
+                               }
+                               link = new AltosSerial(device);
+                       }
+                       return true;
+               } catch (AltosSerialInUseException ee) {
+                       exception(ee);
+               } catch (FileNotFoundException fe) {
+                       exception(fe);
+               } catch (IOException ie) {
+                       exception (ie);
+               }
+               return false;
+       }
+
+       /*
+        * Execute the steps for flashing
+        * a device. Note that this returns immediately;
+        * this dialog is not modal
+        */
+       void showDialog() {
+               if (!select_device())
+                       return;
+               if (!select_source_file())
+                       return;
+               try {
+                       if (!open_device())
+                               return;
+               } catch (InterruptedException ie) {
+                       return;
+               }
+               build_dialog();
+               flash_task      f = new flash_task(this);
+       }
+
+       public static void show(AltosUIFrame frame) {
+               AltosFlashUI    ui = new AltosFlashUI(frame);
+               ui.showDialog();
+       }
+
+       public AltosFlashUI(AltosUIFrame in_frame) {
+               super(in_frame, "Program Altusmetrum Device", false);
+
+               frame = in_frame;
+       }
+}