From 8efed8802d18a625c228353332b74854217fe28f Mon Sep 17 00:00:00 2001
From: Henrik Stickann <4376396-Mithradir@users.noreply.gitlab.com>
Date: Tue, 10 May 2022 15:36:34 +0200
Subject: [PATCH] Add SPI subdir

---
 .../sta/{spi_device.hpp => spi/device.hpp}    |  7 ++-
 .../spi_interface.hpp => spi/interface.hpp}   |  7 ++-
 .../{spi_settings.hpp => spi/settings.hpp}    | 58 ++++++++++---------
 src/{spi_device.cpp => spi/device.cpp}        |  2 +-
 .../spi_interface.cpp => spi/interface.cpp}   |  2 +-
 src/{spi_settings.cpp => spi/settings.cpp}    |  2 +-
 6 files changed, 43 insertions(+), 35 deletions(-)
 rename include/sta/{spi_device.hpp => spi/device.hpp} (95%)
 rename include/sta/{intf/spi_interface.hpp => spi/interface.hpp} (95%)
 rename include/sta/{spi_settings.hpp => spi/settings.hpp} (61%)
 rename src/{spi_device.cpp => spi/device.cpp} (98%)
 rename src/{intf/spi_interface.cpp => spi/interface.cpp} (88%)
 rename src/{spi_settings.cpp => spi/settings.cpp} (97%)

diff --git a/include/sta/spi_device.hpp b/include/sta/spi/device.hpp
similarity index 95%
rename from include/sta/spi_device.hpp
rename to include/sta/spi/device.hpp
index fad753d..2c4c589 100644
--- a/include/sta/spi_device.hpp
+++ b/include/sta/spi/device.hpp
@@ -1,11 +1,12 @@
 /**
- * @brief SPI interface definitions.
+ * @file
+ * @brief SPI device interface.
  */
 #ifndef STA_SPI_DEVICE_HPP
 #define STA_SPI_DEVICE_HPP
 
 #include <sta/intf/gpio_pin.hpp>
-#include <sta/intf/spi_interface.hpp>
+#include <sta/spi/interface.hpp>
 
 #include <cstddef>
 #include <cstdint>
