drone 0.14.0

CLI utility for Drone, an Embedded Operating System. 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

//! Segger J-Link.

use super::{
    begin_log_output, gdb_script_command, gdb_script_continue, gdb_script_wait, run_gdb_client,
    run_gdb_server, rustc_substitute_path, setup_serial_endpoint,
};
use crate::{
    cli::{FlashCmd, GdbCmd, LogCmd, ResetCmd},
    color::Color,
    log,
    templates::Registry,
    utils::{
        block_with_signals, exhaust_fifo, make_fifo, run_command, search_rust_tool, spawn_command,
        temp_dir,
    },
};
use anyhow::Result;
use drone_config as config;
use signal_hook::iterator::Signals;
use std::{fs, os::unix::fs::PermissionsExt, path::Path, process::Command};
use tempfile::tempdir_in;

/// Runs `drone reset` command.
pub fn reset(
    cmd: ResetCmd,
    mut signals: Signals,
    registry: Registry<'_>,
    config: config::Config,
) -> Result<()> {
    let ResetCmd {} = cmd;
    let config_probe_jlink = config.probe.as_ref().unwrap().jlink.as_ref().unwrap();
    let script = registry.jlink_reset()?;
    let mut commander = Command::new(&config_probe_jlink.commander_command);
    jlink_args(&mut commander, config_probe_jlink);
    commander_script(&mut commander, script.path());
    block_with_signals(&mut signals, true, || run_command(commander))
}

/// Runs the command.
pub fn flash(
    cmd: FlashCmd,
    mut signals: Signals,
    registry: Registry<'_>,
    config: config::Config,
) -> Result<()> {
    let FlashCmd { firmware } = cmd;
    let config_probe_jlink = config.probe.as_ref().unwrap().jlink.as_ref().unwrap();
    let firmware_bin = &firmware.with_extension("bin");
    let script = registry.jlink_flash(firmware_bin, config.memory.flash.origin)?;

    let mut objcopy = Command::new(search_rust_tool("llvm-objcopy")?);
    objcopy.arg(firmware);
    objcopy.arg(firmware_bin);
    objcopy.arg("--output-target=binary");
    block_with_signals(&mut signals, true, || run_command(objcopy))?;
    fs::set_permissions(firmware_bin, fs::Permissions::from_mode(0o644))?;

    let mut commander = Command::new(&config_probe_jlink.commander_command);
    jlink_args(&mut commander, config_probe_jlink);
    commander_script(&mut commander, script.path());
    block_with_signals(&mut signals, true, || run_command(commander))
}

/// Runs `drone gdb` command.
pub fn gdb(
    cmd: GdbCmd,
    mut signals: Signals,
    registry: Registry<'_>,
    config: config::Config,
) -> Result<()> {
    let GdbCmd { firmware, reset, interpreter, gdb_args } = cmd;
    let config_probe_jlink = config.probe.as_ref().unwrap().jlink.as_ref().unwrap();

    let mut gdb_server = Command::new(&config_probe_jlink.gdb_server_command);
    jlink_args(&mut gdb_server, config_probe_jlink);
    gdb_server_args(&mut gdb_server, config_probe_jlink);
    let _gdb_server = run_gdb_server(gdb_server, interpreter.as_ref().map(String::as_ref))?;

    let script = registry.jlink_gdb(&config, reset, &rustc_substitute_path()?)?;
    run_gdb_client(
        &mut signals,
        &config,
        &gdb_args,
        firmware.as_deref(),
        interpreter.as_ref().map(String::as_ref),
        script.path(),
    )
}

/// Runs `drone log` command.
pub fn log_dso_serial(
    cmd: LogCmd,
    mut signals: Signals,
    registry: Registry<'_>,
    config: config::Config,
    color: Color,
) -> Result<()> {
    let LogCmd { reset, outputs } = cmd;
    let config_probe_jlink = config.probe.as_ref().unwrap().jlink.as_ref().unwrap();
    let config_log_dso = config.log.as_ref().unwrap().dso.as_ref().unwrap();

    let mut gdb_server = Command::new(&config_probe_jlink.gdb_server_command);
    jlink_args(&mut gdb_server, config_probe_jlink);
    gdb_server_args(&mut gdb_server, config_probe_jlink);
    let _gdb_server = run_gdb_server(gdb_server, None)?;

    let dir = tempdir_in(temp_dir())?;
    let pipe = make_fifo(&dir, "pipe")?;
    let ports = outputs.iter().flat_map(|output| output.ports.iter().copied()).collect();
    let script = registry.jlink_dso(&config, &ports, reset, &pipe)?;
    let mut gdb = spawn_command(gdb_script_command(&config, None, script.path()))?;

    let (pipe, packet) = gdb_script_wait(&mut signals, pipe)?;
    setup_serial_endpoint(&mut signals, &config_log_dso.serial_endpoint, config_log_dso.baud_rate)?;
    exhaust_fifo(&config_log_dso.serial_endpoint)?;
    log::capture(
        config_log_dso.serial_endpoint.clone().into(),
        log::Output::open_all(&outputs)?,
        log::dso::parser,
    );
    begin_log_output(color);
    gdb_script_continue(&mut signals, pipe, packet)?;

    block_with_signals(&mut signals, true, move || {
        gdb.wait()?;
        Ok(())
    })?;

    Ok(())
}

fn jlink_args(jlink: &mut Command, config_probe_jlink: &config::ProbeJlink) {
    jlink.arg("-Device").arg(&config_probe_jlink.device);
    jlink.arg("-Speed").arg(config_probe_jlink.speed.to_string());
    jlink.arg("-If").arg(&config_probe_jlink.interface);
    if config_probe_jlink.interface == "JTAG" {
        jlink.arg("-JTAGConf").arg("-1,-1");
    }
}

fn gdb_server_args(gdb_server: &mut Command, config_probe_jlink: &config::ProbeJlink) {
    gdb_server.arg("-LocalHostOnly").arg("1");
    gdb_server.arg("-Silent").arg("1");
    gdb_server.arg("-Port").arg(config_probe_jlink.port.to_string());
    gdb_server.arg("-NoReset").arg("1");
}

fn commander_script(commander: &mut Command, script: &Path) {
    commander.arg("-AutoConnect").arg("1");
    commander.arg("-ExitOnError").arg("1");
    commander.arg("-CommandFile").arg(script);
}