Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

DigitalOut.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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