Jasper Lee / mbed_helloworld

change some io settings for TWR-K22F-120M

Dependents:   twr_helloworld

DigitalOut.h@0:b16d94660a33, 2014-12-23 (annotated)

Committer:
Jasper_lee
Date:
Tue Dec 23 03:35:08 2014 +0000
Revision:
0:b16d94660a33
change some io setting used in TWR-K22F120M

Who changed what in which revision?

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