Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/DigitalIn.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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