MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

mbed-dev/drivers/BusIn.h@46:b156ef445742, 2017-06-03 (annotated)

Committer:
sahilmgandhi
Date:
Sat Jun 03 00:22:44 2017 +0000
Revision:
46:b156ef445742
Parent:
18:6a4db94011d3 
Final code for internal battlebot competition.

Who changed what in which revision?

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