Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/DigitalInOut.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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