Packages
nerves
1.1.1
1.15.0
1.14.3
1.14.2
1.14.1
1.14.0
1.13.2
1.13.1
1.13.0
1.12.0
1.11.3
1.11.2
1.11.1
1.11.0
1.10.5
1.10.4
1.10.3
1.10.2
1.10.1
1.10.0
1.9.3
1.9.2
retired
1.9.1
1.9.0
1.8.0
1.7.17
1.7.16
1.7.15
1.7.14
retired
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
retired
1.7.1
retired
1.7.0
retired
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.11.0
0.10.1
0.10.0
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.3
0.8.2
0.8.1
0.8.0
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.5.2
0.5.1
0.5.0
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-rc.0
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.2.0
Craft and deploy bulletproof embedded software
Current section
Files
Jump to
Current section
Files
lib/mix/tasks/firmware.burn.ex
defmodule Mix.Tasks.Firmware.Burn do
use Mix.Task
import Mix.Nerves.Utils
@switches [device: :string, task: :string]
@aliases [d: :device, t: :task]
@shortdoc "Write a firmware image to an SDCard"
@moduledoc """
Writes the generated firmware image to an attached SDCard or file.
By default, this task detects attached SDCards and then invokes `fwup`
to overwrite the contents of the selected SDCard with the new image.
Data on the SDCard will be lost, so be careful.
## Command line options
* `--device <filename>` - skip SDCard detection and write the image to
the specified filename. SDCard paths depend on the operating system, but
have a form like `/dev/sdc` or `/dev/mmcblk0`. You may also specify a
filename to create an image that can be used with a bulk memory programmer
or copied to an SDCard manually with a utility like `dd`.
* `--task <name>` - apply the specified `fwup` task. See the `fwup.conf`
file that was used to create the firmware image for options. By
convention, the `complete` task writes everything to the SDCard including
bootloaders and application data partitions. The `upgrade` task only
modifies the parts of the SDCard required to run the new software.
## Examples
```
# Upgrade the contents of the SDCard located at /dev/mmcblk0
mix firmware.burn --device /dev/mmcblk0 --task upgrade
```
"""
def run(argv) do
preflight()
debug_info("Nerves Firmware Burn")
{opts, argv, _} = OptionParser.parse(argv, switches: @switches, aliases: @aliases)
config = Mix.Project.config()
otp_app = config[:app]
target = config[:target]
images_path =
(config[:images_path] || Path.join([Mix.Project.build_path(), "nerves", "images"]))
|> Path.expand()
check_nerves_system_is_set!()
check_nerves_toolchain_is_set!()
fw = "#{images_path}/#{otp_app}.fw"
unless File.exists?(fw) do
Mix.raise("Firmware for target #{target} not found at #{fw} run `mix firmware` to build")
end
# Create a temporary .fw file that fwup.exe is able to access
fw =
if is_wsl?() do
{win_path, wsl_path} = get_wsl_paths("#{otp_app}.fw")
File.copy(fw, wsl_path)
win_path
else
fw
end
dev =
case opts[:device] do
nil -> prompt_dev()
dev -> dev
end
burn(fw, dev, opts, argv)
# Remove the temporary .fw file
if is_wsl?() do
drive_letter =
Regex.run(~r/(.*?):/, fw)
|> Enum.at(1)
|> String.downcase()
fw = Regex.replace(~r/(.*?):/, fw, "/mnt/" <> drive_letter)
File.rm(fw)
end
end
defp burn(fw, dev, opts, argv) do
task = opts[:task] || "complete"
args = ["-a", "-i", fw, "-t", task, "-d", dev] ++ argv
{cmd, args} =
case :os.type() do
{_, :darwin} ->
{"fwup", args}
{_, :linux} ->
if is_wsl?() do
ps_cmd =
"Start-Process fwup -ArgumentList '#{Enum.join(args, " ")}' -Verb runAs -Wait"
{"powershell.exe", ["-Command", ps_cmd]}
else
case File.stat(dev) do
{:ok, %File.Stat{access: :read_write}} ->
{"fwup", args}
_ ->
ask_pass = System.get_env("SUDO_ASKPASS") || "/usr/bin/ssh-askpass"
System.put_env("SUDO_ASKPASS", ask_pass)
{"sudo", ["fwup"] ++ args}
end
end
{_, :nt} ->
{"fwup", args}
{_, type} ->
raise "Unable to burn firmware on your host #{inspect(type)}"
end
shell(cmd, args)
end
end