BusOut.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_BUSOUT_H
00023 #define MBED_BUSOUT_H
00024 
00025 #include "DigitalOut.h"
00026 
00027 namespace mbed {
00028 
00029 /** A digital output bus, used for setting the state of a collection of pins
00030  */
00031 class BusOut {
00032 
00033 public:
00034 
00035     /** Create an BusOut, connected to the specified pins
00036      *
00037      *  @param p<n> DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
00038      *
00039      *  @note
00040      *  It is only required to specify as many pin variables as is required
00041      *  for the bus; the rest will default to NC (not connected)
00042      */
00043     BusOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
00044            PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
00045            PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
00046            PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
00047 
00048     BusOut(PinName pins[16]);
00049 
00050     virtual ~BusOut();
00051 
00052     /** Write the value to the output bus
00053      *
00054      *  @param value An integer specifying a bit to write for every corresponding DigitalOut pin
00055      */
00056     void write(int value);
00057 
00058     /** Read the value currently output on the bus
00059      *
00060      *  @returns
00061      *    An integer with each bit corresponding to associated DigitalOut pin setting
00062      */
00063     int read();
00064 
00065 #ifdef MBED_OPERATORS
00066     /** A shorthand for write()
00067      */
00068     BusOut& operator= (int v);
00069     BusOut& operator= (BusOut& rhs);
00070 
00071     /** A shorthand for read()
00072      */
00073     operator int();
00074 #endif
00075 
00076 protected:
00077     DigitalOut* _pin[16];
00078 };
00079 
00080 } // namespace mbed
00081 
00082 #endif
00083