spinal cord / PokittoLib

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

Dependents:   Sensitive

Fork of PokittoLib by Jonne Valola

mbed-pokitto/api/BusIn.h@15:0bbe8f6fae32, 2017-10-18 (annotated)

Committer:
spinal
Date:
Wed Oct 18 14:47:54 2017 +0000
Revision:
15:0bbe8f6fae32
Parent:
6:ea7377f3d1af 
direct lcd stuff used by sensitive

Who changed what in which revision?

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