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.
DigitalOut.h@123:b0220dba8be7, 2016-08-12 (annotated)
- Committer:
- Kojto
- Date:
- Fri Aug 12 13:04:35 2016 +0200
- Revision:
- 123:b0220dba8be7
- Parent:
- 122:f9eeca106725
Release 123 of the mbed library
Changes:
- new targets: nucleo_f207zg, beetle, nrf51_dk, hexiwear,
nuvoton nuc472, vk rz a1h
- ST - fix timer interrupt handler, sleep api fix
- NXP - lpc15xx us ticker fix
- Nordic - analogin fixes, LF clock init addition, enable i2c async
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
bogdanm | 65:5798e58a58b1 | 1 | /* mbed Microcontroller Library |
bogdanm | 65:5798e58a58b1 | 2 | * Copyright (c) 2006-2013 ARM Limited |
bogdanm | 65:5798e58a58b1 | 3 | * |
bogdanm | 65:5798e58a58b1 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
bogdanm | 65:5798e58a58b1 | 5 | * you may not use this file except in compliance with the License. |
bogdanm | 65:5798e58a58b1 | 6 | * You may obtain a copy of the License at |
bogdanm | 65:5798e58a58b1 | 7 | * |
bogdanm | 65:5798e58a58b1 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
bogdanm | 65:5798e58a58b1 | 9 | * |
bogdanm | 65:5798e58a58b1 | 10 | * Unless required by applicable law or agreed to in writing, software |
bogdanm | 65:5798e58a58b1 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
bogdanm | 65:5798e58a58b1 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
bogdanm | 65:5798e58a58b1 | 13 | * See the License for the specific language governing permissions and |
bogdanm | 65:5798e58a58b1 | 14 | * limitations under the License. |
bogdanm | 65:5798e58a58b1 | 15 | */ |
bogdanm | 65:5798e58a58b1 | 16 | #ifndef MBED_DIGITALOUT_H |
bogdanm | 65:5798e58a58b1 | 17 | #define MBED_DIGITALOUT_H |
bogdanm | 65:5798e58a58b1 | 18 | |
bogdanm | 65:5798e58a58b1 | 19 | #include "platform.h" |
bogdanm | 65:5798e58a58b1 | 20 | #include "gpio_api.h" |
Kojto | 122:f9eeca106725 | 21 | #include "critical.h" |
bogdanm | 65:5798e58a58b1 | 22 | |
bogdanm | 65:5798e58a58b1 | 23 | namespace mbed { |
bogdanm | 65:5798e58a58b1 | 24 | |
bogdanm | 65:5798e58a58b1 | 25 | /** A digital output, used for setting the state of a pin |
bogdanm | 65:5798e58a58b1 | 26 | * |
Kojto | 122:f9eeca106725 | 27 | * @Note Synchronization level: Interrupt safe |
Kojto | 122:f9eeca106725 | 28 | * |
bogdanm | 65:5798e58a58b1 | 29 | * Example: |
bogdanm | 65:5798e58a58b1 | 30 | * @code |
bogdanm | 65:5798e58a58b1 | 31 | * // Toggle a LED |
bogdanm | 65:5798e58a58b1 | 32 | * #include "mbed.h" |
bogdanm | 65:5798e58a58b1 | 33 | * |
bogdanm | 65:5798e58a58b1 | 34 | * DigitalOut led(LED1); |
bogdanm | 65:5798e58a58b1 | 35 | * |
bogdanm | 65:5798e58a58b1 | 36 | * int main() { |
bogdanm | 65:5798e58a58b1 | 37 | * while(1) { |
bogdanm | 65:5798e58a58b1 | 38 | * led = !led; |
bogdanm | 65:5798e58a58b1 | 39 | * wait(0.2); |
bogdanm | 65:5798e58a58b1 | 40 | * } |
bogdanm | 65:5798e58a58b1 | 41 | * } |
bogdanm | 65:5798e58a58b1 | 42 | * @endcode |
bogdanm | 65:5798e58a58b1 | 43 | */ |
bogdanm | 65:5798e58a58b1 | 44 | class DigitalOut { |
bogdanm | 65:5798e58a58b1 | 45 | |
bogdanm | 65:5798e58a58b1 | 46 | public: |
bogdanm | 65:5798e58a58b1 | 47 | /** Create a DigitalOut connected to the specified pin |
bogdanm | 65:5798e58a58b1 | 48 | * |
bogdanm | 65:5798e58a58b1 | 49 | * @param pin DigitalOut pin to connect to |
bogdanm | 65:5798e58a58b1 | 50 | */ |
bogdanm | 85:024bf7f99721 | 51 | DigitalOut(PinName pin) : gpio() { |
Kojto | 122:f9eeca106725 | 52 | // No lock needed in the constructor |
bogdanm | 81:7d30d6019079 | 53 | gpio_init_out(&gpio, pin); |
bogdanm | 81:7d30d6019079 | 54 | } |
bogdanm | 81:7d30d6019079 | 55 | |
bogdanm | 81:7d30d6019079 | 56 | /** Create a DigitalOut connected to the specified pin |
bogdanm | 81:7d30d6019079 | 57 | * |
bogdanm | 81:7d30d6019079 | 58 | * @param pin DigitalOut pin to connect to |
bogdanm | 81:7d30d6019079 | 59 | * @param value the initial pin value |
bogdanm | 81:7d30d6019079 | 60 | */ |
bogdanm | 85:024bf7f99721 | 61 | DigitalOut(PinName pin, int value) : gpio() { |
Kojto | 122:f9eeca106725 | 62 | // No lock needed in the constructor |
bogdanm | 81:7d30d6019079 | 63 | gpio_init_out_ex(&gpio, pin, value); |
bogdanm | 65:5798e58a58b1 | 64 | } |
bogdanm | 65:5798e58a58b1 | 65 | |
bogdanm | 65:5798e58a58b1 | 66 | /** Set the output, specified as 0 or 1 (int) |
bogdanm | 65:5798e58a58b1 | 67 | * |
bogdanm | 65:5798e58a58b1 | 68 | * @param value An integer specifying the pin output value, |
bogdanm | 65:5798e58a58b1 | 69 | * 0 for logical 0, 1 (or any other non-zero value) for logical 1 |
bogdanm | 65:5798e58a58b1 | 70 | */ |
bogdanm | 65:5798e58a58b1 | 71 | void write(int value) { |
Kojto | 122:f9eeca106725 | 72 | // Thread safe / atomic HAL call |
bogdanm | 65:5798e58a58b1 | 73 | gpio_write(&gpio, value); |
bogdanm | 65:5798e58a58b1 | 74 | } |
bogdanm | 65:5798e58a58b1 | 75 | |
bogdanm | 65:5798e58a58b1 | 76 | /** Return the output setting, represented as 0 or 1 (int) |
bogdanm | 65:5798e58a58b1 | 77 | * |
bogdanm | 65:5798e58a58b1 | 78 | * @returns |
bogdanm | 65:5798e58a58b1 | 79 | * an integer representing the output setting of the pin, |
bogdanm | 65:5798e58a58b1 | 80 | * 0 for logical 0, 1 for logical 1 |
bogdanm | 65:5798e58a58b1 | 81 | */ |
bogdanm | 65:5798e58a58b1 | 82 | int read() { |
Kojto | 122:f9eeca106725 | 83 | // Thread safe / atomic HAL call |
bogdanm | 65:5798e58a58b1 | 84 | return gpio_read(&gpio); |
bogdanm | 65:5798e58a58b1 | 85 | } |
bogdanm | 65:5798e58a58b1 | 86 | |
Kojto | 93:e188a91d3eaa | 87 | /** Return the output setting, represented as 0 or 1 (int) |
Kojto | 93:e188a91d3eaa | 88 | * |
Kojto | 93:e188a91d3eaa | 89 | * @returns |
Kojto | 93:e188a91d3eaa | 90 | * Non zero value if pin is connected to uc GPIO |
Kojto | 93:e188a91d3eaa | 91 | * 0 if gpio object was initialized with NC |
Kojto | 93:e188a91d3eaa | 92 | */ |
Kojto | 93:e188a91d3eaa | 93 | int is_connected() { |
Kojto | 122:f9eeca106725 | 94 | // Thread safe / atomic HAL call |
Kojto | 93:e188a91d3eaa | 95 | return gpio_is_connected(&gpio); |
Kojto | 93:e188a91d3eaa | 96 | } |
Kojto | 93:e188a91d3eaa | 97 | |
bogdanm | 65:5798e58a58b1 | 98 | /** A shorthand for write() |
bogdanm | 65:5798e58a58b1 | 99 | */ |
bogdanm | 65:5798e58a58b1 | 100 | DigitalOut& operator= (int value) { |
Kojto | 122:f9eeca106725 | 101 | // Underlying write is thread safe |
bogdanm | 65:5798e58a58b1 | 102 | write(value); |
bogdanm | 65:5798e58a58b1 | 103 | return *this; |
bogdanm | 65:5798e58a58b1 | 104 | } |
bogdanm | 65:5798e58a58b1 | 105 | |
bogdanm | 65:5798e58a58b1 | 106 | DigitalOut& operator= (DigitalOut& rhs) { |
Kojto | 122:f9eeca106725 | 107 | core_util_critical_section_enter(); |
bogdanm | 65:5798e58a58b1 | 108 | write(rhs.read()); |
Kojto | 122:f9eeca106725 | 109 | core_util_critical_section_exit(); |
bogdanm | 65:5798e58a58b1 | 110 | return *this; |
bogdanm | 65:5798e58a58b1 | 111 | } |
bogdanm | 65:5798e58a58b1 | 112 | |
bogdanm | 65:5798e58a58b1 | 113 | /** A shorthand for read() |
bogdanm | 65:5798e58a58b1 | 114 | */ |
bogdanm | 65:5798e58a58b1 | 115 | operator int() { |
Kojto | 122:f9eeca106725 | 116 | // Underlying call is thread safe |
bogdanm | 65:5798e58a58b1 | 117 | return read(); |
bogdanm | 65:5798e58a58b1 | 118 | } |
bogdanm | 65:5798e58a58b1 | 119 | |
bogdanm | 65:5798e58a58b1 | 120 | protected: |
bogdanm | 65:5798e58a58b1 | 121 | gpio_t gpio; |
bogdanm | 65:5798e58a58b1 | 122 | }; |
bogdanm | 65:5798e58a58b1 | 123 | |
bogdanm | 65:5798e58a58b1 | 124 | } // namespace mbed |
bogdanm | 65:5798e58a58b1 | 125 | |
bogdanm | 65:5798e58a58b1 | 126 | #endif |