mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

api/DigitalIn.h@113:65a335a675de, 2014-03-10 (annotated)

Committer:
mbed_official
Date:
Mon Mar 10 11:30:07 2014 +0000
Revision:
113:65a335a675de
Parent:
13:0645d8841f51
Child:
212:34d62c0b2af6
Synchronized with git revision 423ddcb86e83e2e0d599ca7106d436eb3c47e6dd



Full URL: https://github.com/mbedmicro/mbed/commit/423ddcb86e83e2e0d599ca7106d436eb3c47e6dd/



proposed change of gpio_api (new update pull request)

Who changed what in which revision?

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