Diff: inc/adi_sense_gpio.h

Revision:

18:fa3a317ebeaa

Parent:

7:4dbae381f693

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/inc/adi_sense_gpio.h	Fri Dec 15 22:41:56 2017 +0000
@@ -0,0 +1,181 @@
+/*!
+ ******************************************************************************
+ * @file:   adi_sense_gpio.h
+ * @brief:  ADI Sense OS-dependent wrapper layer for GPIO interface
+ *-----------------------------------------------------------------------------
+ */
+
+/*
+Copyright (c) 2017 Emutex Ltd. / Analog Devices, Inc.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+  - Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+  - Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+  - Modified versions of the software must be conspicuously marked as such.
+  - This software is licensed solely and exclusively for use with processors
+    manufactured by or for Analog Devices, Inc.
+  - This software may not be combined or merged with other code in any manner
+    that would cause the software to become subject to terms and conditions
+    which differ from those listed here.
+  - Neither the name of Analog Devices, Inc. nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+  - The use of this software may or may not infringe the patent rights of one
+    or more patent holders.  This license does not release you from the
+    requirement that you obtain separate licenses from these patent holders
+    to use this software.
+
+THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
+TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL
+PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef __ADI_SENSE_GPIO_H__
+#define __ADI_SENSE_GPIO_H__
+
+#include "inc/adi_sense_types.h"
+#include "inc/adi_sense_platform.h"
+
+/*! @ingroup ADI_Sense_Host */
+
+/*! @addtogroup ADI_Sense_Gpio ADI Sense Host GPIO interface functions
+ *  @{
+ */
+
+/*! GPIO pin identifiers */
+typedef enum
+{
+    ADI_SENSE_GPIO_PIN_RESET = 0, /*!< RESET GPIO output signal */
+    ADI_SENSE_GPIO_PIN_ERROR,     /*!< ERROR GPIO input signal */
+    ADI_SENSE_GPIO_PIN_ALERT,     /*!< ALERT GPIO input signal */
+    ADI_SENSE_GPIO_PIN_DATAREADY, /*!< DATAREADY GPIO input signal */
+} ADI_SENSE_GPIO_PIN;
+
+/*!
+ * GPIO callback function signature
+ *
+ * @param[in] ePinId The GPIO pin which triggered the interrupt notification
+ * @param[in] pArg   Optional opaque parameter to be passed to the callback
+ */
+typedef void (*ADI_SENSE_GPIO_CALLBACK)(
+    ADI_SENSE_GPIO_PIN               ePinId,
+    void                           * pArg);
+
+/*! A handle used in all API functions to identify the GPIO interface context */
+typedef void* ADI_SENSE_GPIO_HANDLE;
+
+#ifdef __cplusplus
+extern "C" 
+{
+#endif
+
+/*!
+ * @brief Open the SPI interface and allocate resources
+ *
+ * @param[in]  pConfig  Pointer to platform-specific GPIO interface details
+ * @param[out] phDevice Pointer to return a GPIO interface context handle
+ *
+ * @return Status
+ *         - #ADI_SENSE_SUCCESS Call completed successfully
+ *         - #ADI_SENSE_NO_MEM  Failed to allocate memory for interface context
+ */
+ADI_SENSE_RESULT adi_sense_GpioOpen(
+    ADI_SENSE_PLATFORM_GPIO_CONFIG * pConfig,
+    ADI_SENSE_GPIO_HANDLE          * phDevice);
+
+/*!
+ * @brief Close GPIO interface and free resources
+ *
+ * @param[in] hDevice GPIO interface context handle (@ref adi_sense_GpioOpen)
+ */
+void adi_sense_GpioClose(
+    ADI_SENSE_GPIO_HANDLE            hDevice);
+
+/*!
+ * @brief Get the state of the specified GPIO pin
+ *
+ * @param[in]  hDevice GPIO interface context handle (@ref adi_sense_GpioOpen)
+ * @param[in]  ePinId  GPIO pin to be read
+ * @param[out] pbState Pointer to return the state of the GPIO pin
+ *
+ * @return Status
+ *         - #ADI_SENSE_SUCCESS Call completed successfully
+ *         - #ADI_SENSE_INVALID_DEVICE_NUM Invalid GPIO pin specified
+ */
+ADI_SENSE_RESULT adi_sense_GpioGet(
+    ADI_SENSE_GPIO_HANDLE            hDevice,
+    ADI_SENSE_GPIO_PIN               ePinID,
+    bool_t                         * bState);
+
+/*!
+ * @brief Set the state of the specified GPIO pin
+ *
+ * @param[in] hDevice GPIO interface context handle (@ref adi_sense_GpioOpen)
+ * @param[in] ePinId  GPIO pin to be set
+ * @param[in] bState  The state to set for GPIO pin
+ *
+ * @return Status
+ *         - #ADI_SENSE_SUCCESS Call completed successfully
+ *         - #ADI_SENSE_INVALID_DEVICE_NUM Invalid GPIO pin specified
+ */
+ADI_SENSE_RESULT adi_sense_GpioSet(
+    ADI_SENSE_GPIO_HANDLE            hDevice,
+    ADI_SENSE_GPIO_PIN               ePinID,
+    bool_t                           bState);
+
+/*!
+ * @brief Enable interrupt notifications on the specified GPIO pin
+ *
+ * @param[in] hDevice  GPIO interface context handle (@ref adi_sense_GpioOpen)
+ * @param[in] ePinId   GPIO pin on which to enable interrupt notifications
+ * @param[in] callback Callback function to invoke when the GPIO is asserted
+ * @param[in] arg      Optional opaque parameter to be passed to the callback
+ *
+ * @return Status
+ *         - #ADI_SENSE_SUCCESS Call completed successfully
+ *         - #ADI_SENSE_INVALID_DEVICE_NUM Invalid GPIO pin specified
+ */
+ADI_SENSE_RESULT adi_sense_GpioIrqEnable(
+    ADI_SENSE_GPIO_HANDLE            hDevice,
+    ADI_SENSE_GPIO_PIN               ePinID,
+    ADI_SENSE_GPIO_CALLBACK          callback,
+    void                           * arg);
+
+/*!
+ * @brief Disable interrupt notifications on the specified GPIO pin
+ *
+ * @param[in] hDevice  GPIO interface context handle (@ref adi_sense_GpioOpen)
+ * @param[in] ePinId   GPIO pin on which to disable interrupt notifications
+ *
+ * @return Status
+ *         - #ADI_SENSE_SUCCESS Call completed successfully
+ *         - #ADI_SENSE_INVALID_DEVICE_NUM Invalid GPIO pin specified
+ */
+ADI_SENSE_RESULT adi_sense_GpioIrqDisable(
+    ADI_SENSE_GPIO_HANDLE            hDevice,
+    ADI_SENSE_GPIO_PIN               ePinID);
+
+#ifdef __cplusplus
+}
+#endif
+
+/*!
+ * @}
+ */
+
+#endif /* __ADI_SENSE_GPIO_H__ */
+