MacroRat / MouseCode

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ITG3200 QEI

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