start of front io power control BSP WIP

Author: Aaron-Hartwig

Cargo.lock

@@ -34,6 +34,7 @@ pub enum FrontIOError {
     InvalidPhysicalToLogicalMap,
     InvalidModuleResult,
     LedInitFailure,
+    PowerFault,
 
     #[idol(server_death)]
     ServerRestarted,

drv/front-io-api/src/lib.rs

@@ -19,6 +19,7 @@ drv-fpga-api = { path = "../fpga-api" }
 drv-fpga-user-api = { path = "../fpga-user-api" }
 drv-i2c-api = { path = "../i2c-api" }
 drv-i2c-devices = { path = "../i2c-devices" }
+drv-sidecar-mainboard-controller = { path = "../../drv/sidecar-mainboard-controller" }
 drv-transceivers-api = { path = "../../drv/transceivers-api" }
 multitimer = { path = "../../lib/multitimer" }
 ringbuf = { path = "../../lib/ringbuf" }

drv/front-io-server/Cargo.toml

@@ -3,6 +3,7 @@
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
 fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
+    build_util::expose_target_board();
     build_util::build_notifications()?;
 
     let disposition = build_i2c::Disposition::Devices;

drv/front-io-server/build.rs

@@ -0,0 +1,6 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+// This file should never be included; if it is, the build configuration is bad
+compile_error!("no BSP for the given target board");

drv/front-io-server/src/bsp.rs

@@ -0,0 +1,56 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+use drv_fpga_api::{FpgaError, FpgaUserDesign};
+use drv_fpga_user_api::power_rail::{PowerRailStatus, RawPowerRailState};
+use drv_front_io_api::FrontIOError;
+use drv_sidecar_mainboard_controller::{Addr, MainboardController, Reg};
+use userlib::task_slot;
+
+task_slot!(MAINBOARD, mainboard);
+
+pub struct Bsp {
+    fpga: FpgaUserDesign,
+}
+
+impl Bsp {
+    pub fn new() -> Result<Self, FrontIOError> {
+        Ok(Self {
+            fpga: FpgaUserDesign::new(
+                MAINBOARD.get_task_id(),
+                MainboardController::DEVICE_INDEX,
+            ),
+        })
+    }
+
+    #[inline]
+    fn raw_state(&self) -> Result<RawPowerRailState, FpgaError> {
+        self.fpga.read(Addr::FRONT_IO_STATE)
+    }
+
+    #[inline]
+    pub fn status(&self) -> Result<PowerRailStatus, FpgaError> {
+        PowerRailStatus::try_from(self.raw_state()?)
+    }
+
+    pub fn power_good(&self) -> Result<bool, FrontIOError> {
+        match self.status().map_err(FrontIOError::from)? {
+            PowerRailStatus::Enabled => Ok(true),
+            PowerRailStatus::Disabled | PowerRailStatus::RampingUp => Ok(false),
+            PowerRailStatus::GoodTimeout | PowerRailStatus::Aborted => {
+                Err(FrontIOError::PowerFault)
+            }
+        }
+    }
+
+    pub fn set_power_enable(&self, enable: bool) -> Result<(), FrontIOError> {
+        self.fpga
+            .write(
+                enable.into(),
+                Addr::FRONT_IO_STATE,
+                Reg::FRONT_IO_STATE::ENABLE,
+            )
+            .map_err(FrontIOError::from)
+    }
+}

drv/front-io-server/src/bsp/sidecar_bcd.rs

@@ -7,6 +7,18 @@
 #![no_std]
 #![no_main]
 
+#[cfg_attr(
+    any(
+        target_board = "sidecar-b",
+        target_board = "sidecar-c",
+        target_board = "sidecar-d"
+    ),
+    path = "bsp/sidecar_bcd.rs"
+)]
+#[cfg_attr(target_board = "medusa-a", path = "bsp/medusa_a.rs")]
+mod bsp;
+
+use crate::bsp::Bsp;
 use core::convert::Infallible;
 use drv_fpga_api::{DeviceState, FpgaError, WriteOp};
 use drv_front_io_api::{
@@ -38,6 +50,9 @@ include!(concat!(env!("OUT_DIR"), "/i2c_config.rs"));
 #[derive(Copy, Clone, PartialEq)]
 enum Trace {
     None,
+    BspInit,
+    BspInitComplete,
+    BspInitFailed,
     FpgaInitError(FpgaError),
     PhyOscGood,
     PhyOscBad,
@@ -69,6 +84,9 @@ enum Trace {
 ringbuf!(Trace, 32, Trace::None);
 
 struct ServerImpl {
+    /// A BSP to help deliver core functionality whose implementation varies from board to board
+    bsp: Bsp,
+
     /// Handle for the auxflash task
     auxflash_task: userlib::TaskId,
 
@@ -254,6 +272,25 @@ impl ServerImpl {
 }
 
 impl idl::InOrderFrontIOImpl for ServerImpl {
+    /// Enable or disable the front IO power per `enable`
+    fn set_power_enable(
+        &mut self,
+        _: &RecvMessage,
+        enable: bool,
+    ) -> Result<(), RequestError<FrontIOError>> {
+        self.bsp
+            .set_power_enable(enable)
+            .map_err(RequestError::from)
+    }
+
+    /// Returns if front IO power is good
+    fn power_good(
+        &mut self,
+        _: &RecvMessage,
+    ) -> Result<bool, RequestError<FrontIOError>> {
+        self.bsp.power_good().map_err(RequestError::from)
+    }
+
     /// Blow away server state, resulting in a resequencing
     fn board_reset(
         &mut self,
@@ -794,11 +831,23 @@ impl NotificationHandler for ServerImpl {
 
 impl Default for ServerImpl {
     fn default() -> Self {
+        ringbuf_entry!(Trace::BspInit);
+        let bsp = match Bsp::new() {
+            Ok(bsp) => {
+                ringbuf_entry!(Trace::BspInitComplete);
+                bsp
+            }
+            Err(_) => {
+                ringbuf_entry!(Trace::BspInitFailed);
+                panic!();
+            }
+        };
         let i2c_task = I2C.get_task_id();
         let fpga_task = FRONT_IO.get_task_id();
         let auxflash_task = AUXFLASH.get_task_id();
 
         ServerImpl {
+            bsp,
             auxflash_task,
             controllers: [
                 FrontIOController::new(fpga_task, 0),

drv/front-io-server/src/main.rs

@@ -9,7 +9,6 @@ use drv_fpga_api::*;
 include!(concat!(env!("OUT_DIR"), "/sidecar_mainboard_controller.rs"));
 
 pub mod fan_modules;
-pub mod front_io_hsc;
 pub mod ignition;
 pub mod tofino2;
 

drv/sidecar-mainboard-controller/src/front_io_hsc.rs

@@ -34,9 +34,9 @@ pub enum SeqError {
     SequencerTimeout,
     InvalidTofinoVid,
     SetVddCoreVoutFailed,
-    NoFrontIOBoard, // TODO: implement this in the front IO server
-    FrontIOBoardPowerFault, // TODO: implement this in the front IO server
-    FrontIOPowerNotGood, // TODO: implement this in the front IO server
+    NoFrontIOBoard,
+    FrontIOBoardPowerFault,
+    FrontIOPowerNotGood,
     FrontIOError,
 
     #[idol(server_death)]