Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

DigitalInOut.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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