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