Jhon Plantikow / mbed

.

Dependents:   RTC

DigitalInOut.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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