@@ -15,6 +16,8 @@ namespace sta
 {
 	/**
 	 * @brief Interface for SPI devices.
+	 *
+	 * @ingroup staCoreSPI
 	 */
 	class SpiDevice
 	{
diff --git a/include/sta/intf/spi_interface.hpp b/include/sta/spi/interface.hpp
similarity index 95%
rename from include/sta/intf/spi_interface.hpp
rename to include/sta/spi/interface.hpp
index 047df2d..a7a7d03 100644
--- a/include/sta/intf/spi_interface.hpp
+++ b/include/sta/spi/interface.hpp
@@ -1,11 +1,12 @@
 /**
- * @brief SPI interface definitions.
+ * @file
+ * @brief SPI interface definition.
  */
 #ifndef STA_SPI_INTERFACE_HPP
 #define STA_SPI_INTERFACE_HPP
 
 #include <sta/intf/mutex.hpp>
-#include <sta/spi_settings.hpp>
+#include <sta/spi/settings.hpp>
 
 #include <cstddef>
 #include <cstdint>
@@ -15,6 +16,8 @@ namespace sta
 {
 	/**
 	 * @brief Interface for SPI hardware.
+	 *
+	 * @ingroup staCoreSPI
 	 */
 	class SpiInterface
 	{
diff --git a/include/sta/spi_settings.hpp b/include/sta/spi/settings.hpp
similarity index 61%
rename from include/sta/spi_settings.hpp
rename to include/sta/spi/settings.hpp
index decec26..172309f 100644
--- a/include/sta/spi_settings.hpp
+++ b/include/sta/spi/settings.hpp
@@ -1,21 +1,35 @@
 /**
- * @brief SPI setting types.
+ * @file
+ * @brief SPI settings.
  */
 #ifndef STA_SPI_SETTINGS_HPP
 #define STA_SPI_SETTINGS_HPP
 
+/**
+ * @defgroup staCoreSPI SPI
+ * @ingroup staCore
+ * @brief SPI interface.
+ */
+
+
 #include <cstdint>
 
 
 namespace sta
 {
+	/**
+	 * @ingroup staCoreSPI
+	 * @{
+	 */
+
+
 	/**
 	 * @brief SPI clock polarity.
 	 */
 	enum class SpiClkPolarity
 	{
-		LOW,
-		HIGH
+		LOW,    /**< Low idle clock */
+		HIGH    /**< High idle clock */
 	};
 
 	/**
@@ -23,8 +37,8 @@ namespace sta
 	 */
 	enum class SpiClkPhase
 	{
-		EDGE_1,
-		EDGE_2
+		EDGE_1, /**< Sample on first edge, shift out on second edge */
+		EDGE_2  /**< Shift out on first edge, sample on second edge */
 	};
 
 	/**
@@ -32,10 +46,10 @@ namespace sta
 	 */
 	enum class SpiMode
 	{
-		MODE_0,
-		MODE_1,
-		MODE_2,
-		MODE_3
+		MODE_0,	/**< Low idle clock, sample on rising edge, shift out on falling edge */
+		MODE_1,	/**< Low idle clock, sample on falling edge, shift out on rising edge */
+		MODE_2,	/**< High idle clock, sample on rising edge, shift out on falling edge */
+		MODE_3 	/**< High idle clock, sample on falling edge, shift out on rising edge */
 	};
 
 	/**
@@ -43,8 +57,8 @@ namespace sta
 	 */
 	enum class SpiDataSize
 	{
-		SIZE_8,
-		SIZE_16
+		SIZE_8, /**< 8-bit data size */
+		SIZE_16 /**< 16-bit data size */
 	};
 
 	/**
@@ -52,23 +66,8 @@ namespace sta
 	 */
 	enum class SpiBitOrder
 	{
-		MSB,
-		LSB
-	};
-
-	/**
-	 * @brief Spi baud rate prescaler.
-	 */
-	enum class SpiBaudRatePrescaler
-	{
-		DIV_2,
-		DIV_4,
-		DIV_8,
-		DIV_16,
-		DIV_32,
-		DIV_64,
-		DIV_128,
-		DIV_256
+		MSB,    /**< Send most significant bit first */
+		LSB     /**< Send least significant bit first */
 	};
 
 
@@ -106,6 +105,9 @@ namespace sta
 	 * @return          SPI clock mode
 	 */
 	SpiMode        getSpiMode(SpiClkPolarity polarity, SpiClkPhase phase);
+
+
+	/** @} */
 } // namespace sta
 
 
diff --git a/src/spi_device.cpp b/src/spi/device.cpp
similarity index 98%
rename from src/spi_device.cpp
rename to src/spi/device.cpp
index 75fdec5..1c3f95d 100644
--- a/src/spi_device.cpp
+++ b/src/spi/device.cpp
@@ -1,4 +1,4 @@
-#include <sta/spi_device.hpp>
+#include <sta/spi/device.hpp>
 
 #include <sta/assert.hpp>
 
diff --git a/src/intf/spi_interface.cpp b/src/spi/interface.cpp
similarity index 88%
rename from src/intf/spi_interface.cpp
rename to src/spi/interface.cpp
index 041c7d7..a50da61 100644
--- a/src/intf/spi_interface.cpp
+++ b/src/spi/interface.cpp
@@ -1,4 +1,4 @@
-#include <sta/intf/spi_interface.hpp>
+#include <sta/spi/interface.hpp>
 
 
 namespace sta
diff --git a/src/spi_settings.cpp b/src/spi/settings.cpp
similarity index 97%
rename from src/spi_settings.cpp
rename to src/spi/settings.cpp
index 73478e7..5d29a0a 100644
--- a/src/spi_settings.cpp
+++ b/src/spi/settings.cpp
@@ -1,4 +1,4 @@
-#include <sta/spi_settings.hpp>
+#include <sta/spi/settings.hpp>
 
 #include <sta/assert.hpp>
 #include <sta/lang.hpp>