modtronix H / mbed_nz32sc151

mbed library for NZ32-SC151

api/BusOut.h@17:639ed60ce759, 2016-08-19 (annotated)

Committer:
modtronix-com
Date:
Fri Aug 19 15:46:42 2016 +1000
Revision:
17:639ed60ce759
Parent:
1:71204b8406f2 
Added tag v1.1 for changeset 076cbe3e55be

Who changed what in which revision?

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