joey shelton / LED_Demo2

dhgdh

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by joey shelton

mbd_os/hal/api/DigitalOut.h@1:55a6170b404f, 2016-09-17 (annotated)

Committer:
nexpaq
Date:
Sat Sep 17 16:32:05 2016 +0000
Revision:
1:55a6170b404f
checking in for sharing

Who changed what in which revision?

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