Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/BusInOut.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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