Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/hal/api/DigitalInOut.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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