rpremote 0.2.0 → 0.3.0

data/lib/rpremote/recursive_copy.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Rpremote
+  class RecursiveCopy
+    def initialize(output:, serial: Serial, device: Device)
+      @output = output
+      @serial = serial
+      @device = device
+    end
+
+    def call(source, destination, options)
+      validate!(source, destination)
+      remote_root = RemotePath.validate(destination)
+      directories, files = collect(source, remote_root)
+      create_directories(directories, options)
+      upload_files(files, options)
+      output.puts("uploaded #{files.length} files: #{source} -> #{destination}")
+    rescue Errno::ENOENT => e
+      raise ArgumentError, e.message
+    end
+
+    private
+
+    attr_reader :output, :serial, :device
+
+    def validate!(source, destination)
+      raise ArgumentError, "recursive cp only supports a local source and remote destination" if RemotePath.remote?(source)
+      raise ArgumentError, "recursive cp source must be a directory: #{source}" unless File.directory?(source)
+
+      RemotePath.validate(destination)
+    end
+
+    def collect(source, remote_root)
+      directories = [remote_root]
+      files = []
+      local_entries(source).each do |path|
+        remote_path = File.join(remote_root, path.delete_prefix("#{source}/"))
+        File.directory?(path) ? directories << remote_path : files << [path, remote_path]
+      end
+      [directories.sort_by { |path| [path.count("/"), path] }.uniq, files.sort]
+    end
+
+    def local_entries(source)
+      entries = Dir.glob(File.join(source, "**", "*"), File::FNM_DOTMATCH).reject do |path|
+        %w[. ..].include?(File.basename(path))
+      end
+      symbolic_link = entries.find { |path| File.symlink?(path) }
+      raise ArgumentError, "recursive cp does not support symbolic links: #{symbolic_link}" if symbolic_link
+
+      entries
+    end
+
+    def create_directories(directories, options)
+      with_port(options) do |port|
+        shell = Shell.new(port, timeout: options[:timeout])
+        shell.synchronize!
+        directories.each do |path|
+          quoted_path = Shell.quote_argument(path)
+          next unless shell.execute("ls #{quoted_path}").start_with?("ls:")
+
+          result = shell.execute("mkdir #{quoted_path}")
+          raise Shell::CommandError, result.strip unless result.empty?
+
+          output.puts("created remote directory: :#{path}")
+        end
+      end
+    end
+
+    def upload_files(files, options)
+      with_port(options) do |port|
+        modem = PicoModem.new(port, timeout: options[:timeout])
+        files.each do |local_path, remote_path|
+          size = modem.upload(remote_path, File.binread(local_path))
+          output.puts("uploaded #{size} bytes: #{local_path} -> :#{remote_path}")
+        end
+      end
+    end
+
+    def with_port(options, &)
+      port_path = device.main_port(options[:port])
+      serial.open(port_path, baud: options[:baud], &)
+    end
+  end
+end

data/lib/rpremote/runner.rb

@@ -3,6 +3,8 @@
 module Rpremote
   class Runner
     REMOTE_DIRECTORY = "/home"
+    RUN_REMOTE_PATH = "#{REMOTE_DIRECTORY}/.rpremote-run.rb".freeze
+    DEPLOY_REMOTE_PATH = "#{REMOTE_DIRECTORY}/.rpremote-deploy.rb".freeze
 
     attr_reader :io, :timeout
 
@@ -20,16 +22,33 @@ module Rpremote
       @path_factory = path_factory || method(:temporary_path)
     end
 
-    def run(data, output: nil)
-      remote_path = @path_factory.call
+    def run(data, output: nil, cleanup: true, remote_path: nil, diagnostics: nil)
+      remote_path ||= @path_factory.call
       shell = @shell_class.new(io, timeout: timeout)
+      trace(diagnostics, "SYNC_BEFORE_UPLOAD_START")
       shell.synchronize!
+      trace(diagnostics, "SYNC_BEFORE_UPLOAD_DONE")
+      trace(diagnostics, "UPLOAD_START", "bytes=#{data.bytesize},path=#{remote_path}")
       @modem_class.new(io, timeout: timeout).upload(remote_path, data)
+      trace(diagnostics, "UPLOAD_DONE")
+      trace(diagnostics, "SYNC_BEFORE_RUN_START")
       shell.synchronize!
+      trace(diagnostics, "SYNC_BEFORE_RUN_DONE")
       shell_ready = true
