Hiroh Satoh / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   keyboard

Fork of mbed-dev by mbed official

api/DigitalInOut.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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