core housekeeping

bsp_q7s/xadc/CMakeLists.txt

@@ -0,0 +1,3 @@
+target_sources(${OBSW_NAME} PRIVATE
+    Xadc.cpp
+)

bsp_q7s/xadc/Xadc.cpp

@@ -0,0 +1,144 @@
+#include "Xadc.h"
+
+#include <fcntl.h>
+#include <unistd.h>
+
+#include <sstream>
+
+#include "fsfw/serviceinterface/ServiceInterfaceStream.h"
+
+Xadc::Xadc() {}
+
+Xadc::~Xadc() {}
+
+ReturnValue_t Xadc::getTemperature(float& temperature) {
+  ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
+  int raw = 0;
+  int offset = 0;
+  float scale = 0;
+  result = readValFromFile<int>(xadc::file::tempRaw.c_str(), raw);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  result = readValFromFile<int>(xadc::file::tempOffset.c_str(), offset);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  result = readValFromFile<float>(xadc::file::tempScale.c_str(), scale);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  temperature = (raw + offset) * scale / 1000;
+  return result;
+}
+
+ReturnValue_t Xadc::getVccPint(float& vccPint) {
+  ReturnValue_t result =
+      readVoltageFromSysfs(xadc::file::vccpintRaw, xadc::file::vccpintScale, vccPint);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Xadc::getVccPaux(float& vccPaux) {
+  ReturnValue_t result =
+      readVoltageFromSysfs(xadc::file::vccpauxRaw, xadc::file::vccpauxScale, vccPaux);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Xadc::getVccInt(float& vccInt) {
+  ReturnValue_t result =
+      readVoltageFromSysfs(xadc::file::vccintRaw, xadc::file::vccintScale, vccInt);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Xadc::getVccAux(float& vccAux) {
+  ReturnValue_t result =
+      readVoltageFromSysfs(xadc::file::vccauxRaw, xadc::file::vccauxScale, vccAux);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Xadc::getVccBram(float& vccBram) {
+  ReturnValue_t result =
+      readVoltageFromSysfs(xadc::file::vccbramRaw, xadc::file::vccbramScale, vccBram);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Xadc::getVccOddr(float& vccOddr) {
+  ReturnValue_t result =
+      readVoltageFromSysfs(xadc::file::vccoddrRaw, xadc::file::vccoddrScale, vccOddr);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Xadc::getVrefp(float& vrefp) {
+  ReturnValue_t result = readVoltageFromSysfs(xadc::file::vrefpRaw, xadc::file::vrefpScale, vrefp);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Xadc::getVrefn(float& vrefn) {
+  ReturnValue_t result = readVoltageFromSysfs(xadc::file::vrefnRaw, xadc::file::vrefnScale, vrefn);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Xadc::readVoltageFromSysfs(std::string rawFile, std::string scaleFile,
+                                         float& voltage) {
+  ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
+  float raw = 0;
+  float scale = 0;
+  result = readValFromFile(rawFile.c_str(), raw);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  result = readValFromFile(scaleFile.c_str(), scale);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  voltage = calculateVoltage(raw, scale);
+  return result;
+}
+
+float Xadc::calculateVoltage(int raw, float scale) { return static_cast<float>(raw * scale); }
+
+template <typename T>
+ReturnValue_t Xadc::readValFromFile(const char* filename, T& val) {
+  FILE* fp;
+  fp = fopen(filename, "r");
+  if (fp == nullptr) {
+    sif::warning << "Xadc::readValFromFile: Failed to open file " << filename << std::endl;
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
+  char valstring[MAX_STR_LENGTH] = "";
+  char* returnVal = fgets(valstring, MAX_STR_LENGTH, fp);
+  if (returnVal == nullptr) {
+    sif::warning << "Xadc::readValFromFile: Failed to read string from file " << filename
+                 << std::endl;
+    fclose(fp);
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
+  std::istringstream valSstream(valstring);
+  valSstream >> val;
+  fclose(fp);
+  return HasReturnvaluesIF::RETURN_OK;
+}

bsp_q7s/xadc/Xadc.h

@@ -0,0 +1,107 @@
+#ifndef BSP_Q7S_XADC_XADC_H_
+#define BSP_Q7S_XADC_XADC_H_
+
+#include <string>
+#include "fsfw/returnvalues/HasReturnvaluesIF.h"
+
+namespace xadc {
+using namespace std;
+static const string iioPath = "/sys/bus/iio/devices/iio:device1";
+namespace file {
+static const string tempOffset = iioPath + "/in_temp0_offset";
+static const string tempRaw = iioPath + "/in_temp0_raw";
+static const string tempScale = iioPath + "/in_temp0_scale";
+static const string vccintRaw = iioPath + "/in_voltage0_vccint_raw";
+static const string vccintScale = iioPath + "/in_voltage0_vccint_scale";
+static const string vccauxRaw = iioPath + "/in_voltage1_vccaux_raw";
+static const string vccauxScale = iioPath + "/in_voltage1_vccaux_scale";
+static const string vccbramRaw = iioPath + "/in_voltage2_vccbram_raw";
+static const string vccbramScale = iioPath + "/in_voltage2_vccbram_scale";
+static const string vccpintRaw = iioPath + "/in_voltage3_vccpint_raw";
+static const string vccpintScale = iioPath + "/in_voltage3_vccpint_scale";
+static const string vccpauxRaw = iioPath + "/in_voltage4_vccpaux_raw";
+static const string vccpauxScale = iioPath + "/in_voltage4_vccpaux_scale";
+static const string vccoddrRaw = iioPath + "/in_voltage5_vccoddr_raw";
+static const string vccoddrScale = iioPath + "/in_voltage5_vccoddr_scale";
+static const string vrefpRaw = iioPath + "/in_voltage6_vrefp_raw";
+static const string vrefpScale = iioPath + "/in_voltage6_vrefp_scale";
+static const string vrefnRaw = iioPath + "/in_voltage7_vrefn_raw";
+static const string vrefnScale = iioPath + "/in_voltage7_vrefn_scale";
+}  // namespace file
+}  // namespace xadc
+
+/**
+ * @brief   Class providing access to the data generated by the analog mixed signal module (XADC).
+ *
+ * @details Details about the XADC peripheral of the Zynq-7020 can be found in the UG480 "7-Series
+ *          FPGAs and Zynq-7000 SoC XADC Dual 12-Bit 1 MSPS Analog-to-Digital Converter" user guide
+ *          from Xilinx.
+ *
+ * @author  J. Meier
+ */
+class Xadc {
+ public:
+  /**
+   * @brief Constructor
+   */
+  Xadc();
+  virtual ~Xadc();
+
+  /**
+   * @brief Returns on-chip temperature degree celcius
+   */
+  ReturnValue_t getTemperature(float& temperature);
+
+  /**
+   * @brief Returns PS internal logic supply voltage in millivolts
+   */
+  ReturnValue_t getVccPint(float& vccPint);
+
+  /**
+   * @brief Returns PS auxiliary supply voltage in millivolts
+   */
+  ReturnValue_t getVccPaux(float& vccPaux);
+
+  /**
+   * @brief Returns PL internal supply voltage in millivolts
+   */
+  ReturnValue_t getVccInt(float& vccInt);
+
+  /**
+   * @brief Returns PL auxiliary supply voltage in millivolts
+   */
+  ReturnValue_t getVccAux(float& vccAux);
+
+  /**
+   * @brief Returns PL block RAM supply voltage in millivolts
+   */
+  ReturnValue_t getVccBram(float& vccBram);
+
+  /**
+   * @brief Returns the PS DDR I/O supply voltage
+   */
+  ReturnValue_t getVccOddr(float& vcOddr);
+
+  /**
+   * @brief Returns XADC reference input voltage relative to GND in millivolts
+   */
+  ReturnValue_t getVrefp(float& vrefp);
+
+  /**
+   * @brief Returns negative reference input voltage. Should normally be 0 V.
+   */
+  ReturnValue_t getVrefn(float& vrefn);
+
+ private:
+  // Maximum length of the string representation of a value in a xadc sysfs file
+  static const uint8_t MAX_STR_LENGTH = 15;
+
+  ReturnValue_t readVoltageFromSysfs(std::string rawFile, std::string scaleFile, float& voltage);
+
+  float calculateVoltage(int raw, float scale);
+
+  template <typename T>
+  ReturnValue_t readValFromFile(const char* filename, T& val);
+};
+
+#endif /* BSP_Q7S_XADC_XADC_H_ */