Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

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.

Dependencies:   mbed

mbed-os/drivers/BusInOut.h@9:d58e77ebd769, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:12:37 2018 -0700
Revision:
9:d58e77ebd769
add mbed-os library

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_BUSINOUT_H
Nathan Yonkee 9:d58e77ebd769 17 #define MBED_BUSINOUT_H
Nathan Yonkee 9:d58e77ebd769 18
Nathan Yonkee 9:d58e77ebd769 19 #include "drivers/DigitalInOut.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 input output bus, used for setting the state of a collection of pins
Nathan Yonkee 9:d58e77ebd769 27 *
Nathan Yonkee 9:d58e77ebd769 28 * @note Synchronization level: Thread safe
Nathan Yonkee 9:d58e77ebd769 29 * @ingroup drivers
Nathan Yonkee 9:d58e77ebd769 30 */
Nathan Yonkee 9:d58e77ebd769 31 class BusInOut : private NonCopyable<BusInOut> {
Nathan Yonkee 9:d58e77ebd769 32
Nathan Yonkee 9:d58e77ebd769 33 public:
Nathan Yonkee 9:d58e77ebd769 34
Nathan Yonkee 9:d58e77ebd769 35 /** Create an BusInOut, connected to the specified pins
Nathan Yonkee 9:d58e77ebd769 36 *
Nathan Yonkee 9:d58e77ebd769 37 * @param p0 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 38 * @param p1 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 39 * @param p2 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 40 * @param p3 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 41 * @param p4 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 42 * @param p5 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 43 * @param p6 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 44 * @param p7 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 45 * @param p8 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 46 * @param p9 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 47 * @param p10 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 48 * @param p11 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 49 * @param p12 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 50 * @param p13 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 51 * @param p14 DigitalInOut pin to connect to bus bit
Nathan Yonkee 9:d58e77ebd769 52 * @param p15 DigitalInOut pin to connect to bus bit
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 BusInOut(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 BusInOut, connected to the specified pins
Nathan Yonkee 9:d58e77ebd769 64 *
Nathan Yonkee 9:d58e77ebd769 65 * @param pins An array of pins to construct a BusInOut from
Nathan Yonkee 9:d58e77ebd769 66 */
Nathan Yonkee 9:d58e77ebd769 67 BusInOut(PinName pins[16]);
Nathan Yonkee 9:d58e77ebd769 68
Nathan Yonkee 9:d58e77ebd769 69 virtual ~BusInOut();
Nathan Yonkee 9:d58e77ebd769 70
Nathan Yonkee 9:d58e77ebd769 71 /* Group: Access Methods */
Nathan Yonkee 9:d58e77ebd769 72
Nathan Yonkee 9:d58e77ebd769 73 /** Write the value to the output bus
Nathan Yonkee 9:d58e77ebd769 74 *
Nathan Yonkee 9:d58e77ebd769 75 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
Nathan Yonkee 9:d58e77ebd769 76 */
Nathan Yonkee 9:d58e77ebd769 77 void write(int value);
Nathan Yonkee 9:d58e77ebd769 78
Nathan Yonkee 9:d58e77ebd769 79 /** Read the value currently output on the bus
Nathan Yonkee 9:d58e77ebd769 80 *
Nathan Yonkee 9:d58e77ebd769 81 * @returns
Nathan Yonkee 9:d58e77ebd769 82 * An integer with each bit corresponding to associated DigitalInOut pin setting
Nathan Yonkee 9:d58e77ebd769 83 */
Nathan Yonkee 9:d58e77ebd769 84 int read();
Nathan Yonkee 9:d58e77ebd769 85
Nathan Yonkee 9:d58e77ebd769 86 /** Set as an output
Nathan Yonkee 9:d58e77ebd769 87 */
Nathan Yonkee 9:d58e77ebd769 88 void output();
Nathan Yonkee 9:d58e77ebd769 89
Nathan Yonkee 9:d58e77ebd769 90 /** Set as an input
Nathan Yonkee 9:d58e77ebd769 91 */
Nathan Yonkee 9:d58e77ebd769 92 void input();
Nathan Yonkee 9:d58e77ebd769 93
Nathan Yonkee 9:d58e77ebd769 94 /** Set the input pin mode
Nathan Yonkee 9:d58e77ebd769 95 *
Nathan Yonkee 9:d58e77ebd769 96 * @param pull PullUp, PullDown, PullNone
Nathan Yonkee 9:d58e77ebd769 97 */
Nathan Yonkee 9:d58e77ebd769 98 void mode(PinMode pull);
Nathan Yonkee 9:d58e77ebd769 99
Nathan Yonkee 9:d58e77ebd769 100 /** Binary mask of bus pins connected to actual pins (not NC pins)
Nathan Yonkee 9:d58e77ebd769 101 * 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 102 *
Nathan Yonkee 9:d58e77ebd769 103 * @returns
Nathan Yonkee 9:d58e77ebd769 104 * Binary mask of connected pins
Nathan Yonkee 9:d58e77ebd769 105 */
Nathan Yonkee 9:d58e77ebd769 106 int mask() {
Nathan Yonkee 9:d58e77ebd769 107 // No lock needed since _nc_mask is not modified outside the constructor
Nathan Yonkee 9:d58e77ebd769 108 return _nc_mask;
Nathan Yonkee 9:d58e77ebd769 109 }
Nathan Yonkee 9:d58e77ebd769 110
Nathan Yonkee 9:d58e77ebd769 111 /** A shorthand for write()
Nathan Yonkee 9:d58e77ebd769 112 * \sa BusInOut::write()
Nathan Yonkee 9:d58e77ebd769 113 */
Nathan Yonkee 9:d58e77ebd769 114 BusInOut& operator= (int v);
Nathan Yonkee 9:d58e77ebd769 115 BusInOut& operator= (BusInOut& rhs);
Nathan Yonkee 9:d58e77ebd769 116
Nathan Yonkee 9:d58e77ebd769 117 /** Access to particular bit in random-iterator fashion
Nathan Yonkee 9:d58e77ebd769 118 * @param index Bit Position
Nathan Yonkee 9:d58e77ebd769 119 */
Nathan Yonkee 9:d58e77ebd769 120 DigitalInOut& operator[] (int index);
Nathan Yonkee 9:d58e77ebd769 121
Nathan Yonkee 9:d58e77ebd769 122 /** A shorthand for read()
Nathan Yonkee 9:d58e77ebd769 123 * \sa BusInOut::read()
Nathan Yonkee 9:d58e77ebd769 124 */
Nathan Yonkee 9:d58e77ebd769 125 operator int();
Nathan Yonkee 9:d58e77ebd769 126
Nathan Yonkee 9:d58e77ebd769 127 protected:
Nathan Yonkee 9:d58e77ebd769 128 virtual void lock();
Nathan Yonkee 9:d58e77ebd769 129 virtual void unlock();
Nathan Yonkee 9:d58e77ebd769 130 DigitalInOut* _pin[16];
Nathan Yonkee 9:d58e77ebd769 131
Nathan Yonkee 9:d58e77ebd769 132 /* Mask of bus's NC pins
Nathan Yonkee 9:d58e77ebd769 133 * If bit[n] is set to 1 - pin is connected
Nathan Yonkee 9:d58e77ebd769 134 * if bit[n] is cleared - pin is not connected (NC)
Nathan Yonkee 9:d58e77ebd769 135 */
Nathan Yonkee 9:d58e77ebd769 136 int _nc_mask;
Nathan Yonkee 9:d58e77ebd769 137
Nathan Yonkee 9:d58e77ebd769 138 PlatformMutex _mutex;
Nathan Yonkee 9:d58e77ebd769 139 };
Nathan Yonkee 9:d58e77ebd769 140
Nathan Yonkee 9:d58e77ebd769 141 } // namespace mbed
Nathan Yonkee 9:d58e77ebd769 142
Nathan Yonkee 9:d58e77ebd769 143 #endif