Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

BusInOut.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_BUSINOUT_H
jhon309 0:ac8863619623 17 #define MBED_BUSINOUT_H
jhon309 0:ac8863619623 18
jhon309 0:ac8863619623 19 #include "DigitalInOut.h"
jhon309 0:ac8863619623 20
jhon309 0:ac8863619623 21 namespace mbed {
jhon309 0:ac8863619623 22
jhon309 0:ac8863619623 23 /** A digital input output bus, used for setting the state of a collection of pins
jhon309 0:ac8863619623 24 */
jhon309 0:ac8863619623 25 class BusInOut {
jhon309 0:ac8863619623 26
jhon309 0:ac8863619623 27 public:
jhon309 0:ac8863619623 28
jhon309 0:ac8863619623 29 /** Create an BusInOut, connected to the specified pins
jhon309 0:ac8863619623 30 *
jhon309 0:ac8863619623 31 * @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
jhon309 0:ac8863619623 32 *
jhon309 0:ac8863619623 33 * @note
jhon309 0:ac8863619623 34 * It is only required to specify as many pin variables as is required
jhon309 0:ac8863619623 35 * for the bus; the rest will default to NC (not connected)
jhon309 0:ac8863619623 36 */
jhon309 0:ac8863619623 37 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
jhon309 0:ac8863619623 38 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
jhon309 0:ac8863619623 39 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
jhon309 0:ac8863619623 40 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
jhon309 0:ac8863619623 41
jhon309 0:ac8863619623 42 BusInOut(PinName pins[16]);
jhon309 0:ac8863619623 43
jhon309 0:ac8863619623 44 virtual ~BusInOut();
jhon309 0:ac8863619623 45
jhon309 0:ac8863619623 46 /* Group: Access Methods */
jhon309 0:ac8863619623 47
jhon309 0:ac8863619623 48 /** Write the value to the output bus
jhon309 0:ac8863619623 49 *
jhon309 0:ac8863619623 50 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
jhon309 0:ac8863619623 51 */
jhon309 0:ac8863619623 52 void write(int value);
jhon309 0:ac8863619623 53
jhon309 0:ac8863619623 54 /** Read the value currently output on the bus
jhon309 0:ac8863619623 55 *
jhon309 0:ac8863619623 56 * @returns
jhon309 0:ac8863619623 57 * An integer with each bit corresponding to associated DigitalInOut pin setting
jhon309 0:ac8863619623 58 */
jhon309 0:ac8863619623 59 int read();
jhon309 0:ac8863619623 60
jhon309 0:ac8863619623 61 /** Set as an output
jhon309 0:ac8863619623 62 */
jhon309 0:ac8863619623 63 void output();
jhon309 0:ac8863619623 64
jhon309 0:ac8863619623 65 /** Set as an input
jhon309 0:ac8863619623 66 */
jhon309 0:ac8863619623 67 void input();
jhon309 0:ac8863619623 68
jhon309 0:ac8863619623 69 /** Set the input pin mode
jhon309 0:ac8863619623 70 *
jhon309 0:ac8863619623 71 * @param mode PullUp, PullDown, PullNone
jhon309 0:ac8863619623 72 */
jhon309 0:ac8863619623 73 void mode(PinMode pull);
jhon309 0:ac8863619623 74
jhon309 0:ac8863619623 75 /** Binary mask of bus pins connected to actual pins (not NC pins)
jhon309 0:ac8863619623 76 * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1
jhon309 0:ac8863619623 77 *
jhon309 0:ac8863619623 78 * @returns
jhon309 0:ac8863619623 79 * Binary mask of connected pins
jhon309 0:ac8863619623 80 */
jhon309 0:ac8863619623 81 int mask() {
jhon309 0:ac8863619623 82 return _nc_mask;
jhon309 0:ac8863619623 83 }
jhon309 0:ac8863619623 84
jhon309 0:ac8863619623 85 #ifdef MBED_OPERATORS
jhon309 0:ac8863619623 86 /** A shorthand for write()
jhon309 0:ac8863619623 87 */
jhon309 0:ac8863619623 88 BusInOut& operator= (int v);
jhon309 0:ac8863619623 89 BusInOut& operator= (BusInOut& rhs);
jhon309 0:ac8863619623 90
jhon309 0:ac8863619623 91 /** Access to particular bit in random-iterator fashion
jhon309 0:ac8863619623 92 */
jhon309 0:ac8863619623 93 DigitalInOut& operator[] (int index);
jhon309 0:ac8863619623 94
jhon309 0:ac8863619623 95 /** A shorthand for read()
jhon309 0:ac8863619623 96 */
jhon309 0:ac8863619623 97 operator int();
jhon309 0:ac8863619623 98 #endif
jhon309 0:ac8863619623 99
jhon309 0:ac8863619623 100 protected:
jhon309 0:ac8863619623 101 DigitalInOut* _pin[16];
jhon309 0:ac8863619623 102
jhon309 0:ac8863619623 103 /** Mask of bus's NC pins
jhon309 0:ac8863619623 104 * If bit[n] is set to 1 - pin is connected
jhon309 0:ac8863619623 105 * if bit[n] is cleared - pin is not connected (NC)
jhon309 0:ac8863619623 106 */
jhon309 0:ac8863619623 107 int _nc_mask;
jhon309 0:ac8863619623 108
jhon309 0:ac8863619623 109 /* disallow copy constructor and assignment operators */
jhon309 0:ac8863619623 110 private:
jhon309 0:ac8863619623 111 BusInOut(const BusInOut&);
jhon309 0:ac8863619623 112 BusInOut & operator = (const BusInOut&);
jhon309 0:ac8863619623 113 };
jhon309 0:ac8863619623 114
jhon309 0:ac8863619623 115 } // namespace mbed
jhon309 0:ac8863619623 116
jhon309 0:ac8863619623 117 #endif