jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

DigitalOut.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_DIGITALOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 23 #define MBED_DIGITALOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 24
rolf.meyer@arm.com 11:1c1ebd0324fa 25 #include "platform.h"
emilmont 44:24d45a770a51 26 #include "gpio_api.h"
simon.ford@mbed.co.uk 0:82220227f4fa 27
simon.ford@mbed.co.uk 0:82220227f4fa 28 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 29
emilmont 43:e2ed12d17f06 30 /** A digital output, used for setting the state of a pin
rolf.meyer@arm.com 11:1c1ebd0324fa 31 *
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * Example:
emilmont 43:e2ed12d17f06 33 * @code
emilmont 43:e2ed12d17f06 34 * // Toggle a LED
emilmont 43:e2ed12d17f06 35 * #include "mbed.h"
emilmont 43:e2ed12d17f06 36 *
emilmont 43:e2ed12d17f06 37 * DigitalOut led(LED1);
emilmont 43:e2ed12d17f06 38 *
emilmont 43:e2ed12d17f06 39 * int main() {
emilmont 43:e2ed12d17f06 40 * while(1) {
emilmont 43:e2ed12d17f06 41 * led = !led;
emilmont 43:e2ed12d17f06 42 * wait(0.2);
emilmont 43:e2ed12d17f06 43 * }
emilmont 43:e2ed12d17f06 44 * }
emilmont 43:e2ed12d17f06 45 * @endcode
simon.ford@mbed.co.uk 0:82220227f4fa 46 */
emilmont 44:24d45a770a51 47 class DigitalOut {
simon.ford@mbed.co.uk 0:82220227f4fa 48
simon.ford@mbed.co.uk 0:82220227f4fa 49 public:
emilmont 43:e2ed12d17f06 50 /** Create a DigitalOut connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 51 *
emilmont 43:e2ed12d17f06 52 * @param pin DigitalOut pin to connect to
rolf.meyer@arm.com 11:1c1ebd0324fa 53 */
emilmont 44:24d45a770a51 54 DigitalOut(PinName pin) {
emilmont 44:24d45a770a51 55 gpio_init(&gpio, pin, PIN_OUTPUT);
emilmont 44:24d45a770a51 56 }
emilmont 44:24d45a770a51 57
emilmont 43:e2ed12d17f06 58 /** Set the output, specified as 0 or 1 (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 59 *
emilmont 43:e2ed12d17f06 60 * @param value An integer specifying the pin output value,
emilmont 43:e2ed12d17f06 61 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
rolf.meyer@arm.com 11:1c1ebd0324fa 62 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 63 void write(int value) {
emilmont 44:24d45a770a51 64 gpio_write(&gpio, value);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 65 }
emilmont 44:24d45a770a51 66
emilmont 43:e2ed12d17f06 67 /** Return the output setting, represented as 0 or 1 (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 68 *
emilmont 43:e2ed12d17f06 69 * @returns
emilmont 43:e2ed12d17f06 70 * an integer representing the output setting of the pin,
emilmont 43:e2ed12d17f06 71 * 0 for logical 0, 1 for logical 1
rolf.meyer@arm.com 11:1c1ebd0324fa 72 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 73 int read() {
emilmont 44:24d45a770a51 74 return gpio_read(&gpio);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 75 }
emilmont 44:24d45a770a51 76
rolf.meyer@arm.com 11:1c1ebd0324fa 77 #ifdef MBED_OPERATORS
emilmont 43:e2ed12d17f06 78 /** A shorthand for write()
rolf.meyer@arm.com 11:1c1ebd0324fa 79 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 80 DigitalOut& operator= (int value) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 81 write(value);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 82 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 83 }
emilmont 44:24d45a770a51 84
simon.ford@mbed.co.uk 18:b3c9f16cbb96 85 DigitalOut& operator= (DigitalOut& rhs) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 86 write(rhs.read());
simon.ford@mbed.co.uk 18:b3c9f16cbb96 87 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 88 }
rolf.meyer@arm.com 11:1c1ebd0324fa 89
emilmont 43:e2ed12d17f06 90 /** A shorthand for read()
simon.ford@mbed.co.uk 0:82220227f4fa 91 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 92 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 93 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 94 }
rolf.meyer@arm.com 11:1c1ebd0324fa 95 #endif
simon.ford@mbed.co.uk 0:82220227f4fa 96
simon.ford@mbed.co.uk 0:82220227f4fa 97 protected:
emilmont 44:24d45a770a51 98 gpio_t gpio;
simon.ford@mbed.co.uk 0:82220227f4fa 99 };
simon.ford@mbed.co.uk 0:82220227f4fa 100
rolf.meyer@arm.com 11:1c1ebd0324fa 101 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 102
rolf.meyer@arm.com 11:1c1ebd0324fa 103 #endif