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