aboutsummaryrefslogtreecommitdiffstats
path: root/wirish/ext_interrupts.h
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-11-15 12:45:43 -0500
committerMarti Bolivar <mbolivar@leaflabs.com>2012-04-11 16:56:50 -0400
commitf36fae273ec84ee2c53a33caa2dddea2d79db0da (patch)
treefcdaf01cc72a69ca8252213eec35fa0c4aba9ce0 /wirish/ext_interrupts.h
parent526d51aa2b83c7a73a2ecdba8525d2a0847e5587 (diff)
downloadlibrambutan-f36fae273ec84ee2c53a33caa2dddea2d79db0da.tar.gz
librambutan-f36fae273ec84ee2c53a33caa2dddea2d79db0da.zip
Move public headers to include directories; related cleanups.
Move libmaple/*.h to (new) libmaple/include/libmaple/. The new accepted way to include a libmaple header foo.h is with: #include <libmaple/foo.h> This is more polite in terms of the include namespace. It also allows us to e.g. implement the Arduino SPI library at all (which has header SPI.h; providing it was previously impossible on case-insensitive filesystems due to libmaple's spi.h). Similarly for Wirish. The old include style (#include "header.h") is now deprecated. libmaple/*.h: - Change include guard #defines from _FOO_H_ to _LIBMAPLE_FOO_H_. - Add license headers where they're missing - Add conditional extern "C" { ... } blocks where they're missing (they aren't always necessary, but we might was well do it against the future, while we're at it.). - Change includes from #include "foo.h" to #include <libmaple/foo.h>. - Move includes after extern "C". - Remove extra trailing newlines Note that this doesn't include the headers under libmaple/usb/ or libmaple/usb/usb_lib. These will get fixed later. libmaple/*.c: - Change includes from #include "foo.h" to #include <libmaple/foo.h>. Makefile: - Add I$(LIBMAPLE_PATH)/include/libmaple to GLOBAL_FLAGS. This allows for users (including Wirish) to migrate their code, but should go away ASAP, since it slows down compilation. Wirish: - Move wirish/**/*.h to (new) wirish/include/wirish/. This ignores the USB headers, which, as usual, are getting handled after everything else. - Similarly generify wirish/boards/ structure. For each supported board "foo", move wirish/boards/foo.h and wirish/boards/foo.cpp to wirish/boards/foo/include/board/board.h and wirish/boards/foo/board.cpp, respectively. Also remove the #ifdef hacks around the .cpp files. - wirish/rules.mk: put wirish/boards/foo/include in the include path (and add wirish/boards/foo/board.cpp to the list of sources to be compiled). This allows saying: #include <board/board.h> instead of the hack currently in place. We can allow the user to override this setting later to make adding custom board definitions easier. - Disable -Werror in libmaple/rules.mk, as the current USB warnings don't let the olimex_stm32_h103 board compile. We can re-enable -Werror once we've moved the board-specific bits out of libmaple proper. libraries, examples: - Update includes accordingly. - Miscellaneous cosmetic fixups. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'wirish/ext_interrupts.h')
-rw-r--r--wirish/ext_interrupts.h106
1 files changed, 0 insertions, 106 deletions
diff --git a/wirish/ext_interrupts.h b/wirish/ext_interrupts.h
deleted file mode 100644
index b5c6f98..0000000
--- a/wirish/ext_interrupts.h
+++ /dev/null
@@ -1,106 +0,0 @@
-/******************************************************************************
- * The MIT License
- *
- * Copyright (c) 2010 Perry Hung.
- *
- * Permission is hereby granted, free of charge, to any person
- * obtaining a copy of this software and associated documentation
- * files (the "Software"), to deal in the Software without
- * restriction, including without limitation the rights to use, copy,
- * modify, merge, publish, distribute, sublicense, and/or sell copies
- * of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be
- * included in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
- * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
- * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *****************************************************************************/
-
-#include "libmaple_types.h"
-#include "nvic.h"
-
-/**
- * @file ext_interrupts.h
- *
- * @brief Wiring-like external interrupt prototypes and types.
- */
-
-#ifndef _EXT_INTERRUPTS_H_
-#define _EXT_INTERRUPTS_H_
-
-/**
- * The kind of transition on an external pin which should trigger an
- * interrupt.
- */
-typedef enum ExtIntTriggerMode {
- RISING, /**< To trigger an interrupt when the pin transitions LOW
- to HIGH */
- FALLING, /**< To trigger an interrupt when the pin transitions
- HIGH to LOW */
- CHANGE /**< To trigger an interrupt when the pin transitions from
- LOW to HIGH or HIGH to LOW (i.e., when the pin
- changes). */
-} ExtIntTriggerMode;
-
-/**
- * @brief Registers an interrupt handler on a pin.
- *
- * The interrupt will be triggered on a given transition on the pin,
- * as specified by the mode parameter. The handler runs in interrupt
- * context. The new handler will replace whatever handler is
- * currently registered for the pin, if any.
- *
- * @param pin Maple pin number
- * @param handler Function to run upon external interrupt trigger.
- * The handler should take no arguments, and have void return type.
- * @param mode Type of transition to trigger on, e.g. falling, rising, etc.
- *
- * @sideeffect Registers a handler
- * @see detachInterrupt()
- */
-void attachInterrupt(uint8 pin, voidFuncPtr handler, ExtIntTriggerMode mode);
-
-/**
- * @brief Disable any registered external interrupt.
- * @param pin Maple pin number
- * @sideeffect unregisters external interrupt handler
- * @see attachInterrupt()
- */
-void detachInterrupt(uint8 pin);
-
-/**
- * Re-enable interrupts.
- *
- * Call this after noInterrupts() to re-enable interrupt handling,
- * after you have finished with a timing-critical section of code.
- *
- * @see noInterrupts()
- */
-static inline void interrupts() {
- nvic_globalirq_enable();
-}
-
-/**
- * Disable interrupts.
- *
- * After calling this function, all user-programmable interrupts will
- * be disabled. You can call this function before a timing-critical
- * section of code, then call interrupts() to re-enable interrupt
- * handling.
- *
- * @see interrupts()
- */
-static inline void noInterrupts() {
- nvic_globalirq_disable();
-}
-
-#endif
-