Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/PortOut.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_PORTOUT_H
mohamedmoawya 0:e4c5e6ec922e 17 #define MBED_PORTOUT_H
mohamedmoawya 0:e4c5e6ec922e 18
mohamedmoawya 0:e4c5e6ec922e 19 #include "platform/platform.h"
mohamedmoawya 0:e4c5e6ec922e 20
mohamedmoawya 0:e4c5e6ec922e 21 #if defined (DEVICE_PORTOUT) || defined(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 22
mohamedmoawya 0:e4c5e6ec922e 23 #include "hal/port_api.h"
mohamedmoawya 0:e4c5e6ec922e 24 #include "platform/mbed_critical.h"
mohamedmoawya 0:e4c5e6ec922e 25
mohamedmoawya 0:e4c5e6ec922e 26 namespace mbed {
mohamedmoawya 0:e4c5e6ec922e 27 /** \addtogroup drivers */
mohamedmoawya 0:e4c5e6ec922e 28 /** A multiple pin digital output
mohamedmoawya 0:e4c5e6ec922e 29 *
mohamedmoawya 0:e4c5e6ec922e 30 * @note Synchronization level: Interrupt safe
mohamedmoawya 0:e4c5e6ec922e 31 *
mohamedmoawya 0:e4c5e6ec922e 32 * Example:
mohamedmoawya 0:e4c5e6ec922e 33 * @code
mohamedmoawya 0:e4c5e6ec922e 34 * // Toggle all four LEDs
mohamedmoawya 0:e4c5e6ec922e 35 *
mohamedmoawya 0:e4c5e6ec922e 36 * #include "mbed.h"
mohamedmoawya 0:e4c5e6ec922e 37 *
mohamedmoawya 0:e4c5e6ec922e 38 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
mohamedmoawya 0:e4c5e6ec922e 39 * #define LED_MASK 0x00B40000
mohamedmoawya 0:e4c5e6ec922e 40 *
mohamedmoawya 0:e4c5e6ec922e 41 * PortOut ledport(Port1, LED_MASK);
mohamedmoawya 0:e4c5e6ec922e 42 *
mohamedmoawya 0:e4c5e6ec922e 43 * int main() {
mohamedmoawya 0:e4c5e6ec922e 44 * while(1) {
mohamedmoawya 0:e4c5e6ec922e 45 * ledport = LED_MASK;
mohamedmoawya 0:e4c5e6ec922e 46 * wait(1);
mohamedmoawya 0:e4c5e6ec922e 47 * ledport = 0;
mohamedmoawya 0:e4c5e6ec922e 48 * wait(1);
mohamedmoawya 0:e4c5e6ec922e 49 * }
mohamedmoawya 0:e4c5e6ec922e 50 * }
mohamedmoawya 0:e4c5e6ec922e 51 * @endcode
mohamedmoawya 0:e4c5e6ec922e 52 * @ingroup drivers
mohamedmoawya 0:e4c5e6ec922e 53 */
mohamedmoawya 0:e4c5e6ec922e 54 class PortOut {
mohamedmoawya 0:e4c5e6ec922e 55 public:
mohamedmoawya 0:e4c5e6ec922e 56
mohamedmoawya 0:e4c5e6ec922e 57 /** Create a PortOut, connected to the specified port
mohamedmoawya 0:e4c5e6ec922e 58 *
mohamedmoawya 0:e4c5e6ec922e 59 * @param port Port to connect to (as defined in target's PortNames.h)
mohamedmoawya 0:e4c5e6ec922e 60 * @param mask Bitmask defines which port pins are an output (0 - ignore, 1 - include)
mohamedmoawya 0:e4c5e6ec922e 61 */
mohamedmoawya 0:e4c5e6ec922e 62 PortOut(PortName port, int mask = 0xFFFFFFFF)
mohamedmoawya 0:e4c5e6ec922e 63 {
mohamedmoawya 0:e4c5e6ec922e 64 core_util_critical_section_enter();
mohamedmoawya 0:e4c5e6ec922e 65 port_init(&_port, port, mask, PIN_OUTPUT);
mohamedmoawya 0:e4c5e6ec922e 66 core_util_critical_section_exit();
mohamedmoawya 0:e4c5e6ec922e 67 }
mohamedmoawya 0:e4c5e6ec922e 68
mohamedmoawya 0:e4c5e6ec922e 69 /** Write the value to the output port
mohamedmoawya 0:e4c5e6ec922e 70 *
mohamedmoawya 0:e4c5e6ec922e 71 * @param value An integer specifying a bit to write for every corresponding PortOut pin
mohamedmoawya 0:e4c5e6ec922e 72 */
mohamedmoawya 0:e4c5e6ec922e 73 void write(int value)
mohamedmoawya 0:e4c5e6ec922e 74 {
mohamedmoawya 0:e4c5e6ec922e 75 port_write(&_port, value);
mohamedmoawya 0:e4c5e6ec922e 76 }
mohamedmoawya 0:e4c5e6ec922e 77
mohamedmoawya 0:e4c5e6ec922e 78 /** Read the value currently output on the port
mohamedmoawya 0:e4c5e6ec922e 79 *
mohamedmoawya 0:e4c5e6ec922e 80 * @returns
mohamedmoawya 0:e4c5e6ec922e 81 * An integer with each bit corresponding to associated pin value
mohamedmoawya 0:e4c5e6ec922e 82 */
mohamedmoawya 0:e4c5e6ec922e 83 int read()
mohamedmoawya 0:e4c5e6ec922e 84 {
mohamedmoawya 0:e4c5e6ec922e 85 return port_read(&_port);
mohamedmoawya 0:e4c5e6ec922e 86 }
mohamedmoawya 0:e4c5e6ec922e 87
mohamedmoawya 0:e4c5e6ec922e 88 /** A shorthand for write()
mohamedmoawya 0:e4c5e6ec922e 89 * \sa PortOut::write()
mohamedmoawya 0:e4c5e6ec922e 90 */
mohamedmoawya 0:e4c5e6ec922e 91 PortOut &operator= (int value)
mohamedmoawya 0:e4c5e6ec922e 92 {
mohamedmoawya 0:e4c5e6ec922e 93 write(value);
mohamedmoawya 0:e4c5e6ec922e 94 return *this;
mohamedmoawya 0:e4c5e6ec922e 95 }
mohamedmoawya 0:e4c5e6ec922e 96
mohamedmoawya 0:e4c5e6ec922e 97 /** A shorthand for read()
mohamedmoawya 0:e4c5e6ec922e 98 * \sa PortOut::read()
mohamedmoawya 0:e4c5e6ec922e 99 */
mohamedmoawya 0:e4c5e6ec922e 100 PortOut &operator= (PortOut &rhs)
mohamedmoawya 0:e4c5e6ec922e 101 {
mohamedmoawya 0:e4c5e6ec922e 102 write(rhs.read());
mohamedmoawya 0:e4c5e6ec922e 103 return *this;
mohamedmoawya 0:e4c5e6ec922e 104 }
mohamedmoawya 0:e4c5e6ec922e 105
mohamedmoawya 0:e4c5e6ec922e 106 /** A shorthand for read()
mohamedmoawya 0:e4c5e6ec922e 107 * \sa PortOut::read()
mohamedmoawya 0:e4c5e6ec922e 108 */
mohamedmoawya 0:e4c5e6ec922e 109 operator int()
mohamedmoawya 0:e4c5e6ec922e 110 {
mohamedmoawya 0:e4c5e6ec922e 111 return read();
mohamedmoawya 0:e4c5e6ec922e 112 }
mohamedmoawya 0:e4c5e6ec922e 113
mohamedmoawya 0:e4c5e6ec922e 114 private:
mohamedmoawya 0:e4c5e6ec922e 115 port_t _port;
mohamedmoawya 0:e4c5e6ec922e 116 };
mohamedmoawya 0:e4c5e6ec922e 117
mohamedmoawya 0:e4c5e6ec922e 118 } // namespace mbed
mohamedmoawya 0:e4c5e6ec922e 119
mohamedmoawya 0:e4c5e6ec922e 120 #endif
mohamedmoawya 0:e4c5e6ec922e 121
mohamedmoawya 0:e4c5e6ec922e 122 #endif