Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

BusInOut.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
85:024bf7f99721
Child:
93:e188a91d3eaa
dgdgr

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 65:5798e58a58b1 1 /* mbed Microcontroller Library
bogdanm 65:5798e58a58b1 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 65:5798e58a58b1 3 *
bogdanm 65:5798e58a58b1 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 65:5798e58a58b1 5 * you may not use this file except in compliance with the License.
bogdanm 65:5798e58a58b1 6 * You may obtain a copy of the License at
bogdanm 65:5798e58a58b1 7 *
bogdanm 65:5798e58a58b1 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 65:5798e58a58b1 9 *
bogdanm 65:5798e58a58b1 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 65:5798e58a58b1 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 65:5798e58a58b1 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 65:5798e58a58b1 13 * See the License for the specific language governing permissions and
bogdanm 65:5798e58a58b1 14 * limitations under the License.
bogdanm 65:5798e58a58b1 15 */
bogdanm 65:5798e58a58b1 16 #ifndef MBED_BUSINOUT_H
bogdanm 65:5798e58a58b1 17 #define MBED_BUSINOUT_H
bogdanm 65:5798e58a58b1 18
bogdanm 65:5798e58a58b1 19 #include "DigitalInOut.h"
bogdanm 65:5798e58a58b1 20
bogdanm 65:5798e58a58b1 21 namespace mbed {
bogdanm 65:5798e58a58b1 22
bogdanm 65:5798e58a58b1 23 /** A digital input output bus, used for setting the state of a collection of pins
bogdanm 65:5798e58a58b1 24 */
bogdanm 65:5798e58a58b1 25 class BusInOut {
bogdanm 65:5798e58a58b1 26
bogdanm 65:5798e58a58b1 27 public:
bogdanm 65:5798e58a58b1 28
bogdanm 65:5798e58a58b1 29 /** Create an BusInOut, connected to the specified pins
bogdanm 65:5798e58a58b1 30 *
bogdanm 65:5798e58a58b1 31 * @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
bogdanm 65:5798e58a58b1 32 *
bogdanm 65:5798e58a58b1 33 * @note
bogdanm 65:5798e58a58b1 34 * It is only required to specify as many pin variables as is required
bogdanm 65:5798e58a58b1 35 * for the bus; the rest will default to NC (not connected)
bogdanm 65:5798e58a58b1 36 */
bogdanm 65:5798e58a58b1 37 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
bogdanm 65:5798e58a58b1 38 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
bogdanm 65:5798e58a58b1 39 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
bogdanm 65:5798e58a58b1 40 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
bogdanm 65:5798e58a58b1 41
bogdanm 65:5798e58a58b1 42 BusInOut(PinName pins[16]);
bogdanm 65:5798e58a58b1 43
bogdanm 65:5798e58a58b1 44 virtual ~BusInOut();
bogdanm 65:5798e58a58b1 45
bogdanm 65:5798e58a58b1 46 /* Group: Access Methods */
bogdanm 65:5798e58a58b1 47
bogdanm 65:5798e58a58b1 48 /** Write the value to the output bus
bogdanm 65:5798e58a58b1 49 *
bogdanm 65:5798e58a58b1 50 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
bogdanm 65:5798e58a58b1 51 */
bogdanm 65:5798e58a58b1 52 void write(int value);
bogdanm 65:5798e58a58b1 53
bogdanm 65:5798e58a58b1 54
bogdanm 65:5798e58a58b1 55 /** Read the value currently output on the bus
bogdanm 65:5798e58a58b1 56 *
bogdanm 65:5798e58a58b1 57 * @returns
bogdanm 65:5798e58a58b1 58 * An integer with each bit corresponding to associated DigitalInOut pin setting
bogdanm 65:5798e58a58b1 59 */
bogdanm 65:5798e58a58b1 60 int read();
bogdanm 65:5798e58a58b1 61
bogdanm 65:5798e58a58b1 62 /** Set as an output
bogdanm 65:5798e58a58b1 63 */
bogdanm 65:5798e58a58b1 64 void output();
bogdanm 65:5798e58a58b1 65
bogdanm 65:5798e58a58b1 66 /** Set as an input
bogdanm 65:5798e58a58b1 67 */
bogdanm 65:5798e58a58b1 68 void input();
bogdanm 65:5798e58a58b1 69
bogdanm 65:5798e58a58b1 70 /** Set the input pin mode
bogdanm 65:5798e58a58b1 71 *
bogdanm 65:5798e58a58b1 72 * @param mode PullUp, PullDown, PullNone
bogdanm 65:5798e58a58b1 73 */
bogdanm 65:5798e58a58b1 74 void mode(PinMode pull);
bogdanm 65:5798e58a58b1 75
bogdanm 65:5798e58a58b1 76 #ifdef MBED_OPERATORS
bogdanm 65:5798e58a58b1 77 /** A shorthand for write()
bogdanm 65:5798e58a58b1 78 */
bogdanm 65:5798e58a58b1 79 BusInOut& operator= (int v);
bogdanm 65:5798e58a58b1 80 BusInOut& operator= (BusInOut& rhs);
bogdanm 65:5798e58a58b1 81
bogdanm 65:5798e58a58b1 82 /** A shorthand for read()
bogdanm 65:5798e58a58b1 83 */
bogdanm 65:5798e58a58b1 84 operator int();
bogdanm 65:5798e58a58b1 85 #endif
bogdanm 65:5798e58a58b1 86
bogdanm 65:5798e58a58b1 87 protected:
bogdanm 65:5798e58a58b1 88 DigitalInOut* _pin[16];
bogdanm 85:024bf7f99721 89
bogdanm 85:024bf7f99721 90 /* disallow copy constructor and assignment operators */
bogdanm 85:024bf7f99721 91 private:
bogdanm 85:024bf7f99721 92 BusInOut(const BusInOut&);
bogdanm 85:024bf7f99721 93 BusInOut & operator = (const BusInOut&);
bogdanm 65:5798e58a58b1 94 };
bogdanm 65:5798e58a58b1 95
bogdanm 65:5798e58a58b1 96 } // namespace mbed
bogdanm 65:5798e58a58b1 97
bogdanm 65:5798e58a58b1 98 #endif