Bei Chen Liu / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/BusInOut.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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