Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/drivers/DigitalIn.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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