-      output ? shell.execute("./#{File.basename(remote_path)}", output: output) : shell.execute("./#{File.basename(remote_path)}")
+      command = "./#{File.basename(remote_path)}"
+      trace(diagnostics, "EXECUTE_START", "command=#{command}")
+      result = output ? shell.execute(command, output: output, idle_timeout: true) : shell.execute(command, idle_timeout: true)
+      trace(diagnostics, "EXECUTE_DONE", "bytes=#{result.to_s.bytesize}")
+      result
+    rescue StandardError => e
+      trace(diagnostics, "ERROR", "class=#{e.class},message=#{e.message.to_s.gsub("\n", " ")}")
+      raise
     ensure
-      cleanup(shell, remote_path) if shell_ready && remote_path
+      if cleanup && shell_ready && remote_path
+        trace(diagnostics, "CLEANUP_START", "path=#{remote_path}")
+        cleanup(shell, remote_path)
+        trace(diagnostics, "CLEANUP_DONE")
+      end
     end
 
     private
@@ -40,9 +59,17 @@ module Rpremote
       nil
     end
 
+    def trace(diagnostics, event, details = nil)
+      return unless diagnostics
+
+      line = "rpremote: run event=#{event}"
+      line += ",#{details}" if details
+      diagnostics.puts(line)
+      diagnostics.flush if diagnostics.respond_to?(:flush)
+    end
+
     def temporary_path
-      stamp = (Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1_000_000).to_i
-      "#{REMOTE_DIRECTORY}/.rpremote-run-#{Process.pid}-#{stamp}.rb"
+      RUN_REMOTE_PATH
     end
   end
 end

data/lib/rpremote/setup_command.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require "optparse"
+require_relative "nuke_firmware"
 
 module Rpremote
   class SetupCommand
-    def self.run(args, defaults:, config:, config_filename:, output: $stdout)
+    def self.run(args, defaults:, config:, config_filename:, output: $stdout, nuke_firmware: NukeFirmware)
       options = {
         force: false,
         cache_dir: defaults.fetch(:cache, Target::DEFAULT_CACHE_DIR),
@@ -29,6 +30,8 @@ module Rpremote
         cache_dir: target.cache_dir
       ).setup(force: options[:force])
       output.puts("installed #{target.language} #{target.language_version}: #{path}")
+      nuke_path = nuke_firmware.new.setup(force: options[:force])
+      output.puts("installed Raspberry Pi nuke firmware: #{nuke_path}")
     end
   end
 end

data/lib/rpremote/shell.rb

@@ -29,11 +29,12 @@ module Rpremote
 
     attr_reader :io, :timeout
 
-    def initialize(io, timeout: DEFAULT_TIMEOUT)
+    def initialize(io, timeout: DEFAULT_TIMEOUT, clock: nil)
       raise ArgumentError, "timeout must be positive" unless timeout.positive?
 
       @io = io
       @timeout = timeout
+      @clock = clock || -> { Process.clock_gettime(Process::CLOCK_MONOTONIC) }
     end
 
     def synchronize!
@@ -43,12 +44,14 @@ module Rpremote
       nil
     end
 
-    def execute(command, output: nil)
+    def execute(command, output: nil, idle_timeout: false)
       command = validate_command(command)
       send_command(command)
       echo = ECHO_START + command.b + ERASE_LINE
       stream_state = {}
-      response = read_until_prompt(after: echo) { |buffer| stream_output(output, buffer, echo, stream_state) }
+      response = read_until_prompt(after: echo, idle_timeout: idle_timeout) do |buffer|
+        stream_output(output, buffer, echo, stream_state)
+      end
       command_output = extract_output(response, command)
       ruby_exception = command_output.include?(RUBY_EXCEPTION_STATUS)
       command_output = remove_ruby_exception_status(command_output)
@@ -76,7 +79,7 @@ module Rpremote
       command
     end
 
-    def read_until_prompt(wait: timeout, after: nil)
+    def read_until_prompt(wait: timeout, after: nil, idle_timeout: false)
       deadline = monotonic_time + wait
       buffer = +"".b
       loop do
@@ -85,6 +88,7 @@ module Rpremote
         return buffer if prompt_at && buffer.index(PROMPT_END, prompt_at + PROMPT_START.bytesize)
 
         buffer << read_available(deadline)
+        deadline = monotonic_time + wait if idle_timeout
         answer_terminal_queries(buffer)
         yield buffer if block_given?
       end
@@ -186,7 +190,7 @@ module Rpremote
     end
 
     def monotonic_time
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      @clock.call
     end
   end
 end

data/lib/rpremote/terminal.rb

@@ -49,7 +49,7 @@ module Rpremote
         data = serial_io.read_nonblock(BUFFER_SIZE)
         return false if data.nil? || data.empty?
 
