雄介 太田 / mbed

mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

DigitalIn.h@44:24d45a770a51, 2012-11-21 (annotated)

Committer:
emilmont
Date:
Wed Nov 21 10:49:56 2012 +0000
Revision:
44:24d45a770a51
Parent:
43:e2ed12d17f06
Child:
54:71b101360fb9
Complete refactoring of the mbed library to move the target dependent code to a thin well defined layer, defining a proper object oriented C API to be implemented by the different silicon vendors.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
simon.ford@mbed.co.uk 0:82220227f4fa 22 #ifndef MBED_DIGITALIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 23 #define MBED_DIGITALIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 24
rolf.meyer@arm.com 11:1c1ebd0324fa 25 #include "platform.h"
emilmont 44:24d45a770a51 26
emilmont 44:24d45a770a51 27 #include "gpio_api.h"
simon.ford@mbed.co.uk 0:82220227f4fa 28
simon.ford@mbed.co.uk 0:82220227f4fa 29 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 30
emilmont 43:e2ed12d17f06 31 /** A digital input, used for reading the state of a pin
simon.ford@mbed.co.uk 5:62573be585e9 32 *
simon.ford@mbed.co.uk 5:62573be585e9 33 * Example:
emilmont 43:e2ed12d17f06 34 * @code
emilmont 43:e2ed12d17f06 35 * // Flash an LED while a DigitalIn is true
emilmont 43:e2ed12d17f06 36 *
emilmont 43:e2ed12d17f06 37 * #include "mbed.h"
emilmont 43:e2ed12d17f06 38 *
emilmont 43:e2ed12d17f06 39 * DigitalIn enable(p5);
emilmont 43:e2ed12d17f06 40 * DigitalOut led(LED1);
emilmont 43:e2ed12d17f06 41 *
emilmont 43:e2ed12d17f06 42 * int main() {
emilmont 43:e2ed12d17f06 43 * while(1) {
emilmont 43:e2ed12d17f06 44 * if(enable) {
emilmont 43:e2ed12d17f06 45 * led = !led;
emilmont 43:e2ed12d17f06 46 * }
emilmont 43:e2ed12d17f06 47 * wait(0.25);
emilmont 43:e2ed12d17f06 48 * }
emilmont 43:e2ed12d17f06 49 * }
emilmont 43:e2ed12d17f06 50 * @endcode
simon.ford@mbed.co.uk 0:82220227f4fa 51 */
emilmont 44:24d45a770a51 52 class DigitalIn {
simon.ford@mbed.co.uk 0:82220227f4fa 53
simon.ford@mbed.co.uk 0:82220227f4fa 54 public:
emilmont 43:e2ed12d17f06 55 /** Create a DigitalIn connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 56 *
emilmont 43:e2ed12d17f06 57 * @param pin DigitalIn pin to connect to
emilmont 43:e2ed12d17f06 58 * @param name (optional) A string to identify the object
rolf.meyer@arm.com 11:1c1ebd0324fa 59 */
emilmont 44:24d45a770a51 60 DigitalIn(PinName pin) {
emilmont 44:24d45a770a51 61 gpio_init(&gpio, pin, PIN_INPUT);
emilmont 44:24d45a770a51 62 }
emilmont 44:24d45a770a51 63
emilmont 43:e2ed12d17f06 64 /** Read the input, represented as 0 or 1 (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 65 *
emilmont 43:e2ed12d17f06 66 * @returns
emilmont 43:e2ed12d17f06 67 * An integer representing the state of the input pin,
emilmont 43:e2ed12d17f06 68 * 0 for logical 0, 1 for logical 1
simon.ford@mbed.co.uk 5:62573be585e9 69 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 70 int read() {
emilmont 44:24d45a770a51 71 return gpio_read(&gpio);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 72 }
emilmont 44:24d45a770a51 73
emilmont 43:e2ed12d17f06 74 /** Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 75 *
emilmont 43:e2ed12d17f06 76 * @param mode PullUp, PullDown, PullNone, OpenDrain
simon.ford@mbed.co.uk 5:62573be585e9 77 */
emilmont 44:24d45a770a51 78 void mode(PinMode pull) {
emilmont 44:24d45a770a51 79 gpio_mode(&gpio, pull);
emilmont 44:24d45a770a51 80 }
rolf.meyer@arm.com 11:1c1ebd0324fa 81
emilmont 44:24d45a770a51 82 #ifdef MBED_OPERATORS
emilmont 43:e2ed12d17f06 83 /** An operator shorthand for read()
simon.ford@mbed.co.uk 0:82220227f4fa 84 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 85 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 86 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 87 }
rolf.meyer@arm.com 11:1c1ebd0324fa 88 #endif
simon.ford@mbed.co.uk 5:62573be585e9 89
simon.ford@mbed.co.uk 0:82220227f4fa 90 protected:
emilmont 44:24d45a770a51 91 gpio_t gpio;
simon.ford@mbed.co.uk 0:82220227f4fa 92 };
simon.ford@mbed.co.uk 0:82220227f4fa 93
rolf.meyer@arm.com 11:1c1ebd0324fa 94 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 95
simon.ford@mbed.co.uk 1:6b7f447ca868 96 #endif