1 /* mbed Microcontroller Library
2 * Copyright (c) 2006-2013 ARM Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "DigitalOut.h"
23 /** A digital output bus, used for setting the state of a collection of pins
29 /** Create an BusOut, connected to the specified pins
31 * @param p<n> DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
34 * It is only required to specify as many pin variables as is required
35 * for the bus; the rest will default to NC (not connected)
37 BusOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
38 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
39 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
40 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
42 BusOut(PinName pins[16]);
46 /** Write the value to the output bus
48 * @param value An integer specifying a bit to write for every corresponding DigitalOut pin
50 void write(int value);
52 /** Read the value currently output on the bus
55 * An integer with each bit corresponding to associated DigitalOut pin setting
59 /** Binary mask of bus pins connected to actual pins (not NC pins)
60 * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1
63 * Binary mask of connected pins
70 /** A shorthand for write()
72 BusOut& operator= (int v);
73 BusOut& operator= (BusOut& rhs);
75 /** Access to particular bit in random-iterator fashion
77 DigitalOut& operator[] (int index);
79 /** A shorthand for read()
87 /** Mask of bus's NC pins
88 * If bit[n] is set to 1 - pin is connected
89 * if bit[n] is cleared - pin is not connected (NC)
93 /* disallow copy constructor and assignment operators */
95 BusOut(const BusOut&);
96 BusOut & operator = (const BusOut&);