-        output.write(data)
+        output.write(normalize_line_endings(data))
         output.flush if output.respond_to?(:flush)
         true
       else
@@ -75,6 +75,18 @@ module Rpremote
       true
     end
 
+    # input.raw disables the terminal's usual LF-to-CRLF output conversion.
+    # Preserve device CRLF while making a bare LF start at the left margin.
+    def normalize_line_endings(data)
+      normalized = +"".b
+      data.each_byte do |byte|
+        normalized << "\r" if byte == 0x0A && !@previous_output_was_cr
+        normalized << byte
+        @previous_output_was_cr = byte == 0x0D
+      end
+      normalized
+    end
+
     def selectable_serial
       @selectable_serial ||= serial_io.respond_to?(:to_io) ? serial_io.to_io : serial_io
     end

data/lib/rpremote/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rpremote
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/rpremote.rb

@@ -19,8 +19,10 @@ require_relative "rpremote/terminal"
 require_relative "rpremote/shell"
 require_relative "rpremote/runner"
 require_relative "rpremote/resetter"
+require_relative "rpremote/recursive_copy"
 require_relative "rpremote/picoruby_source_patch"
 require_relative "rpremote/language_source"
+require_relative "rpremote/nuke_firmware"
 require_relative "rpremote/mrbgems"
 require_relative "rpremote/mrbgems_command"
 require_relative "rpremote/flasher"
@@ -29,3 +31,5 @@ require_relative "rpremote/dfu_command"
 require_relative "rpremote/setup_command"
 require_relative "rpremote/build_command"
 require_relative "rpremote/flash_command"
+require_relative "rpremote/bootsel_command"
+require_relative "rpremote/deploy_command"

data/patches/picoruby-3.4.5-bootsel.patch

@@ -0,0 +1,71 @@
+diff --git a/mrbgems/picoruby-machine/include/machine.h b/mrbgems/picoruby-machine/include/machine.h
+--- a/mrbgems/picoruby-machine/include/machine.h
++++ b/mrbgems/picoruby-machine/include/machine.h
+@@ -48,1 +48,2 @@
+ void Machine_reboot(void);
++void Machine_bootsel(void);
+diff --git a/mrbgems/picoruby-machine/mrblib/machine.rb b/mrbgems/picoruby-machine/mrblib/machine.rb
+--- a/mrbgems/picoruby-machine/mrblib/machine.rb
++++ b/mrbgems/picoruby-machine/mrblib/machine.rb
+@@ -22,0 +23,4 @@
++  def self.bootsel
++    self._bootsel
++  end
++
+diff --git a/mrbgems/picoruby-machine/ports/rp2040/machine.c b/mrbgems/picoruby-machine/ports/rp2040/machine.c
+--- a/mrbgems/picoruby-machine/ports/rp2040/machine.c
++++ b/mrbgems/picoruby-machine/ports/rp2040/machine.c
+@@ -12,0 +13,1 @@
++#include "pico/bootrom.h"
+@@ -32,0 +34,6 @@
++void
++Machine_bootsel(void)
++{
++  rom_reset_usb_boot(0, 0);
++}
++
+diff --git a/mrbgems/picoruby-machine/src/mruby/machine.c b/mrbgems/picoruby-machine/src/mruby/machine.c
+--- a/mrbgems/picoruby-machine/src/mruby/machine.c
++++ b/mrbgems/picoruby-machine/src/mruby/machine.c
+@@ -417,0 +418,11 @@
++static mrb_value
++mrb_s__bootsel(mrb_state *mrb, mrb_value self)
++{
++#if !defined(PICORB_PLATFORM_POSIX)
++  Machine_bootsel();
++#else
++  mrb_raise(mrb, E_NOTIMP_ERROR, "Machine._bootsel is not available on this platform");
++#endif
++  return mrb_nil_value();
++}
++
+@@ -443,0 +455,1 @@
++  mrb_define_class_method_id(mrb, module_Machine, MRB_SYM(_bootsel), mrb_s__bootsel, MRB_ARGS_NONE());
+diff --git a/mrbgems/picoruby-machine/src/mrubyc/machine.c b/mrbgems/picoruby-machine/src/mrubyc/machine.c
+--- a/mrbgems/picoruby-machine/src/mrubyc/machine.c
++++ b/mrbgems/picoruby-machine/src/mrubyc/machine.c
+@@ -252,0 +253,11 @@
++static void
++c_Machine__bootsel(mrbc_vm *vm, mrbc_value *v, int argc)
++{
++#if !defined(PICORB_PLATFORM_POSIX)
++  Machine_bootsel();
++#else
++  mrbc_raise(vm, MRBC_CLASS(RuntimeError), "Machine.bootsel is not available on this platform.");
++#endif
++  SET_NIL_RETURN();
++}
++
+@@ -439,0 +451,1 @@
++  mrbc_define_method(vm, module_Machine, "_bootsel", c_Machine__bootsel);
+diff --git a/mrbgems/picoruby-shell/shell_executables/_path.txt b/mrbgems/picoruby-shell/shell_executables/_path.txt
+--- a/mrbgems/picoruby-shell/shell_executables/_path.txt
++++ b/mrbgems/picoruby-shell/shell_executables/_path.txt
+@@ -16,0 +17,1 @@
++/bin/bootsel
+diff --git a/mrbgems/picoruby-shell/shell_executables/bootsel.rb b/mrbgems/picoruby-shell/shell_executables/bootsel.rb
+new file mode 100644
+--- /dev/null
++++ b/mrbgems/picoruby-shell/shell_executables/bootsel.rb
+@@ -0,0 +1 @@
++Machine.bootsel

