First Last / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/DigitalOut.h@35:db417d6d0a5c, 2013-10-16 (annotated)

Committer:
vsluiter
Date:
Wed Oct 16 07:57:27 2013 +0000
Revision:
35:db417d6d0a5c
Parent:
13:0645d8841f51 
Changed startup_MKL25Z4.s

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_DIGITALOUT_H
bogdanm 13:0645d8841f51 17 #define MBED_DIGITALOUT_H
bogdanm 13:0645d8841f51 18
bogdanm 13:0645d8841f51 19 #include "platform.h"
bogdanm 13:0645d8841f51 20 #include "gpio_api.h"
bogdanm 13:0645d8841f51 21
bogdanm 13:0645d8841f51 22 namespace mbed {
bogdanm 13:0645d8841f51 23
bogdanm 13:0645d8841f51 24 /** A digital output, used for setting the state of a pin
bogdanm 13:0645d8841f51 25 *
bogdanm 13:0645d8841f51 26 * Example:
bogdanm 13:0645d8841f51 27 * @code
bogdanm 13:0645d8841f51 28 * // Toggle a LED
bogdanm 13:0645d8841f51 29 * #include "mbed.h"
bogdanm 13:0645d8841f51 30 *
bogdanm 13:0645d8841f51 31 * DigitalOut led(LED1);
bogdanm 13:0645d8841f51 32 *
bogdanm 13:0645d8841f51 33 * int main() {
bogdanm 13:0645d8841f51 34 * while(1) {
bogdanm 13:0645d8841f51 35 * led = !led;
bogdanm 13:0645d8841f51 36 * wait(0.2);
bogdanm 13:0645d8841f51 37 * }
bogdanm 13:0645d8841f51 38 * }
bogdanm 13:0645d8841f51 39 * @endcode
bogdanm 13:0645d8841f51 40 */
bogdanm 13:0645d8841f51 41 class DigitalOut {
bogdanm 13:0645d8841f51 42
bogdanm 13:0645d8841f51 43 public:
bogdanm 13:0645d8841f51 44 /** Create a DigitalOut connected to the specified pin
bogdanm 13:0645d8841f51 45 *
bogdanm 13:0645d8841f51 46 * @param pin DigitalOut pin to connect to
bogdanm 13:0645d8841f51 47 */
bogdanm 13:0645d8841f51 48 DigitalOut(PinName pin) {
bogdanm 13:0645d8841f51 49 gpio_init(&gpio, pin, PIN_OUTPUT);
bogdanm 13:0645d8841f51 50 }
bogdanm 13:0645d8841f51 51
bogdanm 13:0645d8841f51 52 /** Set the output, specified as 0 or 1 (int)
bogdanm 13:0645d8841f51 53 *
bogdanm 13:0645d8841f51 54 * @param value An integer specifying the pin output value,
bogdanm 13:0645d8841f51 55 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
bogdanm 13:0645d8841f51 56 */
bogdanm 13:0645d8841f51 57 void write(int value) {
bogdanm 13:0645d8841f51 58 gpio_write(&gpio, value);
bogdanm 13:0645d8841f51 59 }
bogdanm 13:0645d8841f51 60
bogdanm 13:0645d8841f51 61 /** Return the output setting, represented as 0 or 1 (int)
bogdanm 13:0645d8841f51 62 *
bogdanm 13:0645d8841f51 63 * @returns
bogdanm 13:0645d8841f51 64 * an integer representing the output setting of the pin,
bogdanm 13:0645d8841f51 65 * 0 for logical 0, 1 for logical 1
bogdanm 13:0645d8841f51 66 */
bogdanm 13:0645d8841f51 67 int read() {
bogdanm 13:0645d8841f51 68 return gpio_read(&gpio);
bogdanm 13:0645d8841f51 69 }
bogdanm 13:0645d8841f51 70
bogdanm 13:0645d8841f51 71 #ifdef MBED_OPERATORS
bogdanm 13:0645d8841f51 72 /** A shorthand for write()
bogdanm 13:0645d8841f51 73 */
bogdanm 13:0645d8841f51 74 DigitalOut& operator= (int value) {
bogdanm 13:0645d8841f51 75 write(value);
bogdanm 13:0645d8841f51 76 return *this;
bogdanm 13:0645d8841f51 77 }
bogdanm 13:0645d8841f51 78
bogdanm 13:0645d8841f51 79 DigitalOut& operator= (DigitalOut& rhs) {
bogdanm 13:0645d8841f51 80 write(rhs.read());
bogdanm 13:0645d8841f51 81 return *this;
bogdanm 13:0645d8841f51 82 }
bogdanm 13:0645d8841f51 83
bogdanm 13:0645d8841f51 84 /** A 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