伊生希 小林 / Mbed 2 deprecated cansat_main_copy

temp

Dependencies:   mbed SDFileSystem MS5607 ADXL345_I2C FATFileSystem

mbed/drivers/DigitalIn.h@0:c88c3b616c00, 2020-03-16 (annotated)

Committer:
IKobayashi
Date:
Mon Mar 16 23:37:42 2020 +0900
Revision:
0:c88c3b616c00
copy

Who changed what in which revision?

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