data/patches/picoruby-4.0.3-bootsel.patch

@@ -0,0 +1,71 @@
+diff --git a/mrbgems/picoruby-machine/include/machine.h b/mrbgems/picoruby-machine/include/machine.h
+--- a/mrbgems/picoruby-machine/include/machine.h
++++ b/mrbgems/picoruby-machine/include/machine.h
+@@ -68,1 +68,2 @@
+ void Machine_reboot(void);
++void Machine_bootsel(void);
+diff --git a/mrbgems/picoruby-machine/mrblib/machine.rb b/mrbgems/picoruby-machine/mrblib/machine.rb
+--- a/mrbgems/picoruby-machine/mrblib/machine.rb
++++ b/mrbgems/picoruby-machine/mrblib/machine.rb
+@@ -22,0 +23,4 @@
++  def self.bootsel
++    self._bootsel
++  end
++
+diff --git a/mrbgems/picoruby-machine/ports/rp2040/machine.c b/mrbgems/picoruby-machine/ports/rp2040/machine.c
+--- a/mrbgems/picoruby-machine/ports/rp2040/machine.c
++++ b/mrbgems/picoruby-machine/ports/rp2040/machine.c
+@@ -10,0 +11,1 @@
++#include "pico/bootrom.h"
+@@ -42,0 +44,6 @@
++void
++Machine_bootsel(void)
++{
++  rom_reset_usb_boot(0, 0);
++}
++
+diff --git a/mrbgems/picoruby-machine/src/mruby/machine.c b/mrbgems/picoruby-machine/src/mruby/machine.c
+--- a/mrbgems/picoruby-machine/src/mruby/machine.c
++++ b/mrbgems/picoruby-machine/src/mruby/machine.c
+@@ -496,0 +497,11 @@
++static mrb_value
++mrb_s__bootsel(mrb_state *mrb, mrb_value self)
++{
++#if !defined(PICORB_PLATFORM_POSIX)
++  Machine_bootsel();
++#else
++  mrb_raise(mrb, E_NOTIMP_ERROR, "Machine._bootsel is not available on this platform");
++#endif
++  return mrb_nil_value();
++}
++
+@@ -529,0 +541,1 @@
++  mrb_define_class_method_id(mrb, module_Machine, MRB_SYM(_bootsel), mrb_s__bootsel, MRB_ARGS_NONE());
+diff --git a/mrbgems/picoruby-machine/src/mrubyc/machine.c b/mrbgems/picoruby-machine/src/mrubyc/machine.c
+--- a/mrbgems/picoruby-machine/src/mrubyc/machine.c
++++ b/mrbgems/picoruby-machine/src/mrubyc/machine.c
+@@ -316,0 +317,11 @@
++static void
++c_Machine__bootsel(mrbc_vm *vm, mrbc_value *v, int argc)
++{
++#if !defined(PICORB_PLATFORM_POSIX)
++  Machine_bootsel();
++#else
++  mrbc_raise(vm, MRBC_CLASS(RuntimeError), "Machine.bootsel is not available on this platform.");
++#endif
++  SET_NIL_RETURN();
++}
++
+@@ -546,0 +558,1 @@
++  mrbc_define_method(vm, module_Machine, "_bootsel", c_Machine__bootsel);
+diff --git a/mrbgems/picoruby-shell/shell_executables/_path.txt b/mrbgems/picoruby-shell/shell_executables/_path.txt
+--- a/mrbgems/picoruby-shell/shell_executables/_path.txt
++++ b/mrbgems/picoruby-shell/shell_executables/_path.txt
+@@ -17,0 +18,1 @@
++/bin/bootsel
+diff --git a/mrbgems/picoruby-shell/shell_executables/bootsel.rb b/mrbgems/picoruby-shell/shell_executables/bootsel.rb
+new file mode 100644
+--- /dev/null
++++ b/mrbgems/picoruby-shell/shell_executables/bootsel.rb
+@@ -0,0 +1 @@
++Machine.bootsel

