Christopher Haster / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/DigitalInOut.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Initial revision

Who changed what in which revision?

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