aboutsummaryrefslogtreecommitdiffstats
path: root/wirish/io.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/io.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/io.h')
-rw-r--r--wirish/io.h223
1 files changed, 0 insertions, 223 deletions
diff --git a/wirish/io.h b/wirish/io.h
deleted file mode 100644
index 0cb9c04..0000000
--- a/wirish/io.h
+++ /dev/null
@@ -1,223 +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.
- *****************************************************************************/
-
-/**
- * @file io.h
- *
- * @brief Arduino-compatible digital pin I/O interface.
- */
-
-#ifndef _IO_H_
-#define _IO_H_
-
-#include "libmaple_types.h"
-
-#include "boards.h"
-
-/**
- * Specifies a GPIO pin behavior.
- * @see pinMode()
- */
-typedef enum WiringPinMode {
- OUTPUT, /**< Basic digital output: when the pin is HIGH, the
- voltage is held at +3.3v (Vcc) and when it is LOW, it
- is pulled down to ground. */
-
- OUTPUT_OPEN_DRAIN, /**< In open drain mode, the pin indicates
- "low" by accepting current flow to ground
- and "high" by providing increased
- impedance. An example use would be to
- connect a pin to a bus line (which is pulled
- up to a positive voltage by a separate
- supply through a large resistor). When the
- pin is high, not much current flows through
- to ground and the line stays at positive
- voltage; when the pin is low, the bus
- "drains" to ground with a small amount of
- current constantly flowing through the large
- resistor from the external supply. In this
- mode, no current is ever actually sourced
- from the pin. */
-
- INPUT, /**< Basic digital input. The pin voltage is sampled; when
- it is closer to 3.3v (Vcc) the pin status is high, and
- when it is closer to 0v (ground) it is low. If no
- external circuit is pulling the pin voltage to high or
- low, it will tend to randomly oscillate and be very
- sensitive to noise (e.g., a breath of air across the pin
- might cause the state to flip). */
-
- INPUT_ANALOG, /**< This is a special mode for when the pin will be
- used for analog (not digital) reads. Enables ADC
- conversion to be performed on the voltage at the
- pin. */
-
- INPUT_PULLUP, /**< The state of the pin in this mode is reported
- the same way as with INPUT, but the pin voltage
- is gently "pulled up" towards +3.3v. This means
- the state will be high unless an external device
- is specifically pulling the pin down to ground,
- in which case the "gentle" pull up will not
- affect the state of the input. */
-
- INPUT_PULLDOWN, /**< The state of the pin in this mode is reported
- the same way as with INPUT, but the pin voltage
- is gently "pulled down" towards 0v. This means
- the state will be low unless an external device
- is specifically pulling the pin up to 3.3v, in
- which case the "gentle" pull down will not
- affect the state of the input. */
-
- INPUT_FLOATING, /**< Synonym for INPUT. */
-
- PWM, /**< This is a special mode for when the pin will be used for
- PWM output (a special case of digital output). */
-
- PWM_OPEN_DRAIN, /**< Like PWM, except that instead of alternating
- cycles of LOW and HIGH, the voltage on the pin
- consists of alternating cycles of LOW and
- floating (disconnected). */
-} WiringPinMode;
-
-/**
- * Configure behavior of a GPIO pin.
- *
- * @param pin Number of pin to configure.
- * @param mode Mode corresponding to desired pin behavior.
- * @see WiringPinMode
- */
-void pinMode(uint8 pin, WiringPinMode mode);
-
-#define HIGH 0x1
-#define LOW 0x0
-
-/**
- * Writes a (digital) value to a pin. The pin must have its
- * mode set to OUTPUT or OUTPUT_OPEN_DRAIN.
- *
- * @param pin Pin to write to.
- * @param value Either LOW (write a 0) or HIGH (write a 1).
- * @see pinMode()
- */
-void digitalWrite(uint8 pin, uint8 value);
-
-/**
- * Read a digital value from a pin. The pin must have its mode set to
- * one of INPUT, INPUT_PULLUP, and INPUT_PULLDOWN.
- *
- * @param pin Pin to read from.
- * @return LOW or HIGH.
- * @see pinMode()
- */
-uint32 digitalRead(uint8 pin);
-
-/**
- * Read an analog value from pin. This function blocks during ADC
- * conversion, and has 12 bits of resolution. The pin must have its
- * mode set to INPUT_ANALOG.
- *
- * @param pin Pin to read from.
- * @return Converted voltage, in the range 0--4095, (i.e. a 12-bit ADC
- * conversion).
- * @see pinMode()
- */
-uint16 analogRead(uint8 pin);
-
-/**
- * Toggles the digital value at the given pin.
- *
- * The pin must have its mode set to OUTPUT.
- *
- * @param pin the pin to toggle. If the pin is HIGH, set it LOW. If
- * it is LOW, set it HIGH.
- *
- * @see pinMode()
- */
-void togglePin(uint8 pin);
-
-/**
- * Toggle the LED.
- *
- * If the LED is on, turn it off. If it is off, turn it on.
- *
- * The LED must its mode set to OUTPUT. This can be accomplished
- * portably over all LeafLabs boards by calling pinMode(BOARD_LED_PIN,
- * OUTPUT) before calling this function.
- *
- * @see pinMode()
- */
-static inline void toggleLED() {
- togglePin(BOARD_LED_PIN);
-}
-
-/**
- * If the button is currently pressed, waits until the button is no
- * longer being pressed, and returns true. Otherwise, returns false.
- *
- * The button pin must have its mode set to INPUT. This can be
- * accomplished portably over all LeafLabs boards by calling
- * pinMode(BOARD_BUTTON_PIN, INPUT).
- *
- * @see pinMode()
- */
-uint8 isButtonPressed();
-
-/**
- * Wait until the button is pressed and released, timing out if no
- * press occurs.
- *
- * The button pin must have its mode set to INPUT. This can be
- * accomplished portably over all LeafLabs boards by calling
- * pinMode(BOARD_BUTTON_PIN, INPUT).
- *
- * @param timeout_millis Number of milliseconds to wait until the
- * button is pressed. If timeout_millis is left out (or 0), wait
- * forever.
- *
- * @return true, if the button was pressed; false, if the timeout was
- * reached.
- *
- * @see pinMode()
- */
-uint8 waitForButtonPress(uint32 timeout_millis=0);
-
-/**
- * Shift out a byte of data, one bit at a time.
- *
- * This function starts at either the most significant or least
- * significant bit in a byte value, and shifts out each byte in order
- * onto a data pin. After each bit is written to the data pin, a
- * separate clock pin is pulsed to indicate that the new bit is
- * available.
- *
- * @param dataPin Pin to shift data out on
- * @param clockPin Pin to pulse after each bit is shifted out
- * @param bitOrder Either MSBFIRST (big-endian) or LSBFIRST (little-endian).
- * @param value Value to shift out
- */
-void shiftOut(uint8 dataPin, uint8 clockPin, uint8 bitOrder, uint8 value);
-
-#endif