restorekit 0.2.0

Library for DFU-restoring Apple Silicon Macs: DFU trigger, detection, firmware download, and restore
Documentation 
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

pub mod discovery;

pub use discovery::{watch, Watch};

#[cfg(target_os = "macos")]
pub mod vdm;

#[cfg(target_os = "macos")]
pub(crate) mod port;

/// Human label of the host's DFU-capable port (e.g. "left-back"), if the host
/// can trigger DFU and the port topology is known. `None` on hosts that can't
/// trigger DFU or where the label couldn't be read.
pub fn dfu_port_label() -> Option<String> {
    #[cfg(target_os = "macos")]
    {
        port::dfu_port_location()
    }
    #[cfg(not(target_os = "macos"))]
    {
        None
    }
}

/// Whether this host can trigger DFU mode on a target over USB-PD.
///
/// Only Apple Silicon Macs running macOS can drive the Type-C port controller.
pub fn host_can_trigger_dfu() -> bool {
    cfg!(target_os = "macos") && cfg!(target_arch = "aarch64")
}

/// Manual DFU-entry instructions for hosts that can't trigger it electronically.
pub fn manual_dfu_instructions() -> &'static str {
    "This host cannot trigger DFU mode electronically (requires an Apple Silicon \
Mac running macOS). Put the target Mac into DFU mode manually:\n\
\n\
  1. Connect the target to this host with a USB-C cable using the target's DFU \
port:\n\
       - MacBook (Air/13\" Pro): the port nearest the screen on the left side.\n\
       - 14\"/16\" MacBook Pro: the port next to MagSafe.\n\
       - Mac mini/Studio: the port nearest the power button/HDMI.\n\
       - iMac: the port nearest the edge.\n\
  2. Disconnect the target from power.\n\
  3. Apple silicon laptop: hold the power button, then while holding it, connect \
power and keep holding ~10s.\n\
     Desktop: unplug power 10s, then press and hold the power button while \
reconnecting power.\n\
  4. Release. The screen stays black in DFU mode. Re-run this command to detect \
it."
}