The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
drivers/DigitalInOut.h@136:ef9c61f8c49f, 2017-02-14 (annotated)
- Committer:
- Kojto
- Date:
- Tue Feb 14 11:24:20 2017 +0000
- Revision:
- 136:ef9c61f8c49f
- Parent:
- 128:9bcdf88f62b0
- Child:
- 138:093f2bd7b9eb
Release 136 of the mbed library
Ports for Upcoming Targets
Fixes and Changes
3432: Target STM USBHOST support https://github.com/ARMmbed/mbed-os/pull/3432
3181: NUCLEO_F207ZG extending PeripheralPins.c: all available alternate functions can be used now https://github.com/ARMmbed/mbed-os/pull/3181
3626: NUCLEO_F412ZG : Add USB Device +Host https://github.com/ARMmbed/mbed-os/pull/3626
3628: Fix warnings https://github.com/ARMmbed/mbed-os/pull/3628
3629: STM32: L0 LL layer https://github.com/ARMmbed/mbed-os/pull/3629
3632: IDE Export support for platform VK_RZ_A1H https://github.com/ARMmbed/mbed-os/pull/3632
3642: Missing IRQ pin fix for platform VK_RZ_A1H https://github.com/ARMmbed/mbed-os/pull/3642
3664: Fix ncs36510 sleep definitions https://github.com/ARMmbed/mbed-os/pull/3664
3655: [STM32F4] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3655
3657: [STM32L4] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3657
3658: [STM32F3] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3658
3685: STM32: I2C: reset state machine https://github.com/ARMmbed/mbed-os/pull/3685
3692: uVisor: Standardize available legacy heap and stack https://github.com/ARMmbed/mbed-os/pull/3692
3621: Fix for #2884, LPC824: export to LPCXpresso, target running with wron https://github.com/ARMmbed/mbed-os/pull/3621
3649: [STM32F7] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3649
3695: Enforce device_name is valid in targets.json https://github.com/ARMmbed/mbed-os/pull/3695
3723: NCS36510: spi_format function bug fix https://github.com/ARMmbed/mbed-os/pull/3723
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
<> | 128:9bcdf88f62b0 | 1 | /* mbed Microcontroller Library |
<> | 128:9bcdf88f62b0 | 2 | * Copyright (c) 2006-2013 ARM Limited |
<> | 128:9bcdf88f62b0 | 3 | * |
<> | 128:9bcdf88f62b0 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
<> | 128:9bcdf88f62b0 | 5 | * you may not use this file except in compliance with the License. |
<> | 128:9bcdf88f62b0 | 6 | * You may obtain a copy of the License at |
<> | 128:9bcdf88f62b0 | 7 | * |
<> | 128:9bcdf88f62b0 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
<> | 128:9bcdf88f62b0 | 9 | * |
<> | 128:9bcdf88f62b0 | 10 | * Unless required by applicable law or agreed to in writing, software |
<> | 128:9bcdf88f62b0 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
<> | 128:9bcdf88f62b0 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
<> | 128:9bcdf88f62b0 | 13 | * See the License for the specific language governing permissions and |
<> | 128:9bcdf88f62b0 | 14 | * limitations under the License. |
<> | 128:9bcdf88f62b0 | 15 | */ |
<> | 128:9bcdf88f62b0 | 16 | #ifndef MBED_DIGITALINOUT_H |
<> | 128:9bcdf88f62b0 | 17 | #define MBED_DIGITALINOUT_H |
<> | 128:9bcdf88f62b0 | 18 | |
<> | 128:9bcdf88f62b0 | 19 | #include "platform/platform.h" |
<> | 128:9bcdf88f62b0 | 20 | |
<> | 128:9bcdf88f62b0 | 21 | #include "hal/gpio_api.h" |
<> | 128:9bcdf88f62b0 | 22 | #include "platform/critical.h" |
<> | 128:9bcdf88f62b0 | 23 | |
<> | 128:9bcdf88f62b0 | 24 | namespace mbed { |
<> | 128:9bcdf88f62b0 | 25 | /** \addtogroup drivers */ |
<> | 128:9bcdf88f62b0 | 26 | /** @{*/ |
<> | 128:9bcdf88f62b0 | 27 | |
<> | 128:9bcdf88f62b0 | 28 | /** A digital input/output, used for setting or reading a bi-directional pin |
<> | 128:9bcdf88f62b0 | 29 | * |
<> | 128:9bcdf88f62b0 | 30 | * @Note Synchronization level: Interrupt safe |
<> | 128:9bcdf88f62b0 | 31 | */ |
<> | 128:9bcdf88f62b0 | 32 | class DigitalInOut { |
<> | 128:9bcdf88f62b0 | 33 | |
<> | 128:9bcdf88f62b0 | 34 | public: |
<> | 128:9bcdf88f62b0 | 35 | /** Create a DigitalInOut connected to the specified pin |
<> | 128:9bcdf88f62b0 | 36 | * |
<> | 128:9bcdf88f62b0 | 37 | * @param pin DigitalInOut pin to connect to |
<> | 128:9bcdf88f62b0 | 38 | */ |
<> | 128:9bcdf88f62b0 | 39 | DigitalInOut(PinName pin) : gpio() { |
<> | 128:9bcdf88f62b0 | 40 | // No lock needed in the constructor |
<> | 128:9bcdf88f62b0 | 41 | gpio_init_in(&gpio, pin); |
<> | 128:9bcdf88f62b0 | 42 | } |
<> | 128:9bcdf88f62b0 | 43 | |
<> | 128:9bcdf88f62b0 | 44 | /** Create a DigitalInOut connected to the specified pin |
<> | 128:9bcdf88f62b0 | 45 | * |
<> | 128:9bcdf88f62b0 | 46 | * @param pin DigitalInOut pin to connect to |
<> | 128:9bcdf88f62b0 | 47 | * @param direction the initial direction of the pin |
<> | 128:9bcdf88f62b0 | 48 | * @param mode the initial mode of the pin |
<> | 128:9bcdf88f62b0 | 49 | * @param value the initial value of the pin if is an output |
<> | 128:9bcdf88f62b0 | 50 | */ |
<> | 128:9bcdf88f62b0 | 51 | DigitalInOut(PinName pin, PinDirection direction, PinMode mode, int value) : gpio() { |
<> | 128:9bcdf88f62b0 | 52 | // No lock needed in the constructor |
<> | 128:9bcdf88f62b0 | 53 | gpio_init_inout(&gpio, pin, direction, mode, value); |
<> | 128:9bcdf88f62b0 | 54 | } |
<> | 128:9bcdf88f62b0 | 55 | |
<> | 128:9bcdf88f62b0 | 56 | /** Set the output, specified as 0 or 1 (int) |
<> | 128:9bcdf88f62b0 | 57 | * |
<> | 128:9bcdf88f62b0 | 58 | * @param value An integer specifying the pin output value, |
<> | 128:9bcdf88f62b0 | 59 | * 0 for logical 0, 1 (or any other non-zero value) for logical 1 |
<> | 128:9bcdf88f62b0 | 60 | */ |
<> | 128:9bcdf88f62b0 | 61 | void write(int value) { |
<> | 128:9bcdf88f62b0 | 62 | // Thread safe / atomic HAL call |
<> | 128:9bcdf88f62b0 | 63 | gpio_write(&gpio, value); |
<> | 128:9bcdf88f62b0 | 64 | } |
<> | 128:9bcdf88f62b0 | 65 | |
<> | 128:9bcdf88f62b0 | 66 | /** Return the output setting, represented as 0 or 1 (int) |
<> | 128:9bcdf88f62b0 | 67 | * |
<> | 128:9bcdf88f62b0 | 68 | * @returns |
<> | 128:9bcdf88f62b0 | 69 | * an integer representing the output setting of the pin if it is an output, |
<> | 128:9bcdf88f62b0 | 70 | * or read the input if set as an input |
<> | 128:9bcdf88f62b0 | 71 | */ |
<> | 128:9bcdf88f62b0 | 72 | int read() { |
<> | 128:9bcdf88f62b0 | 73 | // Thread safe / atomic HAL call |
<> | 128:9bcdf88f62b0 | 74 | return gpio_read(&gpio); |
<> | 128:9bcdf88f62b0 | 75 | } |
<> | 128:9bcdf88f62b0 | 76 | |
<> | 128:9bcdf88f62b0 | 77 | /** Set as an output |
<> | 128:9bcdf88f62b0 | 78 | */ |
<> | 128:9bcdf88f62b0 | 79 | void output() { |
<> | 128:9bcdf88f62b0 | 80 | core_util_critical_section_enter(); |
<> | 128:9bcdf88f62b0 | 81 | gpio_dir(&gpio, PIN_OUTPUT); |
<> | 128:9bcdf88f62b0 | 82 | core_util_critical_section_exit(); |
<> | 128:9bcdf88f62b0 | 83 | } |
<> | 128:9bcdf88f62b0 | 84 | |
<> | 128:9bcdf88f62b0 | 85 | /** Set as an input |
<> | 128:9bcdf88f62b0 | 86 | */ |
<> | 128:9bcdf88f62b0 | 87 | void input() { |
<> | 128:9bcdf88f62b0 | 88 | core_util_critical_section_enter(); |
<> | 128:9bcdf88f62b0 | 89 | gpio_dir(&gpio, PIN_INPUT); |
<> | 128:9bcdf88f62b0 | 90 | core_util_critical_section_exit(); |
<> | 128:9bcdf88f62b0 | 91 | } |
<> | 128:9bcdf88f62b0 | 92 | |
<> | 128:9bcdf88f62b0 | 93 | /** Set the input pin mode |
<> | 128:9bcdf88f62b0 | 94 | * |
<> | 128:9bcdf88f62b0 | 95 | * @param mode PullUp, PullDown, PullNone, OpenDrain |
<> | 128:9bcdf88f62b0 | 96 | */ |
<> | 128:9bcdf88f62b0 | 97 | void mode(PinMode pull) { |
<> | 128:9bcdf88f62b0 | 98 | core_util_critical_section_enter(); |
<> | 128:9bcdf88f62b0 | 99 | gpio_mode(&gpio, pull); |
<> | 128:9bcdf88f62b0 | 100 | core_util_critical_section_exit(); |
<> | 128:9bcdf88f62b0 | 101 | } |
<> | 128:9bcdf88f62b0 | 102 | |
<> | 128:9bcdf88f62b0 | 103 | /** Return the output setting, represented as 0 or 1 (int) |
<> | 128:9bcdf88f62b0 | 104 | * |
<> | 128:9bcdf88f62b0 | 105 | * @returns |
<> | 128:9bcdf88f62b0 | 106 | * Non zero value if pin is connected to uc GPIO |
<> | 128:9bcdf88f62b0 | 107 | * 0 if gpio object was initialized with NC |
<> | 128:9bcdf88f62b0 | 108 | */ |
<> | 128:9bcdf88f62b0 | 109 | int is_connected() { |
<> | 128:9bcdf88f62b0 | 110 | // Thread safe / atomic HAL call |
<> | 128:9bcdf88f62b0 | 111 | return gpio_is_connected(&gpio); |
<> | 128:9bcdf88f62b0 | 112 | } |
<> | 128:9bcdf88f62b0 | 113 | |
<> | 128:9bcdf88f62b0 | 114 | /** A shorthand for write() |
<> | 128:9bcdf88f62b0 | 115 | */ |
<> | 128:9bcdf88f62b0 | 116 | DigitalInOut& operator= (int value) { |
<> | 128:9bcdf88f62b0 | 117 | // Underlying write is thread safe |
<> | 128:9bcdf88f62b0 | 118 | write(value); |
<> | 128:9bcdf88f62b0 | 119 | return *this; |
<> | 128:9bcdf88f62b0 | 120 | } |
<> | 128:9bcdf88f62b0 | 121 | |
<> | 128:9bcdf88f62b0 | 122 | DigitalInOut& operator= (DigitalInOut& rhs) { |
<> | 128:9bcdf88f62b0 | 123 | core_util_critical_section_enter(); |
<> | 128:9bcdf88f62b0 | 124 | write(rhs.read()); |
<> | 128:9bcdf88f62b0 | 125 | core_util_critical_section_exit(); |
<> | 128:9bcdf88f62b0 | 126 | return *this; |
<> | 128:9bcdf88f62b0 | 127 | } |
<> | 128:9bcdf88f62b0 | 128 | |
<> | 128:9bcdf88f62b0 | 129 | /** A shorthand for read() |
<> | 128:9bcdf88f62b0 | 130 | */ |
<> | 128:9bcdf88f62b0 | 131 | operator int() { |
<> | 128:9bcdf88f62b0 | 132 | // Underlying call is thread safe |
<> | 128:9bcdf88f62b0 | 133 | return read(); |
<> | 128:9bcdf88f62b0 | 134 | } |
<> | 128:9bcdf88f62b0 | 135 | |
<> | 128:9bcdf88f62b0 | 136 | protected: |
<> | 128:9bcdf88f62b0 | 137 | gpio_t gpio; |
<> | 128:9bcdf88f62b0 | 138 | }; |
<> | 128:9bcdf88f62b0 | 139 | |
<> | 128:9bcdf88f62b0 | 140 | } // namespace mbed |
<> | 128:9bcdf88f62b0 | 141 | |
<> | 128:9bcdf88f62b0 | 142 | #endif |
<> | 128:9bcdf88f62b0 | 143 | |
<> | 128:9bcdf88f62b0 | 144 | /** @}*/ |