EL4121 Embedded System / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

drivers/BusOut.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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