Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/DigitalOut.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_DIGITALOUT_H
mohamedmoawya 0:e4c5e6ec922e 17 #define MBED_DIGITALOUT_H
mohamedmoawya 0:e4c5e6ec922e 18
mohamedmoawya 0:e4c5e6ec922e 19 #include "platform/platform.h"
mohamedmoawya 0:e4c5e6ec922e 20 #include "hal/gpio_api.h"
mohamedmoawya 0:e4c5e6ec922e 21 #include "platform/mbed_critical.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, used for setting the state of a pin
mohamedmoawya 0:e4c5e6ec922e 27 *
mohamedmoawya 0:e4c5e6ec922e 28 * @note Synchronization level: Interrupt safe
mohamedmoawya 0:e4c5e6ec922e 29 *
mohamedmoawya 0:e4c5e6ec922e 30 * Example:
mohamedmoawya 0:e4c5e6ec922e 31 * @code
mohamedmoawya 0:e4c5e6ec922e 32 * // Toggle a LED
mohamedmoawya 0:e4c5e6ec922e 33 * #include "mbed.h"
mohamedmoawya 0:e4c5e6ec922e 34 *
mohamedmoawya 0:e4c5e6ec922e 35 * DigitalOut led(LED1);
mohamedmoawya 0:e4c5e6ec922e 36 *
mohamedmoawya 0:e4c5e6ec922e 37 * int main() {
mohamedmoawya 0:e4c5e6ec922e 38 * while(1) {
mohamedmoawya 0:e4c5e6ec922e 39 * led = !led;
mohamedmoawya 0:e4c5e6ec922e 40 * wait(0.2);
mohamedmoawya 0:e4c5e6ec922e 41 * }
mohamedmoawya 0:e4c5e6ec922e 42 * }
mohamedmoawya 0:e4c5e6ec922e 43 * @endcode
mohamedmoawya 0:e4c5e6ec922e 44 * @ingroup drivers
mohamedmoawya 0:e4c5e6ec922e 45 */
mohamedmoawya 0:e4c5e6ec922e 46 class DigitalOut {
mohamedmoawya 0:e4c5e6ec922e 47
mohamedmoawya 0:e4c5e6ec922e 48 public:
mohamedmoawya 0:e4c5e6ec922e 49 /** Create a DigitalOut connected to the specified pin
mohamedmoawya 0:e4c5e6ec922e 50 *
mohamedmoawya 0:e4c5e6ec922e 51 * @param pin DigitalOut pin to connect to
mohamedmoawya 0:e4c5e6ec922e 52 */
mohamedmoawya 0:e4c5e6ec922e 53 DigitalOut(PinName pin) : gpio()
mohamedmoawya 0:e4c5e6ec922e 54 {
mohamedmoawya 0:e4c5e6ec922e 55 // No lock needed in the constructor
mohamedmoawya 0:e4c5e6ec922e 56 gpio_init_out(&gpio, pin);
mohamedmoawya 0:e4c5e6ec922e 57 }
mohamedmoawya 0:e4c5e6ec922e 58
mohamedmoawya 0:e4c5e6ec922e 59 /** Create a DigitalOut connected to the specified pin
mohamedmoawya 0:e4c5e6ec922e 60 *
mohamedmoawya 0:e4c5e6ec922e 61 * @param pin DigitalOut pin to connect to
mohamedmoawya 0:e4c5e6ec922e 62 * @param value the initial pin value
mohamedmoawya 0:e4c5e6ec922e 63 */
mohamedmoawya 0:e4c5e6ec922e 64 DigitalOut(PinName pin, int value) : gpio()
mohamedmoawya 0:e4c5e6ec922e 65 {
mohamedmoawya 0:e4c5e6ec922e 66 // No lock needed in the constructor
mohamedmoawya 0:e4c5e6ec922e 67 gpio_init_out_ex(&gpio, pin, value);
mohamedmoawya 0:e4c5e6ec922e 68 }
mohamedmoawya 0:e4c5e6ec922e 69
mohamedmoawya 0:e4c5e6ec922e 70 /** Set the output, specified as 0 or 1 (int)
mohamedmoawya 0:e4c5e6ec922e 71 *
mohamedmoawya 0:e4c5e6ec922e 72 * @param value An integer specifying the pin output value,
mohamedmoawya 0:e4c5e6ec922e 73 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
mohamedmoawya 0:e4c5e6ec922e 74 */
mohamedmoawya 0:e4c5e6ec922e 75 void write(int value)
mohamedmoawya 0:e4c5e6ec922e 76 {
mohamedmoawya 0:e4c5e6ec922e 77 // Thread safe / atomic HAL call
mohamedmoawya 0:e4c5e6ec922e 78 gpio_write(&gpio, value);
mohamedmoawya 0:e4c5e6ec922e 79 }
mohamedmoawya 0:e4c5e6ec922e 80
mohamedmoawya 0:e4c5e6ec922e 81 /** Return the output setting, represented as 0 or 1 (int)
mohamedmoawya 0:e4c5e6ec922e 82 *
mohamedmoawya 0:e4c5e6ec922e 83 * @returns
mohamedmoawya 0:e4c5e6ec922e 84 * an integer representing the output setting of the pin,
mohamedmoawya 0:e4c5e6ec922e 85 * 0 for logical 0, 1 for logical 1
mohamedmoawya 0:e4c5e6ec922e 86 */
mohamedmoawya 0:e4c5e6ec922e 87 int read()
mohamedmoawya 0:e4c5e6ec922e 88 {
mohamedmoawya 0:e4c5e6ec922e 89 // Thread safe / atomic HAL call
mohamedmoawya 0:e4c5e6ec922e 90 return gpio_read(&gpio);
mohamedmoawya 0:e4c5e6ec922e 91 }
mohamedmoawya 0:e4c5e6ec922e 92
mohamedmoawya 0:e4c5e6ec922e 93 /** Return the output setting, represented as 0 or 1 (int)
mohamedmoawya 0:e4c5e6ec922e 94 *
mohamedmoawya 0:e4c5e6ec922e 95 * @returns
mohamedmoawya 0:e4c5e6ec922e 96 * Non zero value if pin is connected to uc GPIO
mohamedmoawya 0:e4c5e6ec922e 97 * 0 if gpio object was initialized with NC
mohamedmoawya 0:e4c5e6ec922e 98 */
mohamedmoawya 0:e4c5e6ec922e 99 int is_connected()
mohamedmoawya 0:e4c5e6ec922e 100 {
mohamedmoawya 0:e4c5e6ec922e 101 // Thread safe / atomic HAL call
mohamedmoawya 0:e4c5e6ec922e 102 return gpio_is_connected(&gpio);
mohamedmoawya 0:e4c5e6ec922e 103 }
mohamedmoawya 0:e4c5e6ec922e 104
mohamedmoawya 0:e4c5e6ec922e 105 /** A shorthand for write()
mohamedmoawya 0:e4c5e6ec922e 106 * \sa DigitalOut::write()
mohamedmoawya 0:e4c5e6ec922e 107 * @code
mohamedmoawya 0:e4c5e6ec922e 108 * DigitalIn button(BUTTON1);
mohamedmoawya 0:e4c5e6ec922e 109 * DigitalOut led(LED1);
mohamedmoawya 0:e4c5e6ec922e 110 * led = button; // Equivalent to led.write(button.read())
mohamedmoawya 0:e4c5e6ec922e 111 * @endcode
mohamedmoawya 0:e4c5e6ec922e 112 */
mohamedmoawya 0:e4c5e6ec922e 113 DigitalOut &operator= (int value)
mohamedmoawya 0:e4c5e6ec922e 114 {
mohamedmoawya 0:e4c5e6ec922e 115 // Underlying write is thread safe
mohamedmoawya 0:e4c5e6ec922e 116 write(value);
mohamedmoawya 0:e4c5e6ec922e 117 return *this;
mohamedmoawya 0:e4c5e6ec922e 118 }
mohamedmoawya 0:e4c5e6ec922e 119
mohamedmoawya 0:e4c5e6ec922e 120 /** A shorthand for write() using the assignment operator which copies the
mohamedmoawya 0:e4c5e6ec922e 121 * state from the DigitalOut argument.
mohamedmoawya 0:e4c5e6ec922e 122 * \sa DigitalOut::write()
mohamedmoawya 0:e4c5e6ec922e 123 */
mohamedmoawya 0:e4c5e6ec922e 124 DigitalOut &operator= (DigitalOut &rhs)
mohamedmoawya 0:e4c5e6ec922e 125 {
mohamedmoawya 0:e4c5e6ec922e 126 core_util_critical_section_enter();
mohamedmoawya 0:e4c5e6ec922e 127 write(rhs.read());
mohamedmoawya 0:e4c5e6ec922e 128 core_util_critical_section_exit();
mohamedmoawya 0:e4c5e6ec922e 129 return *this;
mohamedmoawya 0:e4c5e6ec922e 130 }
mohamedmoawya 0:e4c5e6ec922e 131
mohamedmoawya 0:e4c5e6ec922e 132 /** A shorthand for read()
mohamedmoawya 0:e4c5e6ec922e 133 * \sa DigitalOut::read()
mohamedmoawya 0:e4c5e6ec922e 134 * @code
mohamedmoawya 0:e4c5e6ec922e 135 * DigitalIn button(BUTTON1);
mohamedmoawya 0:e4c5e6ec922e 136 * DigitalOut led(LED1);
mohamedmoawya 0:e4c5e6ec922e 137 * led = button; // Equivalent to led.write(button.read())
mohamedmoawya 0:e4c5e6ec922e 138 * @endcode
mohamedmoawya 0:e4c5e6ec922e 139 */
mohamedmoawya 0:e4c5e6ec922e 140 operator int()
mohamedmoawya 0:e4c5e6ec922e 141 {
mohamedmoawya 0:e4c5e6ec922e 142 // Underlying call is thread safe
mohamedmoawya 0:e4c5e6ec922e 143 return read();
mohamedmoawya 0:e4c5e6ec922e 144 }
mohamedmoawya 0:e4c5e6ec922e 145
mohamedmoawya 0:e4c5e6ec922e 146 protected:
mohamedmoawya 0:e4c5e6ec922e 147 #if !defined(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 148 gpio_t gpio;
mohamedmoawya 0:e4c5e6ec922e 149 #endif //!defined(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 150 };
mohamedmoawya 0:e4c5e6ec922e 151
mohamedmoawya 0:e4c5e6ec922e 152 } // namespace mbed
mohamedmoawya 0:e4c5e6ec922e 153
mohamedmoawya 0:e4c5e6ec922e 154 #endif