Vladimir Vana / mbed

pro vyuku PSS v Jecne

DigitalInOut.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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