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

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/BusIn.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_BUSIN_H
ommpy 0:d383e2dee0f7 17 #define MBED_BUSIN_H
ommpy 0:d383e2dee0f7 18
ommpy 0:d383e2dee0f7 19 #include "platform.h"
ommpy 0:d383e2dee0f7 20 #include "DigitalIn.h"
ommpy 0:d383e2dee0f7 21
ommpy 0:d383e2dee0f7 22 namespace mbed {
ommpy 0:d383e2dee0f7 23
ommpy 0:d383e2dee0f7 24 /** A digital input bus, used for reading the state of a collection of pins
ommpy 0:d383e2dee0f7 25 */
ommpy 0:d383e2dee0f7 26 class BusIn {
ommpy 0:d383e2dee0f7 27
ommpy 0:d383e2dee0f7 28 public:
ommpy 0:d383e2dee0f7 29 /* Group: Configuration Methods */
ommpy 0:d383e2dee0f7 30
ommpy 0:d383e2dee0f7 31 /** Create an BusIn, connected to the specified pins
ommpy 0:d383e2dee0f7 32 *
ommpy 0:d383e2dee0f7 33 * @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
ommpy 0:d383e2dee0f7 34 *
ommpy 0:d383e2dee0f7 35 * @note
ommpy 0:d383e2dee0f7 36 * It is only required to specify as many pin variables as is required
ommpy 0:d383e2dee0f7 37 * for the bus; the rest will default to NC (not connected)
ommpy 0:d383e2dee0f7 38 */
ommpy 0:d383e2dee0f7 39 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
ommpy 0:d383e2dee0f7 40 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
ommpy 0:d383e2dee0f7 41 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
ommpy 0:d383e2dee0f7 42 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
ommpy 0:d383e2dee0f7 43
ommpy 0:d383e2dee0f7 44 BusIn(PinName pins[16]);
ommpy 0:d383e2dee0f7 45
ommpy 0:d383e2dee0f7 46 virtual ~BusIn();
ommpy 0:d383e2dee0f7 47
ommpy 0:d383e2dee0f7 48 /** Read the value of the input bus
ommpy 0:d383e2dee0f7 49 *
ommpy 0:d383e2dee0f7 50 * @returns
ommpy 0:d383e2dee0f7 51 * An integer with each bit corresponding to the value read from the associated DigitalIn pin
ommpy 0:d383e2dee0f7 52 */
ommpy 0:d383e2dee0f7 53 int read();
ommpy 0:d383e2dee0f7 54
ommpy 0:d383e2dee0f7 55 /** Set the input pin mode
ommpy 0:d383e2dee0f7 56 *
ommpy 0:d383e2dee0f7 57 * @param mode PullUp, PullDown, PullNone
ommpy 0:d383e2dee0f7 58 */
ommpy 0:d383e2dee0f7 59 void mode(PinMode pull);
ommpy 0:d383e2dee0f7 60
ommpy 0:d383e2dee0f7 61 /** Binary mask of bus pins connected to actual pins (not NC pins)
ommpy 0:d383e2dee0f7 62 * 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 63 *
ommpy 0:d383e2dee0f7 64 * @returns
ommpy 0:d383e2dee0f7 65 * Binary mask of connected pins
ommpy 0:d383e2dee0f7 66 */
ommpy 0:d383e2dee0f7 67 int mask() {
ommpy 0:d383e2dee0f7 68 return _nc_mask;
ommpy 0:d383e2dee0f7 69 }
ommpy 0:d383e2dee0f7 70
ommpy 0:d383e2dee0f7 71 #ifdef MBED_OPERATORS
ommpy 0:d383e2dee0f7 72 /** A shorthand for read()
ommpy 0:d383e2dee0f7 73 */
ommpy 0:d383e2dee0f7 74 operator int();
ommpy 0:d383e2dee0f7 75
ommpy 0:d383e2dee0f7 76 /** Access to particular bit in random-iterator fashion
ommpy 0:d383e2dee0f7 77 */
ommpy 0:d383e2dee0f7 78 DigitalIn & operator[] (int index);
ommpy 0:d383e2dee0f7 79 #endif
ommpy 0:d383e2dee0f7 80
ommpy 0:d383e2dee0f7 81 protected:
ommpy 0:d383e2dee0f7 82 DigitalIn* _pin[16];
ommpy 0:d383e2dee0f7 83
ommpy 0:d383e2dee0f7 84 /** Mask of bus's NC pins
ommpy 0:d383e2dee0f7 85 * If bit[n] is set to 1 - pin is connected
ommpy 0:d383e2dee0f7 86 * if bit[n] is cleared - pin is not connected (NC)
ommpy 0:d383e2dee0f7 87 */
ommpy 0:d383e2dee0f7 88 int _nc_mask;
ommpy 0:d383e2dee0f7 89
ommpy 0:d383e2dee0f7 90 /* disallow copy constructor and assignment operators */
ommpy 0:d383e2dee0f7 91 private:
ommpy 0:d383e2dee0f7 92 BusIn(const BusIn&);
ommpy 0:d383e2dee0f7 93 BusIn & operator = (const BusIn&);
ommpy 0:d383e2dee0f7 94 };
ommpy 0:d383e2dee0f7 95
ommpy 0:d383e2dee0f7 96 } // namespace mbed
ommpy 0:d383e2dee0f7 97
ommpy 0:d383e2dee0f7 98 #endif