Vladimir Vana / mbed

pro vyuku PSS v Jecne

BusIn.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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