mbed official / mbed

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/DigitalIn.h@138:093f2bd7b9eb, 2017-03-14 (annotated)

Committer:
<>
Date:
Tue Mar 14 16:20:51 2017 +0000
Revision:
138:093f2bd7b9eb
Parent:
128:9bcdf88f62b0
Child:
145:64910690c574
Release 138 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3716: fix for issue #3715: correction in startup files for ARM and IAR, alignment of system_stm32f429xx.c files https://github.com/ARMmbed/mbed-os/pull/3716

3741: STM32 remove warning in hal_tick_32b.c file https://github.com/ARMmbed/mbed-os/pull/3741

3780: STM32L4 : Fix GPIO G port compatibility https://github.com/ARMmbed/mbed-os/pull/3780

3831: NCS36510: SPISLAVE enabled (Conflict resolved) https://github.com/ARMmbed/mbed-os/pull/3831

3836: Allow to redefine nRF's PSTORAGE_NUM_OF_PAGES outside of the mbed-os https://github.com/ARMmbed/mbed-os/pull/3836

3840: STM32: gpio SPEED - always set High Speed by default https://github.com/ARMmbed/mbed-os/pull/3840

3844: STM32 GPIO: Typo correction. Update comment (GPIO_IP_WITHOUT_BRR) https://github.com/ARMmbed/mbed-os/pull/3844

3850: STM32: change spi error to debug warning https://github.com/ARMmbed/mbed-os/pull/3850

3860: Define GPIO_IP_WITHOUT_BRR for xDot platform https://github.com/ARMmbed/mbed-os/pull/3860

3880: DISCO_F469NI: allow the use of CAN2 instance when CAN1 is not activated https://github.com/ARMmbed/mbed-os/pull/3880

3795: Fix pwm period calc https://github.com/ARMmbed/mbed-os/pull/3795

3828: STM32 CAN API: correct format and type https://github.com/ARMmbed/mbed-os/pull/3828

3842: TARGET_NRF: corrected spi_init() to properly handle re-initialization https://github.com/ARMmbed/mbed-os/pull/3842

3843: STM32L476xG: set APB2 clock to 80MHz (instead of 40MHz) https://github.com/ARMmbed/mbed-os/pull/3843

3879: NUCLEO_F446ZE: Add missing AnalogIn pins on PF_3, PF_5 and PF_10. https://github.com/ARMmbed/mbed-os/pull/3879

3902: Fix heap and stack size for NUCLEO_F746ZG https://github.com/ARMmbed/mbed-os/pull/3902

3829: can_write(): return error code when no tx mailboxes are available https://github.com/ARMmbed/mbed-os/pull/3829

Who changed what in which revision?

