Julien Kern / mbed

mbed library

Dependents:   Printf

Fork of mbed by mbed official

PortIn.h@55:d722ed6a4237, 2013-01-16 (annotated)

Committer:
emilmont
Date:
Wed Jan 16 12:56:34 2013 +0000
Revision:
55:d722ed6a4237
Parent:
54:71b101360fb9
Child:
59:0883845fe643
Include "sleep_api.h" in "mbed.h"

Add initial IAR toolchain support

LPC I2C: better handling of status

Add sleep mode support for the LPC1768

Correct GCC "__semihost" definition

Correct GCC "_isatty" retargeting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
emilmont 44:24d45a770a51 22 #ifndef MBED_PORTIN_H
emilmont 44:24d45a770a51 23 #define MBED_PORTIN_H
emilmont 44:24d45a770a51 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 44:24d45a770a51 26
emilmont 44:24d45a770a51 27 #if DEVICE_PORTIN
emilmont 44:24d45a770a51 28
emilmont 44:24d45a770a51 29 #include "port_api.h"
emilmont 44:24d45a770a51 30
emilmont 44:24d45a770a51 31 namespace mbed {
emilmont 44:24d45a770a51 32
emilmont 44:24d45a770a51 33 /** A multiple pin digital input
emilmont 44:24d45a770a51 34 *
emilmont 44:24d45a770a51 35 * Example:
emilmont 44:24d45a770a51 36 * @code
emilmont 44:24d45a770a51 37 * // Switch on an LED if any of mbed pins 21-26 is high
emilmont 44:24d45a770a51 38 *
emilmont 44:24d45a770a51 39 * #include "mbed.h"
emilmont 44:24d45a770a51 40 *
emilmont 44:24d45a770a51 41 * PortIn p(Port2, 0x0000003F); // p21-p26
emilmont 44:24d45a770a51 42 * DigitalOut ind(LED4);
emilmont 44:24d45a770a51 43 *
emilmont 44:24d45a770a51 44 * int main() {
emilmont 44:24d45a770a51 45 * while(1) {
emilmont 44:24d45a770a51 46 * int pins = p.read();
emilmont 44:24d45a770a51 47 * if(pins) {
emilmont 44:24d45a770a51 48 * ind = 1;
emilmont 44:24d45a770a51 49 * } else {
emilmont 44:24d45a770a51 50 * ind = 0;
emilmont 44:24d45a770a51 51 * }
emilmont 44:24d45a770a51 52 * }
emilmont 44:24d45a770a51 53 * }
emilmont 44:24d45a770a51 54 * @endcode
emilmont 44:24d45a770a51 55 */
emilmont 44:24d45a770a51 56 class PortIn {
emilmont 44:24d45a770a51 57 public:
emilmont 44:24d45a770a51 58
emilmont 44:24d45a770a51 59 /** Create an PortIn, connected to the specified port
emilmont 44:24d45a770a51 60 *
emilmont 44:24d45a770a51 61 * @param port Port to connect to (Port0-Port5)
emilmont 44:24d45a770a51 62 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
emilmont 55:d722ed6a4237 63 */
emilmont 44:24d45a770a51 64 PortIn(PortName port, int mask = 0xFFFFFFFF) {
emilmont 44:24d45a770a51 65 port_init(&_port, port, mask, PIN_INPUT);
emilmont 44:24d45a770a51 66 }
emilmont 55:d722ed6a4237 67
emilmont 44:24d45a770a51 68 /** Read the value currently output on the port
emilmont 44:24d45a770a51 69 *
emilmont 44:24d45a770a51 70 * @returns
emilmont 44:24d45a770a51 71 * An integer with each bit corresponding to associated port pin setting
emilmont 44:24d45a770a51 72 */
emilmont 44:24d45a770a51 73 int read() {
emilmont 44:24d45a770a51 74 return port_read(&_port);
emilmont 44:24d45a770a51 75 }
emilmont 55:d722ed6a4237 76
emilmont 44:24d45a770a51 77 /** Set the input pin mode
emilmont 44:24d45a770a51 78 *
emilmont 44:24d45a770a51 79 * @param mode PullUp, PullDown, PullNone, OpenDrain
emilmont 44:24d45a770a51 80 */
emilmont 44:24d45a770a51 81 void mode(PinMode mode) {
emilmont 44:24d45a770a51 82 port_mode(&_port, mode);
emilmont 44:24d45a770a51 83 }
emilmont 55:d722ed6a4237 84
emilmont 44:24d45a770a51 85 /** A shorthand for read()
emilmont 44:24d45a770a51 86 */
emilmont 55:d722ed6a4237 87 operator int() {
emilmont 44:24d45a770a51 88 return read();
emilmont 44:24d45a770a51 89 }
emilmont 44:24d45a770a51 90
emilmont 44:24d45a770a51 91 private:
emilmont 44:24d45a770a51 92 port_t _port;
emilmont 44:24d45a770a51 93 };
emilmont 44:24d45a770a51 94
emilmont 44:24d45a770a51 95 } // namespace mbed
emilmont 44:24d45a770a51 96
emilmont 44:24d45a770a51 97 #endif
emilmont 44:24d45a770a51 98
emilmont 44:24d45a770a51 99 #endif