modtronix H / mbed_nz32sc151

mbed library for NZ32-SC151

api/DigitalInOut.h@17:639ed60ce759, 2016-08-19 (annotated)

Committer:
modtronix-com
Date:
Fri Aug 19 15:46:42 2016 +1000
Revision:
17:639ed60ce759
Parent:
1:71204b8406f2 
Added tag v1.1 for changeset 076cbe3e55be

Who changed what in which revision?

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