spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/api/BusInOut.h@64:6e6c6c2b664e, 2018-11-18 (annotated)

Committer:
spinal
Date:
Sun Nov 18 15:47:54 2018 +0000
Revision:
64:6e6c6c2b664e
Parent:
5:ea7377f3d1af 
added fix for directrectangle()

Who changed what in which revision?

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