gabriel della-monica / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/DigitalInOut.h@445:9a3ffe6cfa19, 2015-01-14 (annotated)

Committer:
moirans2
Date:
Wed Jan 14 20:53:08 2015 +0000
Revision:
445:9a3ffe6cfa19
Parent:
212:34d62c0b2af6 
internal clock stm32L051

Who changed what in which revision?

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