Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

DigitalIn.h@59:0883845fe643, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 11:12:58 2013 +0000
Revision:
59:0883845fe643
Parent:
55:d722ed6a4237
Child:
65:5798e58a58b1
Add pinmap NC terminators for LPC1768 CAN.

Update the license from MIT to Apache v2.

Make the semihost code target independent using opportune defines for the UID and MAC.

Who changed what in which revision?

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