Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/BusInOut.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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