Sukkin Pang / mbed-dev-bin

Initial release

Fork of mbed-dev-bin by Lancaster University

BusOut.h@4:85cbef757caa, 2016-09-29 (annotated)

Committer:
pangsk
Date:
Thu Sep 29 15:33:10 2016 +0000
Revision:
4:85cbef757caa
Parent:
0:e1a608bb55e8 
Initial release

Who changed what in which revision?

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