Gan likun / The prosthetic control

The prosthetic control（MIT）

drivers/DigitalIn.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

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