mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
98 lines
3.4 KiB
C
98 lines
3.4 KiB
C
/******************************************************************************
|
|
Copyright 2009, Freie Universität Berlin (FUB). All rights reserved.
|
|
|
|
These sources were developed at the Freie Universitaet Berlin, Computer Systems
|
|
and Telematics group (http://cst.mi.fu-berlin.de).
|
|
-------------------------------------------------------------------------------
|
|
This file is part of FeuerWare.
|
|
|
|
This program is free software: you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option) any later
|
|
version.
|
|
|
|
FeuerWare is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program. If not, see http://www.gnu.org/licenses/ .
|
|
--------------------------------------------------------------------------------
|
|
For further information and questions please use the web site
|
|
http://scatterweb.mi.fu-berlin.de
|
|
and the mailinglist (subscription via web site)
|
|
scatterweb@lists.spline.inf.fu-berlin.de
|
|
*******************************************************************************/
|
|
|
|
#ifndef GPIOINT_H_
|
|
#define GPIOINT_H_
|
|
|
|
/**
|
|
* @defgroup dev_gpioint GPIO IRQ Multiplexer
|
|
* @ingroup dev
|
|
*
|
|
* Provides an API to implement interrupt handlers on IO pins.
|
|
*
|
|
* Multiplexer and interrupt handling must be implemented platform specific.
|
|
*
|
|
* See gpioint-example.c for an example of how to use gpioint.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @example gpioint-example.c
|
|
* This example shows how to setup an interrupt handler for a GPIO pin
|
|
* without using the HAL.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @brief GPIO IRQ Multiplexer interface
|
|
*
|
|
* @author Freie Universität Berlin, Computer Systems & Telematics, FeuerWhere project
|
|
* @author Michael Baar <michael.baar@fu-berlin.de>
|
|
* @version $Revision: 1508 $
|
|
*
|
|
* @note $Id: gpioint.h 1508 2009-10-26 15:10:02Z baar $
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
/*
|
|
* gpioint_flags:
|
|
* Note: - We rely on the exact values for the edges.
|
|
* - These flags are extended in hal/drivers/device-gpio.h
|
|
*/
|
|
#define GPIOINT_DISABLE 0x00
|
|
#define GPIOINT_RISING_EDGE 0x01 ///< interrupt is generated on rising edge
|
|
#define GPIOINT_FALLING_EDGE 0x02 ///< interrupt is generated on falling edge
|
|
#define GPIOINT_DEBOUNCE 0x04 ///< debounce this interrupt
|
|
|
|
/**
|
|
* @brief GPIO IRQ callback function type
|
|
* @param[in] data User defined callback data passed through gpioint_set
|
|
* @param[in] edge A combination of GPIOINT_RISING_EDGE and GPIOINT_FALLING_EDGE
|
|
*/
|
|
typedef void(*fp_irqcb)(void);
|
|
|
|
/**
|
|
* @brief GPIO IRQ handler setup
|
|
* @param[in] port CPU specific port number (starting at 0)
|
|
* @param[in] bitmask One or more bits for which to set the handler
|
|
* @param[in] flags A combination of #GPIOINT_RISING_EDGE and #GPIOINT_FALLING_EDGE
|
|
* @param[in] callback A pointer to a handler function
|
|
* @retval true successful
|
|
* @retval false failed
|
|
*
|
|
* To enable interrupt handling for a pin flags and callback must be non-zero. To disable interrupt
|
|
* handling flags and callback shall be zero.
|
|
*/
|
|
bool gpioint_set(int port, uint32_t bitmask, int flags, fp_irqcb callback);
|
|
|
|
void gpioint_init(void);
|
|
|
|
/** @} */
|
|
#endif /* GPIOINT_H_ */
|