takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

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