takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/drivers/DigitalIn.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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