Diff: targets/hal/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/extint/extint_callback.c

Revision:

15:a81a8d6c1dfe

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/targets/hal/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/extint/extint_callback.c	Wed Nov 04 16:30:11 2015 +0000
@@ -0,0 +1,230 @@
+/**
+ * \file
+ *
+ * \brief SAM External Interrupt Driver
+ *
+ * Copyright (C) 2012-2015 Atmel Corporation. All rights reserved.
+ *
+ * \asf_license_start
+ *
+ * \page License
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 3. The name of Atmel may not be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * 4. This software may only be redistributed and used in connection with an
+ *    Atmel microcontroller product.
+ *
+ * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
+ * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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.
+ *
+ * \asf_license_stop
+ *
+ */
+/*
+ * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
+ */
+#include "extint.h"
+#include "extint_callback.h"
+
+/**
+ * \internal
+ * Internal driver device instance struct, declared in the main module driver.
+ */
+extern struct _extint_module _extint_dev;
+
+/**
+ * \internal
+ * This is the number of the channel whose callback is currently running.
+ */
+uint8_t _current_channel;
+
+/**
+ * \brief Registers an asynchronous callback function with the driver.
+ *
+ * Registers an asynchronous callback with the EXTINT driver, fired when a
+ * channel detects the configured channel detection criteria
+ * (e.g. edge or level). Callbacks are fired once for each detected channel.
+ *
+ * \note NMI channel callbacks cannot be registered via this function; the
+ *       device's NMI interrupt should be hooked directly in the user
+ *       application and the NMI flags manually cleared via
+ *       \ref extint_nmi_clear_detected().
+ *
+ * \param[in] callback  Pointer to the callback function to register
+ * \param[in] channel   Logical channel to register callback for
+ * \param[in] type      Type of callback function to register
+ *
+ * \return Status of the registration operation.
+ * \retval STATUS_OK               The callback was registered successfully
+ * \retval STATUS_ERR_INVALID_ARG  If an invalid callback type was supplied
+ * \retval STATUS_ERR_ALREADY_INITIALIZED    Callback function has been
+ *                                  registered, need unregister first
+ */
+enum status_code extint_register_callback(
+    const extint_callback_t callback,
+    const uint8_t channel,
+    const enum extint_callback_type type)
+{
+    /* Sanity check arguments */
+    Assert(callback);
+
+    if (type != EXTINT_CALLBACK_TYPE_DETECT) {
+        Assert(false);
+        return STATUS_ERR_INVALID_ARG;
+    }
+
+    if (_extint_dev.callbacks[channel] == NULL) {
+        _extint_dev.callbacks[channel] = callback;
+        return STATUS_OK;
+    } else if (_extint_dev.callbacks[channel] == callback) {
+        return STATUS_OK;
+    }
+
+    return STATUS_ERR_ALREADY_INITIALIZED;
+}
+
+/**
+ * \brief Unregisters an asynchronous callback function with the driver.
+ *
+ * Unregisters an asynchronous callback with the EXTINT driver, removing it
+ * from the internal callback registration table.
+ *
+ * \param[in] callback  Pointer to the callback function to unregister
+ * \param[in] channel   Logical channel to unregister callback for
+ * \param[in] type      Type of callback function to unregister
+ *
+ * \return Status of the de-registration operation.
+ * \retval STATUS_OK               The callback was Unregistered successfully
+ * \retval STATUS_ERR_INVALID_ARG  If an invalid callback type was supplied
+ * \retval STATUS_ERR_BAD_ADDRESS  No matching entry was found in the
+ *                                 registration table
+ */
+enum status_code extint_unregister_callback(
+    const extint_callback_t callback,
+    const uint8_t channel,
+    const enum extint_callback_type type)
+{
+    /* Sanity check arguments */
+    Assert(callback);
+
+    if (type != EXTINT_CALLBACK_TYPE_DETECT) {
+        Assert(false);
+        return STATUS_ERR_INVALID_ARG;
+    }
+
+    if (_extint_dev.callbacks[channel] == callback) {
+        _extint_dev.callbacks[channel] = NULL;
+        return STATUS_OK;
+    }
+
+    return STATUS_ERR_BAD_ADDRESS;
+}
+
+/**
+ * \brief Enables asynchronous callback generation for a given channel and type.
+ *
+ * Enables asynchronous callbacks for a given logical external interrupt channel
+ * and type. This must be called before an external interrupt channel will
+ * generate callback events.
+ *
+ * \param[in] channel  Logical channel to enable callback generation for
+ * \param[in] type     Type of callback function callbacks to enable
+ *
+ * \return Status of the callback enable operation.
+ * \retval STATUS_OK               The callback was enabled successfully
+ * \retval STATUS_ERR_INVALID_ARG  If an invalid callback type was supplied
+ */
+enum status_code extint_chan_enable_callback(
+    const uint8_t channel,
+    const enum extint_callback_type type)
+{
+    if (type == EXTINT_CALLBACK_TYPE_DETECT) {
+        Eic *const eic = _extint_get_eic_from_channel(channel);
+
+        eic->INTENSET.reg = (1UL << channel);
+    } else {
+        Assert(false);
+        return STATUS_ERR_INVALID_ARG;
+    }
+
+    return STATUS_OK;
+}
+
+/**
+ * \brief Disables asynchronous callback generation for a given channel and type.
+ *
+ * Disables asynchronous callbacks for a given logical external interrupt
+ * channel and type.
+ *
+ * \param[in] channel  Logical channel to disable callback generation for
+ * \param[in] type     Type of callback function callbacks to disable
+ *
+ * \return Status of the callback disable operation.
+ * \retval STATUS_OK               The callback was disabled successfully
+ * \retval STATUS_ERR_INVALID_ARG  If an invalid callback type was supplied
+ */
+enum status_code extint_chan_disable_callback(
+    const uint8_t channel,
+    const enum extint_callback_type type)
+{
+    if (type == EXTINT_CALLBACK_TYPE_DETECT) {
+        Eic *const eic = _extint_get_eic_from_channel(channel);
+
+        eic->INTENCLR.reg = (1UL << channel);
+    } else {
+        Assert(false);
+        return STATUS_ERR_INVALID_ARG;
+    }
+
+    return STATUS_OK;
+}
+
+/**
+ * \brief Find what channel caused the callback.
+ *
+ * Can be used in an EXTINT callback function to find what channel caused
+ * the callback in case same callback is used by multiple channels.
+ *
+ * \return Channel number.
+ */
+uint8_t extint_get_current_channel(void)
+{
+    return _current_channel;
+}
+
+/** Handler for the EXTINT hardware module interrupt. */
+void EIC_Handler(void)
+{
+    /* Find any triggered channels, run associated callback handlers */
+    for (_current_channel = 0; _current_channel < EIC_NUMBER_OF_INTERRUPTS ; _current_channel++) {
+        if (extint_chan_is_detected(_current_channel)) {
+            /* Clear flag */
+            extint_chan_clear_detected(_current_channel);
+            /* Find any associated callback entries in the callback table */
+            if (_extint_dev.callbacks[_current_channel] != NULL) {
+                /* Run the registered callback */
+                _extint_dev.callbacks[_current_channel]();
+            }
+        }
+    }
+}