伊生希 小林 / Mbed 2 deprecated cansat_main_copy

temp

Dependencies:   mbed SDFileSystem MS5607 ADXL345_I2C FATFileSystem

mbed/drivers/DigitalOut.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_DIGITALOUT_H
IKobayashi 0:c88c3b616c00 17 #define MBED_DIGITALOUT_H
IKobayashi 0:c88c3b616c00 18
IKobayashi 0:c88c3b616c00 19 #include "platform/platform.h"
IKobayashi 0:c88c3b616c00 20 #include "hal/gpio_api.h"
IKobayashi 0:c88c3b616c00 21 #include "platform/critical.h"
IKobayashi 0:c88c3b616c00 22
IKobayashi 0:c88c3b616c00 23 namespace mbed {
IKobayashi 0:c88c3b616c00 24 /** \addtogroup drivers */
IKobayashi 0:c88c3b616c00 25 /** @{*/
IKobayashi 0:c88c3b616c00 26
IKobayashi 0:c88c3b616c00 27 /** A digital output, used for setting the state of a pin
IKobayashi 0:c88c3b616c00 28 *
IKobayashi 0:c88c3b616c00 29 * @Note Synchronization level: Interrupt safe
IKobayashi 0:c88c3b616c00 30 *
IKobayashi 0:c88c3b616c00 31 * Example:
IKobayashi 0:c88c3b616c00 32 * @code
IKobayashi 0:c88c3b616c00 33 * // Toggle a LED
IKobayashi 0:c88c3b616c00 34 * #include "mbed.h"
IKobayashi 0:c88c3b616c00 35 *
IKobayashi 0:c88c3b616c00 36 * DigitalOut led(LED1);
IKobayashi 0:c88c3b616c00 37 *
IKobayashi 0:c88c3b616c00 38 * int main() {
IKobayashi 0:c88c3b616c00 39 * while(1) {
IKobayashi 0:c88c3b616c00 40 * led = !led;
IKobayashi 0:c88c3b616c00 41 * wait(0.2);
IKobayashi 0:c88c3b616c00 42 * }
IKobayashi 0:c88c3b616c00 43 * }
IKobayashi 0:c88c3b616c00 44 * @endcode
IKobayashi 0:c88c3b616c00 45 */
IKobayashi 0:c88c3b616c00 46 class DigitalOut {
IKobayashi 0:c88c3b616c00 47
IKobayashi 0:c88c3b616c00 48 public:
IKobayashi 0:c88c3b616c00 49 /** Create a DigitalOut connected to the specified pin
IKobayashi 0:c88c3b616c00 50 *
IKobayashi 0:c88c3b616c00 51 * @param pin DigitalOut pin to connect to
IKobayashi 0:c88c3b616c00 52 */
IKobayashi 0:c88c3b616c00 53 DigitalOut(PinName pin) : gpio() {
IKobayashi 0:c88c3b616c00 54 // No lock needed in the constructor
IKobayashi 0:c88c3b616c00 55 gpio_init_out(&gpio, pin);
IKobayashi 0:c88c3b616c00 56 }
IKobayashi 0:c88c3b616c00 57
IKobayashi 0:c88c3b616c00 58 /** Create a DigitalOut connected to the specified pin
IKobayashi 0:c88c3b616c00 59 *
IKobayashi 0:c88c3b616c00 60 * @param pin DigitalOut pin to connect to
IKobayashi 0:c88c3b616c00 61 * @param value the initial pin value
IKobayashi 0:c88c3b616c00 62 */
IKobayashi 0:c88c3b616c00 63 DigitalOut(PinName pin, int value) : gpio() {
IKobayashi 0:c88c3b616c00 64 // No lock needed in the constructor
IKobayashi 0:c88c3b616c00 65 gpio_init_out_ex(&gpio, pin, value);
IKobayashi 0:c88c3b616c00 66 }
IKobayashi 0:c88c3b616c00 67
IKobayashi 0:c88c3b616c00 68 /** Set the output, specified as 0 or 1 (int)
IKobayashi 0:c88c3b616c00 69 *
IKobayashi 0:c88c3b616c00 70 * @param value An integer specifying the pin output value,
IKobayashi 0:c88c3b616c00 71 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
IKobayashi 0:c88c3b616c00 72 */
IKobayashi 0:c88c3b616c00 73 void write(int value) {
IKobayashi 0:c88c3b616c00 74 // Thread safe / atomic HAL call
IKobayashi 0:c88c3b616c00 75 gpio_write(&gpio, value);
IKobayashi 0:c88c3b616c00 76 }
IKobayashi 0:c88c3b616c00 77
IKobayashi 0:c88c3b616c00 78 /** Return the output setting, represented as 0 or 1 (int)
IKobayashi 0:c88c3b616c00 79 *
IKobayashi 0:c88c3b616c00 80 * @returns
IKobayashi 0:c88c3b616c00 81 * an integer representing the output setting of the pin,
IKobayashi 0:c88c3b616c00 82 * 0 for logical 0, 1 for logical 1
IKobayashi 0:c88c3b616c00 83 */
IKobayashi 0:c88c3b616c00 84 int read() {
IKobayashi 0:c88c3b616c00 85 // Thread safe / atomic HAL call
IKobayashi 0:c88c3b616c00 86 return gpio_read(&gpio);
IKobayashi 0:c88c3b616c00 87 }
IKobayashi 0:c88c3b616c00 88
IKobayashi 0:c88c3b616c00 89 /** Return the output setting, represented as 0 or 1 (int)
IKobayashi 0:c88c3b616c00 90 *
IKobayashi 0:c88c3b616c00 91 * @returns
IKobayashi 0:c88c3b616c00 92 * Non zero value if pin is connected to uc GPIO
IKobayashi 0:c88c3b616c00 93 * 0 if gpio object was initialized with NC
IKobayashi 0:c88c3b616c00 94 */
IKobayashi 0:c88c3b616c00 95 int is_connected() {
IKobayashi 0:c88c3b616c00 96 // Thread safe / atomic HAL call
IKobayashi 0:c88c3b616c00 97 return gpio_is_connected(&gpio);
IKobayashi 0:c88c3b616c00 98 }
IKobayashi 0:c88c3b616c00 99
IKobayashi 0:c88c3b616c00 100 /** A shorthand for write()
IKobayashi 0:c88c3b616c00 101 */
IKobayashi 0:c88c3b616c00 102 DigitalOut& operator= (int value) {
IKobayashi 0:c88c3b616c00 103 // Underlying write is thread safe
IKobayashi 0:c88c3b616c00 104 write(value);
IKobayashi 0:c88c3b616c00 105 return *this;
IKobayashi 0:c88c3b616c00 106 }
IKobayashi 0:c88c3b616c00 107
IKobayashi 0:c88c3b616c00 108 DigitalOut& operator= (DigitalOut& rhs) {
IKobayashi 0:c88c3b616c00 109 core_util_critical_section_enter();
IKobayashi 0:c88c3b616c00 110 write(rhs.read());
IKobayashi 0:c88c3b616c00 111 core_util_critical_section_exit();
IKobayashi 0:c88c3b616c00 112 return *this;
IKobayashi 0:c88c3b616c00 113 }
IKobayashi 0:c88c3b616c00 114
IKobayashi 0:c88c3b616c00 115 /** A shorthand for read()
IKobayashi 0:c88c3b616c00 116 */
IKobayashi 0:c88c3b616c00 117 operator int() {
IKobayashi 0:c88c3b616c00 118 // Underlying call is thread safe
IKobayashi 0:c88c3b616c00 119 return read();
IKobayashi 0:c88c3b616c00 120 }
IKobayashi 0:c88c3b616c00 121
IKobayashi 0:c88c3b616c00 122 protected:
IKobayashi 0:c88c3b616c00 123 gpio_t gpio;
IKobayashi 0:c88c3b616c00 124 };
IKobayashi 0:c88c3b616c00 125
IKobayashi 0:c88c3b616c00 126 } // namespace mbed
IKobayashi 0:c88c3b616c00 127
IKobayashi 0:c88c3b616c00 128 #endif
IKobayashi 0:c88c3b616c00 129
IKobayashi 0:c88c3b616c00 130 /** @}*/