cc y / mbed

ads1115 only

Fork of mbed by mbed official

DigitalInOut.h@54:71b101360fb9, 2013-01-08 (annotated)

Committer:
emilmont
Date:
Tue Jan 08 12:46:36 2013 +0000
Revision:
54:71b101360fb9
Parent:
44:24d45a770a51
Child:
55:d722ed6a4237
Support "stream as file" use case

Unify binary libraries

Update copyright

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_DIGITALINOUT_H
emilmont 44:24d45a770a51 23 #define MBED_DIGITALINOUT_H
emilmont 44:24d45a770a51 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 44:24d45a770a51 26
emilmont 44:24d45a770a51 27 #include "gpio_api.h"
emilmont 44:24d45a770a51 28
emilmont 44:24d45a770a51 29 namespace mbed {
emilmont 44:24d45a770a51 30
emilmont 44:24d45a770a51 31 /** A digital input/output, used for setting or reading a bi-directional pin
emilmont 44:24d45a770a51 32 */
emilmont 44:24d45a770a51 33 class DigitalInOut {
emilmont 44:24d45a770a51 34
emilmont 44:24d45a770a51 35 public:
emilmont 44:24d45a770a51 36 /** Create a DigitalInOut connected to the specified pin
emilmont 44:24d45a770a51 37 *
emilmont 44:24d45a770a51 38 * @param pin DigitalInOut pin to connect to
emilmont 44:24d45a770a51 39 */
emilmont 44:24d45a770a51 40 DigitalInOut(PinName pin) {
emilmont 44:24d45a770a51 41 gpio_init(&gpio, pin, PIN_INPUT);
emilmont 44:24d45a770a51 42 }
emilmont 44:24d45a770a51 43
emilmont 44:24d45a770a51 44 /** Set the output, specified as 0 or 1 (int)
emilmont 44:24d45a770a51 45 *
emilmont 44:24d45a770a51 46 * @param value An integer specifying the pin output value,
emilmont 44:24d45a770a51 47 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
emilmont 44:24d45a770a51 48 */
emilmont 44:24d45a770a51 49 void write(int value) {
emilmont 44:24d45a770a51 50 gpio_write(&gpio, value);
emilmont 44:24d45a770a51 51 }
emilmont 44:24d45a770a51 52
emilmont 44:24d45a770a51 53 /** Return the output setting, represented as 0 or 1 (int)
emilmont 44:24d45a770a51 54 *
emilmont 44:24d45a770a51 55 * @returns
emilmont 44:24d45a770a51 56 * an integer representing the output setting of the pin if it is an output,
emilmont 44:24d45a770a51 57 * or read the input if set as an input
emilmont 44:24d45a770a51 58 */
emilmont 44:24d45a770a51 59 int read() {
emilmont 44:24d45a770a51 60 return gpio_read(&gpio);
emilmont 44:24d45a770a51 61 }
emilmont 44:24d45a770a51 62
emilmont 44:24d45a770a51 63 /** Set as an output
emilmont 44:24d45a770a51 64 */
emilmont 44:24d45a770a51 65 void output() {
emilmont 44:24d45a770a51 66 gpio_dir(&gpio, PIN_OUTPUT);
emilmont 44:24d45a770a51 67 }
emilmont 44:24d45a770a51 68
emilmont 44:24d45a770a51 69 /** Set as an input
emilmont 44:24d45a770a51 70 */
emilmont 44:24d45a770a51 71 void input() {
emilmont 44:24d45a770a51 72 gpio_dir(&gpio, PIN_INPUT);
emilmont 44:24d45a770a51 73 }
emilmont 44:24d45a770a51 74
emilmont 44:24d45a770a51 75 /** Set the input pin mode
emilmont 44:24d45a770a51 76 *
emilmont 44:24d45a770a51 77 * @param mode PullUp, PullDown, PullNone, OpenDrain
emilmont 44:24d45a770a51 78 */
emilmont 44:24d45a770a51 79 void mode(PinMode pull) {
emilmont 44:24d45a770a51 80 gpio_mode(&gpio, pull);
emilmont 44:24d45a770a51 81 }
emilmont 44:24d45a770a51 82
emilmont 44:24d45a770a51 83 #ifdef MBED_OPERATORS
emilmont 44:24d45a770a51 84 /** A shorthand for write()
emilmont 44:24d45a770a51 85 */
emilmont 44:24d45a770a51 86 DigitalInOut& operator= (int value) {
emilmont 44:24d45a770a51 87 write(value);
emilmont 44:24d45a770a51 88 return *this;
emilmont 44:24d45a770a51 89 }
emilmont 44:24d45a770a51 90
emilmont 44:24d45a770a51 91 DigitalInOut& operator= (DigitalInOut& rhs) {
emilmont 44:24d45a770a51 92 write(rhs.read());
emilmont 44:24d45a770a51 93 return *this;
emilmont 44:24d45a770a51 94 }
emilmont 44:24d45a770a51 95
emilmont 44:24d45a770a51 96 /** A shorthand for read()
emilmont 44:24d45a770a51 97 */
emilmont 44:24d45a770a51 98 operator int() {
emilmont 44:24d45a770a51 99 return read();
emilmont 44:24d45a770a51 100 }
emilmont 44:24d45a770a51 101 #endif
emilmont 44:24d45a770a51 102
emilmont 44:24d45a770a51 103 protected:
emilmont 44:24d45a770a51 104 gpio_t gpio;
emilmont 44:24d45a770a51 105 };
emilmont 44:24d45a770a51 106
emilmont 44:24d45a770a51 107 } // namespace mbed
emilmont 44:24d45a770a51 108
emilmont 44:24d45a770a51 109 #endif