Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

DigitalInOut.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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