Kenji Arai / mbed-os_TYBLE16

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:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/BusInOut.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

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