net/mlx5: FPGA, Add doxygen for access type enum

[sfrench/cifs-2.6.git] / drivers / net / ethernet / mellanox / mlx5 / core / fpga / sdk.h

diff --git a/drivers/net/ethernet/mellanox/mlx5/core/fpga/sdk.h b/drivers/net/ethernet/mellanox/mlx5/core/fpga/sdk.h
index a0573cc2fc9bc799fde4267e5707c2d140e3fcc8..656f96be6e200232c3de0ccfb639e898fd50c5a3 100644 (file)
--- a/drivers/net/ethernet/mellanox/mlx5/core/fpga/sdk.h
+++ b/drivers/net/ethernet/mellanox/mlx5/core/fpga/sdk.h
@@ -44,8 +44,14 @@
 #define SBU_QP_QUEUE_SIZE 8
 #define MLX5_FPGA_CMD_TIMEOUT_MSEC (60 * 1000)
 
+/**
+ * enum mlx5_fpga_access_type - Enumerated the different methods possible for
+ * accessing the device memory address space
+ */
 enum mlx5_fpga_access_type {
+       /** Use the slow CX-FPGA I2C bus */
        MLX5_FPGA_ACCESS_TYPE_I2C = 0x0,
+       /** Use the fastest available method */
        MLX5_FPGA_ACCESS_TYPE_DONTCARE = 0x0,
 };