Pokitto Community Team / Pokitto_

PokittoLib with changes to lcd refresh etc.

Dependents:   Pokittris

Fork of Pokitto by Pokitto Community Team

This is a fork by user @Spinal, and is used in Pokittris for testing. Do not import this to your own program.

mbed-pokitto/api/BusInOut.h@5:7e5c566b1760, 2017-10-07 (annotated)

Committer:
Pokitto
Date:
Sat Oct 07 21:31:12 2017 +0000
Revision:
5:7e5c566b1760
mbed-pokitto integrated

Who changed what in which revision?

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