Steven Wray / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/DigitalOut.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff 
This updates the lib to the mbed lib v125

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_DIGITALOUT_H
<> 144:ef7eb2e8f9f7 17 #define MBED_DIGITALOUT_H
<> 144:ef7eb2e8f9f7 18
<> 144:ef7eb2e8f9f7 19 #include "platform.h"
<> 144:ef7eb2e8f9f7 20 #include "gpio_api.h"
<> 144:ef7eb2e8f9f7 21 #include "critical.h"
<> 144:ef7eb2e8f9f7 22
<> 144:ef7eb2e8f9f7 23 namespace mbed {
<> 144:ef7eb2e8f9f7 24
<> 144:ef7eb2e8f9f7 25 /** A digital output, used for setting the state of a pin
<> 144:ef7eb2e8f9f7 26 *
<> 144:ef7eb2e8f9f7 27 * @Note Synchronization level: Interrupt safe
<> 144:ef7eb2e8f9f7 28 *
<> 144:ef7eb2e8f9f7 29 * Example:
<> 144:ef7eb2e8f9f7 30 * @code
<> 144:ef7eb2e8f9f7 31 * // Toggle a LED
<> 144:ef7eb2e8f9f7 32 * #include "mbed.h"
<> 144:ef7eb2e8f9f7 33 *
<> 144:ef7eb2e8f9f7 34 * DigitalOut led(LED1);
<> 144:ef7eb2e8f9f7 35 *
<> 144:ef7eb2e8f9f7 36 * int main() {
<> 144:ef7eb2e8f9f7 37 * while(1) {
<> 144:ef7eb2e8f9f7 38 * led = !led;
<> 144:ef7eb2e8f9f7 39 * wait(0.2);
<> 144:ef7eb2e8f9f7 40 * }
<> 144:ef7eb2e8f9f7 41 * }
<> 144:ef7eb2e8f9f7 42 * @endcode
<> 144:ef7eb2e8f9f7 43 */
<> 144:ef7eb2e8f9f7 44 class DigitalOut {
<> 144:ef7eb2e8f9f7 45
<> 144:ef7eb2e8f9f7 46 public:
<> 144:ef7eb2e8f9f7 47 /** Create a DigitalOut connected to the specified pin
<> 144:ef7eb2e8f9f7 48 *
<> 144:ef7eb2e8f9f7 49 * @param pin DigitalOut pin to connect to
<> 144:ef7eb2e8f9f7 50 */
<> 144:ef7eb2e8f9f7 51 DigitalOut(PinName pin) : gpio() {
<> 144:ef7eb2e8f9f7 52 // No lock needed in the constructor
<> 144:ef7eb2e8f9f7 53 gpio_init_out(&gpio, pin);
<> 144:ef7eb2e8f9f7 54 }
<> 144:ef7eb2e8f9f7 55
<> 144:ef7eb2e8f9f7 56 /** Create a DigitalOut connected to the specified pin
<> 144:ef7eb2e8f9f7 57 *
<> 144:ef7eb2e8f9f7 58 * @param pin DigitalOut pin to connect to
<> 144:ef7eb2e8f9f7 59 * @param value the initial pin value
<> 144:ef7eb2e8f9f7 60 */
<> 144:ef7eb2e8f9f7 61 DigitalOut(PinName pin, int value) : gpio() {
<> 144:ef7eb2e8f9f7 62 // No lock needed in the constructor
<> 144:ef7eb2e8f9f7 63 gpio_init_out_ex(&gpio, pin, value);
<> 144:ef7eb2e8f9f7 64 }
<> 144:ef7eb2e8f9f7 65
<> 144:ef7eb2e8f9f7 66 /** Set the output, specified as 0 or 1 (int)
<> 144:ef7eb2e8f9f7 67 *
<> 144:ef7eb2e8f9f7 68 * @param value An integer specifying the pin output value,
<> 144:ef7eb2e8f9f7 69 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
<> 144:ef7eb2e8f9f7 70 */
<> 144:ef7eb2e8f9f7 71 void write(int value) {
<> 144:ef7eb2e8f9f7 72 // Thread safe / atomic HAL call
<> 144:ef7eb2e8f9f7 73 gpio_write(&gpio, value);
<> 144:ef7eb2e8f9f7 74 }
<> 144:ef7eb2e8f9f7 75
<> 144:ef7eb2e8f9f7 76 /** Return the output setting, represented as 0 or 1 (int)
<> 144:ef7eb2e8f9f7 77 *
<> 144:ef7eb2e8f9f7 78 * @returns
<> 144:ef7eb2e8f9f7 79 * an integer representing the output setting of the pin,
<> 144:ef7eb2e8f9f7 80 * 0 for logical 0, 1 for logical 1
<> 144:ef7eb2e8f9f7 81 */
<> 144:ef7eb2e8f9f7 82 int read() {
<> 144:ef7eb2e8f9f7 83 // Thread safe / atomic HAL call
<> 144:ef7eb2e8f9f7 84 return gpio_read(&gpio);
<> 144:ef7eb2e8f9f7 85 }
<> 144:ef7eb2e8f9f7 86
<> 144:ef7eb2e8f9f7 87 /** Return the output setting, represented as 0 or 1 (int)
<> 144:ef7eb2e8f9f7 88 *
<> 144:ef7eb2e8f9f7 89 * @returns
<> 144:ef7eb2e8f9f7 90 * Non zero value if pin is connected to uc GPIO
<> 144:ef7eb2e8f9f7 91 * 0 if gpio object was initialized with NC
<> 144:ef7eb2e8f9f7 92 */
<> 144:ef7eb2e8f9f7 93 int is_connected() {
<> 144:ef7eb2e8f9f7 94 // Thread safe / atomic HAL call
<> 144:ef7eb2e8f9f7 95 return gpio_is_connected(&gpio);
<> 144:ef7eb2e8f9f7 96 }
<> 144:ef7eb2e8f9f7 97
<> 144:ef7eb2e8f9f7 98 /** A shorthand for write()
<> 144:ef7eb2e8f9f7 99 */
<> 144:ef7eb2e8f9f7 100 DigitalOut& operator= (int value) {
<> 144:ef7eb2e8f9f7 101 // Underlying write is thread safe
<> 144:ef7eb2e8f9f7 102 write(value);
<> 144:ef7eb2e8f9f7 103 return *this;
<> 144:ef7eb2e8f9f7 104 }
<> 144:ef7eb2e8f9f7 105
<> 144:ef7eb2e8f9f7 106 DigitalOut& operator= (DigitalOut& rhs) {
<> 144:ef7eb2e8f9f7 107 core_util_critical_section_enter();
<> 144:ef7eb2e8f9f7 108 write(rhs.read());
<> 144:ef7eb2e8f9f7 109 core_util_critical_section_exit();
<> 144:ef7eb2e8f9f7 110 return *this;
<> 144:ef7eb2e8f9f7 111 }
<> 144:ef7eb2e8f9f7 112
<> 144:ef7eb2e8f9f7 113 /** A shorthand for read()
<> 144:ef7eb2e8f9f7 114 */
<> 144:ef7eb2e8f9f7 115 operator int() {
<> 144:ef7eb2e8f9f7 116 // Underlying call is thread safe
<> 144:ef7eb2e8f9f7 117 return read();
<> 144:ef7eb2e8f9f7 118 }
<> 144:ef7eb2e8f9f7 119
<> 144:ef7eb2e8f9f7 120 protected:
<> 144:ef7eb2e8f9f7 121 gpio_t gpio;
<> 144:ef7eb2e8f9f7 122 };
<> 144:ef7eb2e8f9f7 123
<> 144:ef7eb2e8f9f7 124 } // namespace mbed
<> 144:ef7eb2e8f9f7 125
<> 144:ef7eb2e8f9f7 126 #endif