Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

init

Dependencies:   mbed

mbed-os/drivers/BusOut.h@10:46a4cf51ee38, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769 
remove mbed-os

Who changed what in which revision?

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