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

//!  Provides methods to reset the ECU in order to simulate power cycling and resetting memory regions

use super::{UDSCommand, UdsDiagnosticServer, lookup_uds_nrc};
use crate::{DiagError, DiagServerResult, DiagnosticServer};

/// Options for resetting the ECU
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum ResetType {
    /// Signals the ECU to perform a hard-reset,
    /// simulating a forceful power off/on cycle
    ///
    /// This might result in both non-volatile memory and volatile memory locations being re-initialized
    HardReset,

    /// Signals the ECU to perform a simulated key off/on cycle,
    /// simulating the usual key-off/on cycle
    ///
    /// This typically results in the preservation of non-volatile memory,
    /// but volatile memory will be re-initialized
    KeyOffReset,

    /// Signals the ECU to perform a soft reset, simply rebooting the current
    /// application running on it.
    ///
    /// This will result in the preservation of both non-volatile and volatile memory
    SoftReset,

    /// Enables a rapid power shutdown on the ECU during a key-off cycle.
    ///
    /// IMPORTANT: Once this has been used, the diagnostic server **cannot** send
    /// any other messages other than ECUReset in order to not disturb the rapid power
    /// shutdown function.
    EnableRapidPowerShutDown,

    /// Disables a rapid power shutdown on the ECU during a key-off cycle.
    DisableRapidPowerShutDown,

    /// Other OEM defined power mode
    Other(u8),
}

impl From<ResetType> for u8 {
    fn from(from: ResetType) -> Self {
        match from {
            ResetType::HardReset => 0x01,
            ResetType::KeyOffReset => 0x02,
            ResetType::SoftReset => 0x03,
            ResetType::EnableRapidPowerShutDown => 0x04,
            ResetType::DisableRapidPowerShutDown => 0x05,
            ResetType::Other(x) => x,
        }
    }
}

/// Asks the ECU to perform a hard reset. See [ResetType::HardReset] for more details
///
/// ## Parameters
/// * server - The UDS Diagnostic server
pub fn ecu_hard_reset(server: &mut UdsDiagnosticServer) -> DiagServerResult<()> {
    server
        .execute_command_with_response(UDSCommand::ECUReset, &[ResetType::HardReset.into()])
        .map(|_| ())
}

/// Asks the ECU to perform a key off/on reset. See [ResetType::KeyOffReset] for more details
///
/// ## Parameters
/// * server - The UDS Diagnostic server
pub fn ecu_key_off_on_reset(server: &mut UdsDiagnosticServer) -> DiagServerResult<()> {
    server
        .execute_command_with_response(UDSCommand::ECUReset, &[ResetType::KeyOffReset.into()])
        .map(|_| ())
}

/// Asks the ECU to perform a soft reset. See [ResetType::SoftReset] for more details
///
/// ## Parameters
/// * server - The UDS Diagnostic server
pub fn ecu_soft_reset(server: &mut UdsDiagnosticServer) -> DiagServerResult<()> {
    server
        .execute_command_with_response(UDSCommand::ECUReset, &[ResetType::SoftReset.into()])
        .map(|_| ())
}

/// Asks the ECU to enable rapid power shutdown mode. See [ResetType::EnableRapidPowerShutDown] for more details
///
/// ## Parameters
/// * server - The UDS Diagnostic server
///
/// ## Returns
/// If successful, this function will return the minimum time in seconds that the ECU will remain in the power-down sequence
pub fn enable_rapid_power_shutdown(server: &mut UdsDiagnosticServer) -> DiagServerResult<u8> {
    let res = server.execute_command_with_response(
        UDSCommand::ECUReset,
        &[ResetType::EnableRapidPowerShutDown.into()],
    )?;
    match res.get(2) {
        Some(&time) if time == 0xFF => Err(DiagError::ECUError {code: 0x10, def: Some(lookup_uds_nrc(0x10))}), // General reject
        Some(&time) => Ok(time),
        None => Err(DiagError::InvalidResponseLength),
    }
}

/// Asks the ECU to disable rapid power shutdown mode
///
/// ## Parameters
/// * server - The UDS Diagnostic server
pub fn disable_rapid_power_shutdown(server: &mut UdsDiagnosticServer) -> DiagServerResult<()> {
    server
        .execute_command_with_response(
            UDSCommand::ECUReset,
            &[ResetType::DisableRapidPowerShutDown.into()],
        )
        .map(|_| ())
}