Milen Pavlov / XRange_mbed_src

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.

Dependents:   XRangePingPong XRange-LoRaWAN-lmic-app lora-transceiver

api/DigitalInOut.h@336:1e18a06a987b, 2015-01-15 (annotated)

Committer:
dudmuck
Date:
Thu Jan 15 02:25:40 2015 +0000
Revision:
336:1e18a06a987b
updated to rev443 of official mbed-src

Who changed what in which revision?

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