Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/DigitalInOut.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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