DigitalInOut.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_DIGITALINOUT_H
00023 #define MBED_DIGITALINOUT_H
00024 
00025 #include "platform.h"
00026 
00027 #include "gpio_api.h"
00028 
00029 namespace mbed {
00030 
00031 /** A digital input/output, used for setting or reading a bi-directional pin
00032  */
00033 class DigitalInOut {
00034 
00035 public:
00036     /** Create a DigitalInOut connected to the specified pin
00037      *
00038      *  @param pin DigitalInOut pin to connect to
00039      */
00040     DigitalInOut(PinName pin) {
00041         gpio_init(&gpio, pin, PIN_INPUT);
00042     }
00043 
00044     /** Set the output, specified as 0 or 1 (int)
00045      *
00046      *  @param value An integer specifying the pin output value,
00047      *      0 for logical 0, 1 (or any other non-zero value) for logical 1
00048      */
00049     void write(int value) {
00050         gpio_write(&gpio, value);
00051     }
00052 
00053     /** Return the output setting, represented as 0 or 1 (int)
00054      *
00055      *  @returns
00056      *    an integer representing the output setting of the pin if it is an output,
00057      *    or read the input if set as an input
00058      */
00059     int read() {
00060         return gpio_read(&gpio);
00061     }
00062 
00063     /** Set as an output
00064      */
00065     void output() {
00066         gpio_dir(&gpio, PIN_OUTPUT);
00067     }
00068 
00069     /** Set as an input
00070      */
00071     void input() {
00072         gpio_dir(&gpio, PIN_INPUT);
00073     }
00074 
00075     /** Set the input pin mode
00076      *
00077      *  @param mode PullUp, PullDown, PullNone, OpenDrain
00078      */
00079     void mode(PinMode pull) {
00080         gpio_mode(&gpio, pull);
00081     }
00082 
00083 #ifdef MBED_OPERATORS
00084     /** A shorthand for write()
00085      */
00086     DigitalInOut& operator= (int value) {
00087         write(value);
00088         return *this;
00089     }
00090 
00091     DigitalInOut& operator= (DigitalInOut& rhs) {
00092         write(rhs.read());
00093         return *this;
00094     }
00095 
00096     /** A shorthand for read()
00097      */
00098     operator int() {
00099         return read();
00100     }
00101 #endif
00102 
00103 protected:
00104     gpio_t gpio;
00105 };
00106 
00107 } // namespace mbed
00108 
00109 #endif
00110