PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/DigitalInOut.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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