Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

DigitalInOut.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
85:024bf7f99721
Child:
93:e188a91d3eaa
dgdgr

Who changed what in which revision?

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