tlbmc/ad_hoc_fru_config.proto

edition = "2023";

package milotic_tlbmc;

import "google/protobuf/duration.proto";
import "i2c_common_config.proto";

// Enum to specify the type of FRU scanner to use for ad-hoc scanning.
enum AdHocScannerType {
  SCANNER_TYPE_DEFAULT_IPMI_I2C = 0;  // Scanning FRU via IPMI I2C.
  SCANNER_TYPE_CAVIUM_HSM_FRAM = 1;   // For the Cavium HSM FRAM
}

message PeriodicScanPeriod {
  // Number of times to scan the Fru
  uint32 scan_count = 1;
  // Time between scans
  google.protobuf.Duration scan_interval = 2;
}

message AdHocFruConfig {
  // Scanned Fru Name
  string name = 1;

  // Bus and Address of the Fru
  I2cCommonConfig i2c_common_config = 2;

  // Some Frus Require Delays in Between Byte Reads
  google.protobuf.Duration delay_between_reads = 3;

  // How many times and how often to scan fru
  repeated PeriodicScanPeriod periodic_scan_config = 4;

  // Type of scanner to use for this specific FRU.
  AdHocScannerType scanner_type = 5 [default = SCANNER_TYPE_DEFAULT_IPMI_I2C];
}