David DiCarlo / mbed-src-KL05Z-smart-sensor

Fork of mbed for KL05Z based smart sensor which has no crystal on the board, so MCG FEI mode is required.

Dependents:   smart-sensor-KL05Z-debug

Fork of mbed-src by Ermanno Brusadin

api/DigitalInOut.h@0:0a673c671a56, 2016-07-27 (annotated)

Committer:
ebrus
Date:
Wed Jul 27 18:35:32 2016 +0000
Revision:
0:0a673c671a56
4

Who changed what in which revision?

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