伊生希 小林 / Mbed 2 deprecated cansat_main_copy

temp

Dependencies:   mbed SDFileSystem MS5607 ADXL345_I2C FATFileSystem

mbed/drivers/DigitalInOut.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_DIGITALINOUT_H
IKobayashi 0:c88c3b616c00 17 #define MBED_DIGITALINOUT_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/output, used for setting or reading a bi-directional pin
IKobayashi 0:c88c3b616c00 29 *
IKobayashi 0:c88c3b616c00 30 * @Note Synchronization level: Interrupt safe
IKobayashi 0:c88c3b616c00 31 */
IKobayashi 0:c88c3b616c00 32 class DigitalInOut {
IKobayashi 0:c88c3b616c00 33
IKobayashi 0:c88c3b616c00 34 public:
IKobayashi 0:c88c3b616c00 35 /** Create a DigitalInOut connected to the specified pin
IKobayashi 0:c88c3b616c00 36 *
IKobayashi 0:c88c3b616c00 37 * @param pin DigitalInOut pin to connect to
IKobayashi 0:c88c3b616c00 38 */
IKobayashi 0:c88c3b616c00 39 DigitalInOut(PinName pin) : gpio() {
IKobayashi 0:c88c3b616c00 40 // No lock needed in the constructor
IKobayashi 0:c88c3b616c00 41 gpio_init_in(&gpio, pin);
IKobayashi 0:c88c3b616c00 42 }
IKobayashi 0:c88c3b616c00 43
IKobayashi 0:c88c3b616c00 44 /** Create a DigitalInOut connected to the specified pin
IKobayashi 0:c88c3b616c00 45 *
IKobayashi 0:c88c3b616c00 46 * @param pin DigitalInOut pin to connect to
IKobayashi 0:c88c3b616c00 47 * @param direction the initial direction of the pin
IKobayashi 0:c88c3b616c00 48 * @param mode the initial mode of the pin
IKobayashi 0:c88c3b616c00 49 * @param value the initial value of the pin if is an output
IKobayashi 0:c88c3b616c00 50 */
IKobayashi 0:c88c3b616c00 51 DigitalInOut(PinName pin, PinDirection direction, PinMode mode, int value) : gpio() {
IKobayashi 0:c88c3b616c00 52 // No lock needed in the constructor
IKobayashi 0:c88c3b616c00 53 gpio_init_inout(&gpio, pin, direction, mode, value);
IKobayashi 0:c88c3b616c00 54 }
IKobayashi 0:c88c3b616c00 55
IKobayashi 0:c88c3b616c00 56 /** Set the output, specified as 0 or 1 (int)
IKobayashi 0:c88c3b616c00 57 *
IKobayashi 0:c88c3b616c00 58 * @param value An integer specifying the pin output value,
IKobayashi 0:c88c3b616c00 59 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
IKobayashi 0:c88c3b616c00 60 */
IKobayashi 0:c88c3b616c00 61 void write(int value) {
IKobayashi 0:c88c3b616c00 62 // Thread safe / atomic HAL call
IKobayashi 0:c88c3b616c00 63 gpio_write(&gpio, value);
IKobayashi 0:c88c3b616c00 64 }
IKobayashi 0:c88c3b616c00 65
IKobayashi 0:c88c3b616c00 66 /** Return the output setting, represented as 0 or 1 (int)
IKobayashi 0:c88c3b616c00 67 *
IKobayashi 0:c88c3b616c00 68 * @returns
IKobayashi 0:c88c3b616c00 69 * an integer representing the output setting of the pin if it is an output,
IKobayashi 0:c88c3b616c00 70 * or read the input if set as an input
IKobayashi 0:c88c3b616c00 71 */
IKobayashi 0:c88c3b616c00 72 int read() {
IKobayashi 0:c88c3b616c00 73 // Thread safe / atomic HAL call
IKobayashi 0:c88c3b616c00 74 return gpio_read(&gpio);
IKobayashi 0:c88c3b616c00 75 }
IKobayashi 0:c88c3b616c00 76
IKobayashi 0:c88c3b616c00 77 /** Set as an output
IKobayashi 0:c88c3b616c00 78 */
IKobayashi 0:c88c3b616c00 79 void output() {
IKobayashi 0:c88c3b616c00 80 core_util_critical_section_enter();
IKobayashi 0:c88c3b616c00 81 gpio_dir(&gpio, PIN_OUTPUT);
IKobayashi 0:c88c3b616c00 82 core_util_critical_section_exit();
IKobayashi 0:c88c3b616c00 83 }
IKobayashi 0:c88c3b616c00 84
IKobayashi 0:c88c3b616c00 85 /** Set as an input
IKobayashi 0:c88c3b616c00 86 */
IKobayashi 0:c88c3b616c00 87 void input() {
IKobayashi 0:c88c3b616c00 88 core_util_critical_section_enter();
IKobayashi 0:c88c3b616c00 89 gpio_dir(&gpio, PIN_INPUT);
IKobayashi 0:c88c3b616c00 90 core_util_critical_section_exit();
IKobayashi 0:c88c3b616c00 91 }
IKobayashi 0:c88c3b616c00 92
IKobayashi 0:c88c3b616c00 93 /** Set the input pin mode
IKobayashi 0:c88c3b616c00 94 *
IKobayashi 0:c88c3b616c00 95 * @param mode PullUp, PullDown, PullNone, OpenDrain
IKobayashi 0:c88c3b616c00 96 */
IKobayashi 0:c88c3b616c00 97 void mode(PinMode pull) {
IKobayashi 0:c88c3b616c00 98 core_util_critical_section_enter();
IKobayashi 0:c88c3b616c00 99 gpio_mode(&gpio, pull);
IKobayashi 0:c88c3b616c00 100 core_util_critical_section_exit();
IKobayashi 0:c88c3b616c00 101 }
IKobayashi 0:c88c3b616c00 102
IKobayashi 0:c88c3b616c00 103 /** Return the output setting, represented as 0 or 1 (int)
IKobayashi 0:c88c3b616c00 104 *
IKobayashi 0:c88c3b616c00 105 * @returns
IKobayashi 0:c88c3b616c00 106 * Non zero value if pin is connected to uc GPIO
IKobayashi 0:c88c3b616c00 107 * 0 if gpio object was initialized with NC
IKobayashi 0:c88c3b616c00 108 */
IKobayashi 0:c88c3b616c00 109 int is_connected() {
IKobayashi 0:c88c3b616c00 110 // Thread safe / atomic HAL call
IKobayashi 0:c88c3b616c00 111 return gpio_is_connected(&gpio);
IKobayashi 0:c88c3b616c00 112 }
IKobayashi 0:c88c3b616c00 113
IKobayashi 0:c88c3b616c00 114 /** A shorthand for write()
IKobayashi 0:c88c3b616c00 115 */
IKobayashi 0:c88c3b616c00 116 DigitalInOut& operator= (int value) {
IKobayashi 0:c88c3b616c00 117 // Underlying write is thread safe
IKobayashi 0:c88c3b616c00 118 write(value);
IKobayashi 0:c88c3b616c00 119 return *this;
IKobayashi 0:c88c3b616c00 120 }
IKobayashi 0:c88c3b616c00 121
IKobayashi 0:c88c3b616c00 122 DigitalInOut& operator= (DigitalInOut& rhs) {
IKobayashi 0:c88c3b616c00 123 core_util_critical_section_enter();
IKobayashi 0:c88c3b616c00 124 write(rhs.read());
IKobayashi 0:c88c3b616c00 125 core_util_critical_section_exit();
IKobayashi 0:c88c3b616c00 126 return *this;
IKobayashi 0:c88c3b616c00 127 }
IKobayashi 0:c88c3b616c00 128
IKobayashi 0:c88c3b616c00 129 /** A shorthand for read()
IKobayashi 0:c88c3b616c00 130 */
IKobayashi 0:c88c3b616c00 131 operator int() {
IKobayashi 0:c88c3b616c00 132 // Underlying call is thread safe
IKobayashi 0:c88c3b616c00 133 return read();
IKobayashi 0:c88c3b616c00 134 }
IKobayashi 0:c88c3b616c00 135
IKobayashi 0:c88c3b616c00 136 protected:
IKobayashi 0:c88c3b616c00 137 gpio_t gpio;
IKobayashi 0:c88c3b616c00 138 };
IKobayashi 0:c88c3b616c00 139
IKobayashi 0:c88c3b616c00 140 } // namespace mbed
IKobayashi 0:c88c3b616c00 141
IKobayashi 0:c88c3b616c00 142 #endif
IKobayashi 0:c88c3b616c00 143
IKobayashi 0:c88c3b616c00 144 /** @}*/