Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/BusOut.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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