spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/api/DigitalInOut.h@5:ea7377f3d1af, 2017-10-11 (annotated)

Committer:
Pokitto
Date:
Wed Oct 11 20:35:27 2017 +0000
Revision:
5:ea7377f3d1af
Fixed PokittoLib. Includes a working custom mbed-src

Who changed what in which revision?

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