data/sig/rpremote.rbs

@@ -166,6 +166,15 @@ module Rpremote
     def source_dir: () -> String
   end
 
+  class NukeFirmware
+    URL: String
+    FILENAME: String
+    MAX_REDIRECTS: Integer
+
+    def initialize: (?directory: String, ?fetcher: untyped) -> void
+    def setup: (?force: bool) -> String
+  end
+
   class PicoRubySourcePatch
     JOB_PATH: String
     PATCH_ALIASES: Hash[String, String]
@@ -310,6 +319,11 @@ module Rpremote
     def run: (String data, ?output: IO?) -> String
   end
 
+  class RecursiveCopy
+    def initialize: (output: IO, ?serial: untyped, ?device: untyped) -> void
+    def call: (String source, String destination, Hash[Symbol, untyped] options) -> void
+  end
+
   class Resetter
     DEFAULT_TIMEOUT: Float
     RETRY_INTERVAL: Float
@@ -337,7 +351,7 @@ module Rpremote
     class Result < Data
       attr_reader mount: String
       attr_reader destination: String
-      attr_reader port: String
+      attr_reader port: String?
     end
 
     class Error < Rpremote::Error
@@ -362,8 +376,10 @@ module Rpremote
       ?port_probe: untyped,
       ?sleeper: untyped
     ) -> void
-    def flash: (String uf2_path, ?mount: String?, ?port: String?) -> Result
+    def flash: (String uf2_path, ?mount: String?, ?port: String?, ?wait_for_port: bool) -> Result
     def find_mount: (?String? explicit_mount) -> String
+    def find_mounted: (?String? explicit_mount) -> String?
+    def wait_for_mount: (?mount: String?) -> String
   end
 
   class DfuCommand
@@ -415,4 +431,36 @@ module Rpremote
       ?flasher: untyped
     ) -> void
   end
+
+  class DeployCommand
+    def self.run: (
+      Array[String] args,
+      defaults: Hash[Symbol, untyped],
+      ?output: IO,
+      ?error: IO,
+      ?services: Hash[Symbol, untyped]
+    ) -> void
+  end
+
+  class BootselCommand
+    RESET_FLASH_FIRMWARE: String
+
+    class Error < Rpremote::Error
+    end
+
+    def self.run: (
+      Array[String] args,
+      defaults: Hash[Symbol, untyped],
+      ?output: IO,
+      ?services: Hash[Symbol, untyped]
+    ) -> void
+    def self.enter: (
+      mount: String?,
+      port: String?,
+      baud: Integer,
+      timeout: Numeric,
+      output: IO,
+      ?services: Hash[Symbol, untyped]
+    ) -> String
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rpremote
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ogom
@@ -26,12 +26,14 @@ files:
 - THIRD_PARTY_NOTICES.md
 - exe/rpremote
 - lib/rpremote.rb
+- lib/rpremote/bootsel_command.rb
 - lib/rpremote/build_command.rb
 - lib/rpremote/builder.rb
 - lib/rpremote/checksum.rb
 - lib/rpremote/cli.rb
 - lib/rpremote/config.rb
 - lib/rpremote/config_show.rb
+- lib/rpremote/deploy_command.rb
 - lib/rpremote/device.rb
 - lib/rpremote/dfu_command.rb
 - lib/rpremote/dfu_compiler.rb
@@ -42,8 +44,10 @@ files:
 - lib/rpremote/language_source.rb
 - lib/rpremote/mrbgems.rb
 - lib/rpremote/mrbgems_command.rb
+- lib/rpremote/nuke_firmware.rb
 - lib/rpremote/picomodem.rb
 - lib/rpremote/picoruby_source_patch.rb
+- lib/rpremote/recursive_copy.rb
 - lib/rpremote/remote_path.rb
 - lib/rpremote/resetter.rb
 - lib/rpremote/runner.rb
@@ -53,7 +57,9 @@ files:
 - lib/rpremote/target.rb
 - lib/rpremote/terminal.rb
 - lib/rpremote/version.rb
+- patches/picoruby-3.4.5-bootsel.patch
 - patches/picoruby-3.4.5-ruby-exception-status.patch
+- patches/picoruby-4.0.3-bootsel.patch
 - patches/picoruby-4.0.3-ruby-exception-status.patch
 - sig/rpremote.rbs
 - tasks/firmware_build.rb