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

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/BusOut.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 *
ommpy 0:d383e2dee0f7 4 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 5 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 6 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 7 *
ommpy 0:d383e2dee0f7 8 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 9 *
ommpy 0:d383e2dee0f7 10 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 11 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 13 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 14 * limitations under the License.
ommpy 0:d383e2dee0f7 15 */
ommpy 0:d383e2dee0f7 16 #ifndef MBED_BUSOUT_H
ommpy 0:d383e2dee0f7 17 #define MBED_BUSOUT_H
ommpy 0:d383e2dee0f7 18
ommpy 0:d383e2dee0f7 19 #include "DigitalOut.h"
ommpy 0:d383e2dee0f7 20
ommpy 0:d383e2dee0f7 21 namespace mbed {
ommpy 0:d383e2dee0f7 22
ommpy 0:d383e2dee0f7 23 /** A digital output bus, used for setting the state of a collection of pins
ommpy 0:d383e2dee0f7 24 */
ommpy 0:d383e2dee0f7 25 class BusOut {
ommpy 0:d383e2dee0f7 26
ommpy 0:d383e2dee0f7 27 public:
ommpy 0:d383e2dee0f7 28
ommpy 0:d383e2dee0f7 29 /** Create an BusOut, connected to the specified pins
ommpy 0:d383e2dee0f7 30 *
ommpy 0:d383e2dee0f7 31 * @param p<n> DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
ommpy 0:d383e2dee0f7 32 *
ommpy 0:d383e2dee0f7 33 * @note
ommpy 0:d383e2dee0f7 34 * It is only required to specify as many pin variables as is required
ommpy 0:d383e2dee0f7 35 * for the bus; the rest will default to NC (not connected)
ommpy 0:d383e2dee0f7 36 */
ommpy 0:d383e2dee0f7 37 BusOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
ommpy 0:d383e2dee0f7 38 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
ommpy 0:d383e2dee0f7 39 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
ommpy 0:d383e2dee0f7 40 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
ommpy 0:d383e2dee0f7 41
ommpy 0:d383e2dee0f7 42 BusOut(PinName pins[16]);
ommpy 0:d383e2dee0f7 43
ommpy 0:d383e2dee0f7 44 virtual ~BusOut();
ommpy 0:d383e2dee0f7 45
ommpy 0:d383e2dee0f7 46 /** Write the value to the output bus
ommpy 0:d383e2dee0f7 47 *
ommpy 0:d383e2dee0f7 48 * @param value An integer specifying a bit to write for every corresponding DigitalOut pin
ommpy 0:d383e2dee0f7 49 */
ommpy 0:d383e2dee0f7 50 void write(int value);
ommpy 0:d383e2dee0f7 51
ommpy 0:d383e2dee0f7 52 /** Read the value currently output on the bus
ommpy 0:d383e2dee0f7 53 *
ommpy 0:d383e2dee0f7 54 * @returns
ommpy 0:d383e2dee0f7 55 * An integer with each bit corresponding to associated DigitalOut pin setting
ommpy 0:d383e2dee0f7 56 */
ommpy 0:d383e2dee0f7 57 int read();
ommpy 0:d383e2dee0f7 58
ommpy 0:d383e2dee0f7 59 /** Binary mask of bus pins connected to actual pins (not NC pins)
ommpy 0:d383e2dee0f7 60 * 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 61 *
ommpy 0:d383e2dee0f7 62 * @returns
ommpy 0:d383e2dee0f7 63 * Binary mask of connected pins
ommpy 0:d383e2dee0f7 64 */
ommpy 0:d383e2dee0f7 65 int mask() {
ommpy 0:d383e2dee0f7 66 return _nc_mask;
ommpy 0:d383e2dee0f7 67 }
ommpy 0:d383e2dee0f7 68
ommpy 0:d383e2dee0f7 69 #ifdef MBED_OPERATORS
ommpy 0:d383e2dee0f7 70 /** A shorthand for write()
ommpy 0:d383e2dee0f7 71 */
ommpy 0:d383e2dee0f7 72 BusOut& operator= (int v);
ommpy 0:d383e2dee0f7 73 BusOut& operator= (BusOut& rhs);
ommpy 0:d383e2dee0f7 74
ommpy 0:d383e2dee0f7 75 /** Access to particular bit in random-iterator fashion
ommpy 0:d383e2dee0f7 76 */
ommpy 0:d383e2dee0f7 77 DigitalOut& operator[] (int index);
ommpy 0:d383e2dee0f7 78
ommpy 0:d383e2dee0f7 79 /** A shorthand for read()
ommpy 0:d383e2dee0f7 80 */
ommpy 0:d383e2dee0f7 81 operator int();
ommpy 0:d383e2dee0f7 82 #endif
ommpy 0:d383e2dee0f7 83
ommpy 0:d383e2dee0f7 84 protected:
ommpy 0:d383e2dee0f7 85 DigitalOut* _pin[16];
ommpy 0:d383e2dee0f7 86
ommpy 0:d383e2dee0f7 87 /** Mask of bus's NC pins
ommpy 0:d383e2dee0f7 88 * If bit[n] is set to 1 - pin is connected
ommpy 0:d383e2dee0f7 89 * if bit[n] is cleared - pin is not connected (NC)
ommpy 0:d383e2dee0f7 90 */
ommpy 0:d383e2dee0f7 91 int _nc_mask;
ommpy 0:d383e2dee0f7 92
ommpy 0:d383e2dee0f7 93 /* disallow copy constructor and assignment operators */
ommpy 0:d383e2dee0f7 94 private:
ommpy 0:d383e2dee0f7 95 BusOut(const BusOut&);
ommpy 0:d383e2dee0f7 96 BusOut & operator = (const BusOut&);
ommpy 0:d383e2dee0f7 97 };
ommpy 0:d383e2dee0f7 98
ommpy 0:d383e2dee0f7 99 } // namespace mbed
ommpy 0:d383e2dee0f7 100
ommpy 0:d383e2dee0f7 101 #endif