teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/DigitalInOut.h@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

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