Vladimir Vana / mbed

pro vyuku PSS v Jecne

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