SDK Development / mbed-src

mbed SDK library sources

Fork of mbed-src by mbed official

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

api/DigitalInOut.h@37:88e9030f311f, 2013-10-23 (annotated)

Committer:
mbed_official
Date:
Wed Oct 23 15:30:04 2013 +0100
Revision:
37:88e9030f311f
Parent:
13:0645d8841f51 
Synchronized with git revision 5742abe6d9771e0bbfb5477645d7357c7d595702

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 */
bogdanm 13:0645d8841f51 34 DigitalInOut(PinName pin) {
bogdanm 13:0645d8841f51 35 gpio_init(&gpio, pin, PIN_INPUT);
bogdanm 13:0645d8841f51 36 }
bogdanm 13:0645d8841f51 37
bogdanm 13:0645d8841f51 38 /** Set the output, specified as 0 or 1 (int)
bogdanm 13:0645d8841f51 39 *
bogdanm 13:0645d8841f51 40 * @param value An integer specifying the pin output value,
bogdanm 13:0645d8841f51 41 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
bogdanm 13:0645d8841f51 42 */
bogdanm 13:0645d8841f51 43 void write(int value) {
bogdanm 13:0645d8841f51 44 gpio_write(&gpio, value);
bogdanm 13:0645d8841f51 45 }
bogdanm 13:0645d8841f51 46
bogdanm 13:0645d8841f51 47 /** Return the output setting, represented as 0 or 1 (int)
bogdanm 13:0645d8841f51 48 *
bogdanm 13:0645d8841f51 49 * @returns
bogdanm 13:0645d8841f51 50 * an integer representing the output setting of the pin if it is an output,
bogdanm 13:0645d8841f51 51 * or read the input if set as an input
bogdanm 13:0645d8841f51 52 */
bogdanm 13:0645d8841f51 53 int read() {
bogdanm 13:0645d8841f51 54 return gpio_read(&gpio);
bogdanm 13:0645d8841f51 55 }
bogdanm 13:0645d8841f51 56
bogdanm 13:0645d8841f51 57 /** Set as an output
bogdanm 13:0645d8841f51 58 */
bogdanm 13:0645d8841f51 59 void output() {
bogdanm 13:0645d8841f51 60 gpio_dir(&gpio, PIN_OUTPUT);
bogdanm 13:0645d8841f51 61 }
bogdanm 13:0645d8841f51 62
bogdanm 13:0645d8841f51 63 /** Set as an input
bogdanm 13:0645d8841f51 64 */
bogdanm 13:0645d8841f51 65 void input() {
bogdanm 13:0645d8841f51 66 gpio_dir(&gpio, PIN_INPUT);
bogdanm 13:0645d8841f51 67 }
bogdanm 13:0645d8841f51 68
bogdanm 13:0645d8841f51 69 /** Set the input pin mode
bogdanm 13:0645d8841f51 70 *
bogdanm 13:0645d8841f51 71 * @param mode PullUp, PullDown, PullNone, OpenDrain
bogdanm 13:0645d8841f51 72 */
bogdanm 13:0645d8841f51 73 void mode(PinMode pull) {
bogdanm 13:0645d8841f51 74 gpio_mode(&gpio, pull);
bogdanm 13:0645d8841f51 75 }
bogdanm 13:0645d8841f51 76
bogdanm 13:0645d8841f51 77 #ifdef MBED_OPERATORS
bogdanm 13:0645d8841f51 78 /** A shorthand for write()
bogdanm 13:0645d8841f51 79 */
bogdanm 13:0645d8841f51 80 DigitalInOut& operator= (int value) {
bogdanm 13:0645d8841f51 81 write(value);
bogdanm 13:0645d8841f51 82 return *this;
bogdanm 13:0645d8841f51 83 }
bogdanm 13:0645d8841f51 84
bogdanm 13:0645d8841f51 85 DigitalInOut& operator= (DigitalInOut& rhs) {
bogdanm 13:0645d8841f51 86 write(rhs.read());
bogdanm 13:0645d8841f51 87 return *this;
bogdanm 13:0645d8841f51 88 }
bogdanm 13:0645d8841f51 89
bogdanm 13:0645d8841f51 90 /** A shorthand for read()
bogdanm 13:0645d8841f51 91 */
bogdanm 13:0645d8841f51 92 operator int() {
bogdanm 13:0645d8841f51 93 return read();
bogdanm 13:0645d8841f51 94 }
bogdanm 13:0645d8841f51 95 #endif
bogdanm 13:0645d8841f51 96
bogdanm 13:0645d8841f51 97 protected:
bogdanm 13:0645d8841f51 98 gpio_t gpio;
bogdanm 13:0645d8841f51 99 };
bogdanm 13:0645d8841f51 100
bogdanm 13:0645d8841f51 101 } // namespace mbed
bogdanm 13:0645d8841f51 102
bogdanm 13:0645d8841f51 103 #endif