Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/drivers/DigitalIn.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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