ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

drivers/DigitalIn.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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