Added HAL docs, improved HAL init&locking (#218)

TactilityHeadless/Private/Tactility/hal/gps/GpsInit.h

@@ -4,6 +4,11 @@
 
 namespace tt::hal::gps {
 
+/**
+ * Called by main HAL init to ready the internal state of the GPS HAL.
+ * @param[in] configurations HAL configuration for a board
+ * @return true on success
+ */
 bool init(const std::vector<GpsDevice::Configuration>& configurations);
 
 }

TactilityHeadless/Private/Tactility/hal/i2c/I2cInit.h

@@ -0,0 +1,15 @@
+#pragma once
+
+#include "Tactility/hal/i2c/I2c.h"
+#include <vector>
+
+namespace tt::hal::i2c {
+
+/**
+ * Called by main HAL init to ready the internal state of the I2C HAL.
+ * @param[in] configurations HAL configuration for a board
+ * @return true on success
+ */
+bool init(const std::vector<i2c::Configuration>& configurations);
+
+}

TactilityHeadless/Private/Tactility/hal/spi/SpiInit.h

@@ -0,0 +1,17 @@
+#pragma once
+
+#include "Tactility/hal/spi/Spi.h"
+
+#include <vector>
+#include <memory>
+
+namespace tt::hal::spi {
+
+/**
+ * Called by main HAL init to ready the internal state of the SPI HAL.
+ * @param[in] configurations HAL configuration for a board
+ * @return true on success
+ */
+bool init(const std::vector<spi::Configuration>& configurations);
+
+}

TactilityHeadless/Private/Tactility/hal/uart/UartInit.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include "Tactility/hal/uart/Uart.h"
+
+namespace tt::hal::uart {
+
+bool init(const std::vector<uart::Configuration>& configurations);
+
+}