PortIn.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_PORTIN_H
00023 #define MBED_PORTIN_H
00024 
00025 #include "platform.h"
00026 
00027 #if DEVICE_PORTIN
00028 
00029 #include "port_api.h"
00030 
00031 namespace mbed {
00032 
00033 /** A multiple pin digital input
00034  *
00035  *  Example:
00036  * @code
00037  * // Switch on an LED if any of mbed pins 21-26 is high
00038  *
00039  * #include "mbed.h"
00040  *
00041  * PortIn     p(Port2, 0x0000003F);   // p21-p26
00042  * DigitalOut ind(LED4);
00043  *
00044  * int main() {
00045  *     while(1) {
00046  *         int pins = p.read();
00047  *         if(pins) {
00048  *             ind = 1;
00049  *         } else {
00050  *             ind = 0;
00051  *         }
00052  *     }
00053  * }
00054  * @endcode
00055  */
00056 class PortIn {
00057 public:
00058 
00059     /** Create an PortIn, connected to the specified port
00060      *
00061      *  @param port Port to connect to (Port0-Port5)
00062      *  @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
00063         */
00064     PortIn(PortName port, int mask = 0xFFFFFFFF) {
00065         port_init(&_port, port, mask, PIN_INPUT);
00066     }
00067 
00068     /** Read the value currently output on the port
00069      *
00070      *  @returns
00071      *    An integer with each bit corresponding to associated port pin setting
00072      */
00073     int read() {
00074         return port_read(&_port);
00075     }
00076 
00077     /** Set the input pin mode
00078      *
00079      *  @param mode PullUp, PullDown, PullNone, OpenDrain
00080      */
00081     void mode(PinMode mode) {
00082         port_mode(&_port, mode);
00083     }
00084 
00085     /** A shorthand for read()
00086      */
00087     operator int() {
00088         return read();
00089     }
00090 
00091 private:
00092     port_t _port;
00093 };
00094 
00095 } // namespace mbed
00096 
00097 #endif
00098 
00099 #endif
00100