Iftikhar Aziz / mbed-dev

4545

Dependents:   LSS_Rev_1

Fork of mbed-dev by Umar Naeem

drivers/BusOut.h@166:33361e55dd8c, 2017-08-23 (annotated)

Committer:
iftaziz
Date:
Wed Aug 23 10:32:38 2017 +0000
Revision:
166:33361e55dd8c
Parent:
149:156823d33999 
r1

Who changed what in which revision?

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