UserRevisionLine numberNew 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_DIGITALIN_H
<> 128:9bcdf88f62b0 17 #define MBED_DIGITALIN_H
<> 128:9bcdf88f62b0 18
<> 128:9bcdf88f62b0 19 #include "platform/platform.h"
<> 128:9bcdf88f62b0 20
<> 128:9bcdf88f62b0 21 #include "hal/gpio_api.h"
<> 138:093f2bd7b9eb 22 #include "platform/mbed_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, used for reading the state of a pin
<> 128:9bcdf88f62b0 29 *
<> 128:9bcdf88f62b0 30 * @Note Synchronization level: Interrupt safe
<> 128:9bcdf88f62b0 31 *
<> 128:9bcdf88f62b0 32 * Example:
<> 128:9bcdf88f62b0 33 * @code
<> 128:9bcdf88f62b0 34 * // Flash an LED while a DigitalIn is true
<> 128:9bcdf88f62b0 35 *
<> 128:9bcdf88f62b0 36 * #include "mbed.h"
<> 128:9bcdf88f62b0 37 *
<> 128:9bcdf88f62b0 38 * DigitalIn enable(p5);
<> 128:9bcdf88f62b0 39 * DigitalOut led(LED1);
<> 128:9bcdf88f62b0 40 *
<> 128:9bcdf88f62b0 41 * int main() {
<> 128:9bcdf88f62b0 42 * while(1) {
<> 128:9bcdf88f62b0 43 * if(enable) {
<> 128:9bcdf88f62b0 44 * led = !led;
<> 128:9bcdf88f62b0 45 * }
<> 128:9bcdf88f62b0 46 * wait(0.25);
<> 128:9bcdf88f62b0 47 * }
<> 128:9bcdf88f62b0 48 * }
<> 128:9bcdf88f62b0 49 * @endcode
<> 128:9bcdf88f62b0 50 */
<> 128:9bcdf88f62b0 51 class DigitalIn {
<> 128:9bcdf88f62b0 52
<> 128:9bcdf88f62b0 53 public:
<> 128:9bcdf88f62b0 54 /** Create a DigitalIn connected to the specified pin
<> 128:9bcdf88f62b0 55 *
<> 128:9bcdf88f62b0 56 * @param pin DigitalIn pin to connect to
<> 128:9bcdf88f62b0 57 */
<> 128:9bcdf88f62b0 58 DigitalIn(PinName pin) : gpio() {
<> 128:9bcdf88f62b0 59 // No lock needed in the constructor
<> 128:9bcdf88f62b0 60 gpio_init_in(&gpio, pin);
<> 128:9bcdf88f62b0 61 }
<> 128:9bcdf88f62b0 62
<> 128:9bcdf88f62b0 63 /** Create a DigitalIn connected to the specified pin
<> 128:9bcdf88f62b0 64 *
<> 128:9bcdf88f62b0 65 * @param pin DigitalIn pin to connect to
<> 128:9bcdf88f62b0 66 * @param mode the initial mode of the pin
<> 128:9bcdf88f62b0 67 */
<> 128:9bcdf88f62b0 68 DigitalIn(PinName pin, PinMode mode) : gpio() {
<> 128:9bcdf88f62b0 69 // No lock needed in the constructor
<> 128:9bcdf88f62b0 70 gpio_init_in_ex(&gpio, pin, mode);
<> 128:9bcdf88f62b0 71 }
<> 128:9bcdf88f62b0 72 /** Read the input, represented as 0 or 1 (int)
<> 128:9bcdf88f62b0 73 *
<> 128:9bcdf88f62b0 74 * @returns
<> 128:9bcdf88f62b0 75 * An integer representing the state of the input pin,
<> 128:9bcdf88f62b0 76 * 0 for logical 0, 1 for logical 1
<> 128:9bcdf88f62b0 77 */
<> 128:9bcdf88f62b0 78 int read() {
<> 128:9bcdf88f62b0 79 // Thread safe / atomic HAL call
<> 128:9bcdf88f62b0 80 return gpio_read(&gpio);
<> 128:9bcdf88f62b0 81 }
<> 128:9bcdf88f62b0 82
<> 128:9bcdf88f62b0 83 /** Set the input pin mode
<> 128:9bcdf88f62b0 84 *
<> 128:9bcdf88f62b0 85 * @param mode PullUp, PullDown, PullNone, OpenDrain
<> 128:9bcdf88f62b0 86 */
<> 128:9bcdf88f62b0 87 void mode(PinMode pull) {
<> 128:9bcdf88f62b0 88 core_util_critical_section_enter();
<> 128:9bcdf88f62b0 89 gpio_mode(&gpio, pull);
<> 128:9bcdf88f62b0 90 core_util_critical_section_exit();
<> 128:9bcdf88f62b0 91 }
<> 128:9bcdf88f62b0 92
<> 128:9bcdf88f62b0 93 /** Return the output setting, represented as 0 or 1 (int)
<> 128:9bcdf88f62b0 94 *
<> 128:9bcdf88f62b0 95 * @returns
<> 128:9bcdf88f62b0 96 * Non zero value if pin is connected to uc GPIO
<> 128:9bcdf88f62b0 97 * 0 if gpio object was initialized with NC
<> 128:9bcdf88f62b0 98 */
<> 128:9bcdf88f62b0 99 int is_connected() {
<> 128:9bcdf88f62b0 100 // Thread safe / atomic HAL call
<> 128:9bcdf88f62b0 101 return gpio_is_connected(&gpio);
<> 128:9bcdf88f62b0 102 }
<> 128:9bcdf88f62b0 103
<> 128:9bcdf88f62b0 104 /** An operator shorthand for read()
<> 128:9bcdf88f62b0 105 */
<> 128:9bcdf88f62b0 106 operator int() {
<> 128:9bcdf88f62b0 107 // Underlying read is thread safe
<> 128:9bcdf88f62b0 108 return read();
<> 128:9bcdf88f62b0 109 }
<> 128:9bcdf88f62b0 110
<> 128:9bcdf88f62b0 111 protected:
<> 128:9bcdf88f62b0 112 gpio_t gpio;
<> 128:9bcdf88f62b0 113 };
<> 128:9bcdf88f62b0 114
<> 128:9bcdf88f62b0 115 } // namespace mbed
<> 128:9bcdf88f62b0 116
<> 128:9bcdf88f62b0 117 #endif
<> 128:9bcdf88f62b0 118
<> 128:9bcdf88f62b0 119 /** @}*/