Gan likun / mbed-dev

00

drivers/BusOut.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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