spi: amd: Add struct and enum kernel-doc comments

Provide documentation comments in the kernel-doc format
for enum amd_spi_versions and struct amd_spi.

Signed-off-by: Cristian Ciocaltea <cristian.ciocaltea@collabora.com>
Link: https://lore.kernel.org/r/20220706100626.1234731-6-cristian.ciocaltea@collabora.com
Signed-off-by: Mark Brown <broonie@kernel.org>

diff --git a/drivers/spi/spi-amd.c b/drivers/spi/spi-amd.c
index 6eddb950e1ad266ad6ec9e7a9ba2b1c2e9ac24c1..08df4f8d0531ca767f56a0e33d3d1b8f55f4647b 100644 (file)
--- a/drivers/spi/spi-amd.c
+++ b/drivers/spi/spi-amd.c
@@ -40,11 +40,21 @@
 #define AMD_SPI_XFER_TX                1
 #define AMD_SPI_XFER_RX                2
 
+/**
+ * enum amd_spi_versions - SPI controller versions
+ * @AMD_SPI_V1:                AMDI0061 hardware version
+ * @AMD_SPI_V2:                AMDI0062 hardware version
+ */
 enum amd_spi_versions {
-       AMD_SPI_V1 = 1, /* AMDI0061 */
-       AMD_SPI_V2,     /* AMDI0062 */
+       AMD_SPI_V1 = 1,
+       AMD_SPI_V2,
 };
 
+/**
+ * struct amd_spi - SPI driver instance
+ * @io_remap_addr:     Start address of the SPI controller registers
+ * @version:           SPI controller hardware version
+ */
 struct amd_spi {
        void __iomem *io_remap_addr;
        enum amd_spi_versions version;