Diff: inc/gpio.h

Revision:

9:9e247b9c9abf

Parent:

8:70fc373a5f46

diff -r 70fc373a5f46 -r 9e247b9c9abf inc/gpio.h
--- a/inc/gpio.h	Wed Feb 26 06:09:13 2020 +0000
+++ b/inc/gpio.h	Mon Jun 15 13:03:55 2020 +0000
@@ -1,5 +1,6 @@
 /***************************************************************************//**
  *   @file   gpio.h
+ *   @brief  Header file of GPIO Interface
  *   @author DBogdan (dragos.bogdan@analog.com)
 ********************************************************************************
  * Copyright 2019(c) Analog Devices, Inc.
@@ -59,13 +60,25 @@
 /*************************** Types Declarations *******************************/
 /******************************************************************************/
 
+/**
+ * @struct gpio_init_param
+ * @brief Structure holding the parameters for GPIO initialization.
+ */
 typedef struct gpio_init_param {
+	/** GPIO number */
 	uint8_t		number;
+	/** GPIO extra parameters (device specific) */
 	void		*extra;
 } gpio_init_param;
 
+/**
+ * @struct gpio_desc
+ * @brief Structure holding the GPIO descriptor.
+ */
 typedef struct gpio_desc {
+	/** GPIO number */
 	uint8_t		number;
+	/** GPIO extra parameters (device specific) */
 	void		*extra;
 } gpio_desc;
 
@@ -75,7 +88,11 @@
 
 /* Obtain the GPIO decriptor. */
 int32_t gpio_get(struct gpio_desc **desc,
-		 const gpio_init_param *param);
+		 const struct gpio_init_param *param);
+
+/* Obtain optional GPIO descriptor. */
+int32_t gpio_get_optional(struct gpio_desc **desc,
+			  const struct gpio_init_param *param);
 
 /* Free the resources allocated by gpio_get() */
 int32_t gpio_remove(struct gpio_desc *desc);