Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/BusOut.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_BUSOUT_H
mohamedmoawya 0:e4c5e6ec922e 17 #define MBED_BUSOUT_H
mohamedmoawya 0:e4c5e6ec922e 18
mohamedmoawya 0:e4c5e6ec922e 19 #include "drivers/DigitalOut.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 output bus, used for setting the state of a collection of pins
mohamedmoawya 0:e4c5e6ec922e 27 * @ingroup drivers
mohamedmoawya 0:e4c5e6ec922e 28 */
mohamedmoawya 0:e4c5e6ec922e 29 class BusOut : private NonCopyable<BusOut> {
mohamedmoawya 0:e4c5e6ec922e 30
mohamedmoawya 0:e4c5e6ec922e 31 public:
mohamedmoawya 0:e4c5e6ec922e 32
mohamedmoawya 0:e4c5e6ec922e 33 /** Create an BusOut, connected to the specified pins
mohamedmoawya 0:e4c5e6ec922e 34 *
mohamedmoawya 0:e4c5e6ec922e 35 * @param p0 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 36 * @param p1 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 37 * @param p2 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 38 * @param p3 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 39 * @param p4 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 40 * @param p5 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 41 * @param p6 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 42 * @param p7 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 43 * @param p8 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 44 * @param p9 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 45 * @param p10 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 46 * @param p11 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 47 * @param p12 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 48 * @param p13 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 49 * @param p14 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 50 * @param p15 DigitalOut pin to connect to bus bit
mohamedmoawya 0:e4c5e6ec922e 51 *
mohamedmoawya 0:e4c5e6ec922e 52 * @note Synchronization level: Thread safe
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 BusOut(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 BusOut, connected to the specified pins
mohamedmoawya 0:e4c5e6ec922e 64 *
mohamedmoawya 0:e4c5e6ec922e 65 * @param pins An array of pins to connect to bus the bit
mohamedmoawya 0:e4c5e6ec922e 66 */
mohamedmoawya 0:e4c5e6ec922e 67 BusOut(PinName pins[16]);
mohamedmoawya 0:e4c5e6ec922e 68
mohamedmoawya 0:e4c5e6ec922e 69 virtual ~BusOut();
mohamedmoawya 0:e4c5e6ec922e 70
mohamedmoawya 0:e4c5e6ec922e 71 /** Write the value to the output bus
mohamedmoawya 0:e4c5e6ec922e 72 *
mohamedmoawya 0:e4c5e6ec922e 73 * @param value An integer specifying a bit to write for every corresponding DigitalOut pin
mohamedmoawya 0:e4c5e6ec922e 74 */
mohamedmoawya 0:e4c5e6ec922e 75 void write(int value);
mohamedmoawya 0:e4c5e6ec922e 76
mohamedmoawya 0:e4c5e6ec922e 77 /** Read the value currently output on the bus
mohamedmoawya 0:e4c5e6ec922e 78 *
mohamedmoawya 0:e4c5e6ec922e 79 * @returns
mohamedmoawya 0:e4c5e6ec922e 80 * An integer with each bit corresponding to associated DigitalOut pin setting
mohamedmoawya 0:e4c5e6ec922e 81 */
mohamedmoawya 0:e4c5e6ec922e 82 int read();
mohamedmoawya 0:e4c5e6ec922e 83
mohamedmoawya 0:e4c5e6ec922e 84 /** Binary mask of bus pins connected to actual pins (not NC pins)
mohamedmoawya 0:e4c5e6ec922e 85 * 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 86 *
mohamedmoawya 0:e4c5e6ec922e 87 * @returns
mohamedmoawya 0:e4c5e6ec922e 88 * Binary mask of connected pins
mohamedmoawya 0:e4c5e6ec922e 89 */
mohamedmoawya 0:e4c5e6ec922e 90 int mask()
mohamedmoawya 0:e4c5e6ec922e 91 {
mohamedmoawya 0:e4c5e6ec922e 92 // No lock needed since _nc_mask is not modified outside the constructor
mohamedmoawya 0:e4c5e6ec922e 93 return _nc_mask;
mohamedmoawya 0:e4c5e6ec922e 94 }
mohamedmoawya 0:e4c5e6ec922e 95
mohamedmoawya 0:e4c5e6ec922e 96 /** A shorthand for write()
mohamedmoawya 0:e4c5e6ec922e 97 * \sa BusOut::write()
mohamedmoawya 0:e4c5e6ec922e 98 */
mohamedmoawya 0:e4c5e6ec922e 99 BusOut &operator= (int v);
mohamedmoawya 0:e4c5e6ec922e 100 BusOut &operator= (BusOut &rhs);
mohamedmoawya 0:e4c5e6ec922e 101
mohamedmoawya 0:e4c5e6ec922e 102 /** Access to particular bit in random-iterator fashion
mohamedmoawya 0:e4c5e6ec922e 103 * @param index Bit Position
mohamedmoawya 0:e4c5e6ec922e 104 */
mohamedmoawya 0:e4c5e6ec922e 105 DigitalOut &operator[](int index);
mohamedmoawya 0:e4c5e6ec922e 106
mohamedmoawya 0:e4c5e6ec922e 107 /** A shorthand for read()
mohamedmoawya 0:e4c5e6ec922e 108 * \sa BusOut::read()
mohamedmoawya 0:e4c5e6ec922e 109 */
mohamedmoawya 0:e4c5e6ec922e 110 operator int();
mohamedmoawya 0:e4c5e6ec922e 111
mohamedmoawya 0:e4c5e6ec922e 112 protected:
mohamedmoawya 0:e4c5e6ec922e 113 virtual void lock();
mohamedmoawya 0:e4c5e6ec922e 114 virtual void unlock();
mohamedmoawya 0:e4c5e6ec922e 115 DigitalOut *_pin[16];
mohamedmoawya 0:e4c5e6ec922e 116
mohamedmoawya 0:e4c5e6ec922e 117 /* Mask of bus's NC pins
mohamedmoawya 0:e4c5e6ec922e 118 * If bit[n] is set to 1 - pin is connected
mohamedmoawya 0:e4c5e6ec922e 119 * if bit[n] is cleared - pin is not connected (NC)
mohamedmoawya 0:e4c5e6ec922e 120 */
mohamedmoawya 0:e4c5e6ec922e 121 int _nc_mask;
mohamedmoawya 0:e4c5e6ec922e 122
mohamedmoawya 0:e4c5e6ec922e 123 PlatformMutex _mutex;
mohamedmoawya 0:e4c5e6ec922e 124 };
mohamedmoawya 0:e4c5e6ec922e 125
mohamedmoawya 0:e4c5e6ec922e 126 } // namespace mbed
mohamedmoawya 0:e4c5e6ec922e 127
mohamedmoawya 0:e4c5e6ec922e 128 #endif