lzbp li / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/DigitalInOut.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 10:3bc89ef62ce7 1 /* mbed Microcontroller Library
emilmont 10:3bc89ef62ce7 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 10:3bc89ef62ce7 3 *
emilmont 10:3bc89ef62ce7 4 * Licensed under the Apache License, Version 2.0 (the "License");
emilmont 10:3bc89ef62ce7 5 * you may not use this file except in compliance with the License.
emilmont 10:3bc89ef62ce7 6 * You may obtain a copy of the License at
emilmont 10:3bc89ef62ce7 7 *
emilmont 10:3bc89ef62ce7 8 * http://www.apache.org/licenses/LICENSE-2.0
emilmont 10:3bc89ef62ce7 9 *
emilmont 10:3bc89ef62ce7 10 * Unless required by applicable law or agreed to in writing, software
emilmont 10:3bc89ef62ce7 11 * distributed under the License is distributed on an "AS IS" BASIS,
emilmont 10:3bc89ef62ce7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
emilmont 10:3bc89ef62ce7 13 * See the License for the specific language governing permissions and
emilmont 10:3bc89ef62ce7 14 * limitations under the License.
emilmont 10:3bc89ef62ce7 15 */
emilmont 10:3bc89ef62ce7 16 #ifndef MBED_DIGITALINOUT_H
emilmont 10:3bc89ef62ce7 17 #define MBED_DIGITALINOUT_H
emilmont 10:3bc89ef62ce7 18
emilmont 10:3bc89ef62ce7 19 #include "platform.h"
emilmont 10:3bc89ef62ce7 20
emilmont 10:3bc89ef62ce7 21 #include "gpio_api.h"
emilmont 10:3bc89ef62ce7 22
emilmont 10:3bc89ef62ce7 23 namespace mbed {
emilmont 10:3bc89ef62ce7 24
emilmont 10:3bc89ef62ce7 25 /** A digital input/output, used for setting or reading a bi-directional pin
emilmont 10:3bc89ef62ce7 26 */
emilmont 10:3bc89ef62ce7 27 class DigitalInOut {
emilmont 10:3bc89ef62ce7 28
emilmont 10:3bc89ef62ce7 29 public:
emilmont 10:3bc89ef62ce7 30 /** Create a DigitalInOut connected to the specified pin
emilmont 10:3bc89ef62ce7 31 *
emilmont 10:3bc89ef62ce7 32 * @param pin DigitalInOut pin to connect to
emilmont 10:3bc89ef62ce7 33 */
emilmont 10:3bc89ef62ce7 34 DigitalInOut(PinName pin) {
emilmont 10:3bc89ef62ce7 35 gpio_init(&gpio, pin, PIN_INPUT);
emilmont 10:3bc89ef62ce7 36 }
emilmont 10:3bc89ef62ce7 37
emilmont 10:3bc89ef62ce7 38 /** Set the output, specified as 0 or 1 (int)
emilmont 10:3bc89ef62ce7 39 *
emilmont 10:3bc89ef62ce7 40 * @param value An integer specifying the pin output value,
emilmont 10:3bc89ef62ce7 41 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
emilmont 10:3bc89ef62ce7 42 */
emilmont 10:3bc89ef62ce7 43 void write(int value) {
emilmont 10:3bc89ef62ce7 44 gpio_write(&gpio, value);
emilmont 10:3bc89ef62ce7 45 }
emilmont 10:3bc89ef62ce7 46
emilmont 10:3bc89ef62ce7 47 /** Return the output setting, represented as 0 or 1 (int)
emilmont 10:3bc89ef62ce7 48 *
emilmont 10:3bc89ef62ce7 49 * @returns
emilmont 10:3bc89ef62ce7 50 * an integer representing the output setting of the pin if it is an output,
emilmont 10:3bc89ef62ce7 51 * or read the input if set as an input
emilmont 10:3bc89ef62ce7 52 */
emilmont 10:3bc89ef62ce7 53 int read() {
emilmont 10:3bc89ef62ce7 54 return gpio_read(&gpio);
emilmont 10:3bc89ef62ce7 55 }
emilmont 10:3bc89ef62ce7 56
emilmont 10:3bc89ef62ce7 57 /** Set as an output
emilmont 10:3bc89ef62ce7 58 */
emilmont 10:3bc89ef62ce7 59 void output() {
emilmont 10:3bc89ef62ce7 60 gpio_dir(&gpio, PIN_OUTPUT);
emilmont 10:3bc89ef62ce7 61 }
emilmont 10:3bc89ef62ce7 62
emilmont 10:3bc89ef62ce7 63 /** Set as an input
emilmont 10:3bc89ef62ce7 64 */
emilmont 10:3bc89ef62ce7 65 void input() {
emilmont 10:3bc89ef62ce7 66 gpio_dir(&gpio, PIN_INPUT);
emilmont 10:3bc89ef62ce7 67 }
emilmont 10:3bc89ef62ce7 68
emilmont 10:3bc89ef62ce7 69 /** Set the input pin mode
emilmont 10:3bc89ef62ce7 70 *
emilmont 10:3bc89ef62ce7 71 * @param mode PullUp, PullDown, PullNone, OpenDrain
emilmont 10:3bc89ef62ce7 72 */
emilmont 10:3bc89ef62ce7 73 void mode(PinMode pull) {
emilmont 10:3bc89ef62ce7 74 gpio_mode(&gpio, pull);
emilmont 10:3bc89ef62ce7 75 }
emilmont 10:3bc89ef62ce7 76
emilmont 10:3bc89ef62ce7 77 #ifdef MBED_OPERATORS
emilmont 10:3bc89ef62ce7 78 /** A shorthand for write()
emilmont 10:3bc89ef62ce7 79 */
emilmont 10:3bc89ef62ce7 80 DigitalInOut& operator= (int value) {
emilmont 10:3bc89ef62ce7 81 write(value);
emilmont 10:3bc89ef62ce7 82 return *this;
emilmont 10:3bc89ef62ce7 83 }
emilmont 10:3bc89ef62ce7 84
emilmont 10:3bc89ef62ce7 85 DigitalInOut& operator= (DigitalInOut& rhs) {
emilmont 10:3bc89ef62ce7 86 write(rhs.read());
emilmont 10:3bc89ef62ce7 87 return *this;
emilmont 10:3bc89ef62ce7 88 }
emilmont 10:3bc89ef62ce7 89
emilmont 10:3bc89ef62ce7 90 /** A shorthand for read()
emilmont 10:3bc89ef62ce7 91 */
emilmont 10:3bc89ef62ce7 92 operator int() {
emilmont 10:3bc89ef62ce7 93 return read();
emilmont 10:3bc89ef62ce7 94 }
emilmont 10:3bc89ef62ce7 95 #endif
emilmont 10:3bc89ef62ce7 96
emilmont 10:3bc89ef62ce7 97 protected:
emilmont 10:3bc89ef62ce7 98 gpio_t gpio;
emilmont 10:3bc89ef62ce7 99 };
emilmont 10:3bc89ef62ce7 100
emilmont 10:3bc89ef62ce7 101 } // namespace mbed
emilmont 10:3bc89ef62ce7 102
emilmont 10:3bc89ef62ce7 103 #endif