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