Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/drivers/DigitalOut.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_DIGITALOUT_H
MACRUM 6:40e873bbc5f7 17 #define MBED_DIGITALOUT_H
MACRUM 6:40e873bbc5f7 18
MACRUM 6:40e873bbc5f7 19 #include "platform/platform.h"
MACRUM 6:40e873bbc5f7 20 #include "hal/gpio_api.h"
MACRUM 6:40e873bbc5f7 21 #include "platform/mbed_critical.h"
MACRUM 6:40e873bbc5f7 22
MACRUM 6:40e873bbc5f7 23 namespace mbed {
MACRUM 6:40e873bbc5f7 24 /** \addtogroup drivers */
MACRUM 6:40e873bbc5f7 25 /** @{*/
MACRUM 6:40e873bbc5f7 26
MACRUM 6:40e873bbc5f7 27 /** A digital output, used for setting the state of a pin
MACRUM 6:40e873bbc5f7 28 *
MACRUM 6:40e873bbc5f7 29 * @Note Synchronization level: Interrupt safe
MACRUM 6:40e873bbc5f7 30 *
MACRUM 6:40e873bbc5f7 31 * Example:
MACRUM 6:40e873bbc5f7 32 * @code
MACRUM 6:40e873bbc5f7 33 * // Toggle a LED
MACRUM 6:40e873bbc5f7 34 * #include "mbed.h"
MACRUM 6:40e873bbc5f7 35 *
MACRUM 6:40e873bbc5f7 36 * DigitalOut led(LED1);
MACRUM 6:40e873bbc5f7 37 *
MACRUM 6:40e873bbc5f7 38 * int main() {
MACRUM 6:40e873bbc5f7 39 * while(1) {
MACRUM 6:40e873bbc5f7 40 * led = !led;
MACRUM 6:40e873bbc5f7 41 * wait(0.2);
MACRUM 6:40e873bbc5f7 42 * }
MACRUM 6:40e873bbc5f7 43 * }
MACRUM 6:40e873bbc5f7 44 * @endcode
MACRUM 6:40e873bbc5f7 45 */
MACRUM 6:40e873bbc5f7 46 class DigitalOut {
MACRUM 6:40e873bbc5f7 47
MACRUM 6:40e873bbc5f7 48 public:
MACRUM 6:40e873bbc5f7 49 /** Create a DigitalOut connected to the specified pin
MACRUM 6:40e873bbc5f7 50 *
MACRUM 6:40e873bbc5f7 51 * @param pin DigitalOut pin to connect to
MACRUM 6:40e873bbc5f7 52 */
MACRUM 6:40e873bbc5f7 53 DigitalOut(PinName pin) : gpio() {
MACRUM 6:40e873bbc5f7 54 // No lock needed in the constructor
MACRUM 6:40e873bbc5f7 55 gpio_init_out(&gpio, pin);
MACRUM 6:40e873bbc5f7 56 }
MACRUM 6:40e873bbc5f7 57
MACRUM 6:40e873bbc5f7 58 /** Create a DigitalOut connected to the specified pin
MACRUM 6:40e873bbc5f7 59 *
MACRUM 6:40e873bbc5f7 60 * @param pin DigitalOut pin to connect to
MACRUM 6:40e873bbc5f7 61 * @param value the initial pin value
MACRUM 6:40e873bbc5f7 62 */
MACRUM 6:40e873bbc5f7 63 DigitalOut(PinName pin, int value) : gpio() {
MACRUM 6:40e873bbc5f7 64 // No lock needed in the constructor
MACRUM 6:40e873bbc5f7 65 gpio_init_out_ex(&gpio, pin, value);
MACRUM 6:40e873bbc5f7 66 }
MACRUM 6:40e873bbc5f7 67
MACRUM 6:40e873bbc5f7 68 /** Set the output, specified as 0 or 1 (int)
MACRUM 6:40e873bbc5f7 69 *
MACRUM 6:40e873bbc5f7 70 * @param value An integer specifying the pin output value,
MACRUM 6:40e873bbc5f7 71 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
MACRUM 6:40e873bbc5f7 72 */
MACRUM 6:40e873bbc5f7 73 void write(int value) {
MACRUM 6:40e873bbc5f7 74 // Thread safe / atomic HAL call
MACRUM 6:40e873bbc5f7 75 gpio_write(&gpio, value);
MACRUM 6:40e873bbc5f7 76 }
MACRUM 6:40e873bbc5f7 77
MACRUM 6:40e873bbc5f7 78 /** Return the output setting, represented as 0 or 1 (int)
MACRUM 6:40e873bbc5f7 79 *
MACRUM 6:40e873bbc5f7 80 * @returns
MACRUM 6:40e873bbc5f7 81 * an integer representing the output setting of the pin,
MACRUM 6:40e873bbc5f7 82 * 0 for logical 0, 1 for logical 1
MACRUM 6:40e873bbc5f7 83 */
MACRUM 6:40e873bbc5f7 84 int read() {
MACRUM 6:40e873bbc5f7 85 // Thread safe / atomic HAL call
MACRUM 6:40e873bbc5f7 86 return gpio_read(&gpio);
MACRUM 6:40e873bbc5f7 87 }
MACRUM 6:40e873bbc5f7 88
MACRUM 6:40e873bbc5f7 89 /** Return the output setting, represented as 0 or 1 (int)
MACRUM 6:40e873bbc5f7 90 *
MACRUM 6:40e873bbc5f7 91 * @returns
MACRUM 6:40e873bbc5f7 92 * Non zero value if pin is connected to uc GPIO
MACRUM 6:40e873bbc5f7 93 * 0 if gpio object was initialized with NC
MACRUM 6:40e873bbc5f7 94 */
MACRUM 6:40e873bbc5f7 95 int is_connected() {
MACRUM 6:40e873bbc5f7 96 // Thread safe / atomic HAL call
MACRUM 6:40e873bbc5f7 97 return gpio_is_connected(&gpio);
MACRUM 6:40e873bbc5f7 98 }
MACRUM 6:40e873bbc5f7 99
MACRUM 6:40e873bbc5f7 100 /** A shorthand for write()
MACRUM 6:40e873bbc5f7 101 */
MACRUM 6:40e873bbc5f7 102 DigitalOut& operator= (int value) {
MACRUM 6:40e873bbc5f7 103 // Underlying write is thread safe
MACRUM 6:40e873bbc5f7 104 write(value);
MACRUM 6:40e873bbc5f7 105 return *this;
MACRUM 6:40e873bbc5f7 106 }
MACRUM 6:40e873bbc5f7 107
MACRUM 6:40e873bbc5f7 108 DigitalOut& operator= (DigitalOut& rhs) {
MACRUM 6:40e873bbc5f7 109 core_util_critical_section_enter();
MACRUM 6:40e873bbc5f7 110 write(rhs.read());
MACRUM 6:40e873bbc5f7 111 core_util_critical_section_exit();
MACRUM 6:40e873bbc5f7 112 return *this;
MACRUM 6:40e873bbc5f7 113 }
MACRUM 6:40e873bbc5f7 114
MACRUM 6:40e873bbc5f7 115 /** A shorthand for read()
MACRUM 6:40e873bbc5f7 116 */
MACRUM 6:40e873bbc5f7 117 operator int() {
MACRUM 6:40e873bbc5f7 118 // Underlying call is thread safe
MACRUM 6:40e873bbc5f7 119 return read();
MACRUM 6:40e873bbc5f7 120 }
MACRUM 6:40e873bbc5f7 121
MACRUM 6:40e873bbc5f7 122 protected:
MACRUM 6:40e873bbc5f7 123 gpio_t gpio;
MACRUM 6:40e873bbc5f7 124 };
MACRUM 6:40e873bbc5f7 125
MACRUM 6:40e873bbc5f7 126 } // namespace mbed
MACRUM 6:40e873bbc5f7 127
MACRUM 6:40e873bbc5f7 128 #endif
MACRUM 6:40e873bbc5f7 129
MACRUM 6:40e873bbc5f7 130 /** @}*/