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