ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

drivers/DigitalOut.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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