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

// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0

use anyhow::{bail, Result};
use std::rc::Rc;

use crate::io::gpio::{GpioPin, PinMode, PullMode};
use crate::transport::hyperdebug::{Flavor, Inner, StandardFlavor, VID_GOOGLE};
use crate::transport::{TransportError, TransportInterfaceType};

/// The C2D2 (Case Closed Debugging Debugger) is used to bring up OT and EC chips sitting
/// inside a computing device, such that those OT chips can provide Case Closed Debugging
/// support to allow bringup of the rest of the computing device.  C2D2 devices happen to speak
/// almost exactly the same USB protocol as HyperDebug.  This `Flavor` implementation defines
/// the few deviations: USB PID value, and the handling of OT reset signal.
pub struct C2d2Flavor {}

impl C2d2Flavor {
    const PID_C2D2: u16 = 0x5041;
}

impl Flavor for C2d2Flavor {
    fn gpio_pin(inner: &Rc<Inner>, pinname: &str) -> Result<Rc<dyn GpioPin>> {
        if pinname == "SPIVREF_RSVD_H1VREF_H1_RST_ODL" {
            return Ok(Rc::new(C2d2ResetPin::open(inner)?));
        }
        StandardFlavor::gpio_pin(inner, pinname)
    }

    fn spi_index(_inner: &Rc<Inner>, instance: &str) -> Result<(u8, u8)> {
        if instance == "0" {
            return Ok((super::spi::USB_SPI_REQ_ENABLE, 0));
        }
        bail!(TransportError::InvalidInstance(
            TransportInterfaceType::Spi,
            instance.to_string()
        ))
    }

    fn get_default_usb_vid() -> u16 {
        VID_GOOGLE
    }

    fn get_default_usb_pid() -> u16 {
        Self::PID_C2D2
    }
    fn perform_initial_fw_check() -> bool {
        // The c2d2 firmware and hyperdebug firmware are different, so do not check.
        false
    }
}

pub struct C2d2ResetPin {
    inner: Rc<Inner>,
}

impl C2d2ResetPin {
    pub fn open(inner: &Rc<Inner>) -> Result<Self> {
        Ok(Self {
            inner: Rc::clone(inner),
        })
    }
}

impl GpioPin for C2d2ResetPin {
    /// Reads the value of the reset pin.
    fn read(&self) -> Result<bool> {
        let line = self
            .inner
            .cmd_one_line_output("gpioget SPIVREF_RSVD_H1VREF_H1_RST_ODL")
            .map_err(|_| {
                TransportError::CommunicationError("No output from gpioget".to_string())
            })?;
        Ok(line.trim_start().starts_with('1'))
    }

    /// Sets the value of the GPIO reset pin by means of the special h1_reset command.
    fn write(&self, value: bool) -> Result<()> {
        self.inner
            .cmd_one_line_output(&format!("h1_reset {}", if value { 0 } else { 1 }))?;
        Ok(())
    }

    /// Sets the mode of the GPIO pin as input, output, or open drain I/O.
    fn set_mode(&self, _mode: PinMode) -> Result<()> {
        bail!(TransportError::UnsupportedOperation)
    }

    /// Sets the weak pull resistors of the GPIO pin.
    fn set_pull_mode(&self, _mode: PullMode) -> Result<()> {
        bail!(TransportError::UnsupportedOperation)
    }
}