BusInOut.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_BUSINOUT_H
00023 #define MBED_BUSINOUT_H
00024 
00025 #include "DigitalInOut.h"
00026 
00027 namespace mbed {
00028 
00029 /** A digital input output bus, used for setting the state of a collection of pins
00030  */
00031 class BusInOut {
00032 
00033 public:
00034 
00035     /** Create an BusInOut, connected to the specified pins
00036      *
00037      *  @param p<n> DigitalInOut pin to connect to bus bit p<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     BusInOut(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     BusInOut(PinName pins[16]);
00049 
00050     virtual ~BusInOut();
00051 
00052     /* Group: Access Methods */
00053 
00054     /** Write the value to the output bus
00055      *
00056      *  @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
00057      */
00058     void write(int value);
00059 
00060 
00061     /** Read the value currently output on the bus
00062      *
00063      *  @returns
00064      *    An integer with each bit corresponding to associated DigitalInOut pin setting
00065      */
00066     int read();
00067 
00068     /** Set as an output
00069      */
00070     void output();
00071 
00072     /** Set as an input
00073      */
00074     void input();
00075 
00076     /** Set the input pin mode
00077      *
00078      *  @param mode PullUp, PullDown, PullNone
00079      */
00080     void mode(PinMode pull);
00081 
00082 #ifdef MBED_OPERATORS
00083      /** A shorthand for write()
00084      */
00085     BusInOut& operator= (int v);
00086     BusInOut& operator= (BusInOut& rhs);
00087 
00088     /** A shorthand for read()
00089      */
00090     operator int();
00091 #endif
00092 
00093 protected:
00094     DigitalInOut* _pin[16];
00095 };
00096 
00097 } // namespace mbed
00098 
00099 #endif
00100