118 lines
3.1 KiB
Raw Permalink Normal View History

/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include "DigitalInOut.h"
namespace mbed {
/** A digital input output bus, used for setting the state of a collection of pins
class BusInOut {
/** Create an BusInOut, connected to the specified pins
* @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
* @note
* It is only required to specify as many pin variables as is required
* for the bus; the rest will default to NC (not connected)
BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
BusInOut(PinName pins[16]);
virtual ~BusInOut();
/* Group: Access Methods */
/** Write the value to the output bus
* @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
void write(int value);
/** Read the value currently output on the bus
* @returns
* An integer with each bit corresponding to associated DigitalInOut pin setting
int read();
/** Set as an output
void output();
/** Set as an input
void input();
/** Set the input pin mode
* @param mode PullUp, PullDown, PullNone
void mode(PinMode pull);
/** Binary mask of bus pins connected to actual pins (not NC pins)
* If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1
* @returns
* Binary mask of connected pins
int mask() {
return _nc_mask;
/** A shorthand for write()
BusInOut& operator= (int v);
BusInOut& operator= (BusInOut& rhs);
/** Access to particular bit in random-iterator fashion
DigitalInOut& operator[] (int index);
/** A shorthand for read()
operator int();
DigitalInOut* _pin[16];
/** Mask of bus's NC pins
* If bit[n] is set to 1 - pin is connected
* if bit[n] is cleared - pin is not connected (NC)
int _nc_mask;
/* disallow copy constructor and assignment operators */
BusInOut(const BusInOut&);
BusInOut & operator = (const BusInOut&);
} // namespace mbed