Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/DigitalInOut.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_DIGITALINOUT_H
mohamedmoawya 0:e4c5e6ec922e 17 #define MBED_DIGITALINOUT_H
mohamedmoawya 0:e4c5e6ec922e 18
mohamedmoawya 0:e4c5e6ec922e 19 #include "platform/platform.h"
mohamedmoawya 0:e4c5e6ec922e 20
mohamedmoawya 0:e4c5e6ec922e 21 #include "hal/gpio_api.h"
mohamedmoawya 0:e4c5e6ec922e 22 #include "platform/mbed_critical.h"
mohamedmoawya 0:e4c5e6ec922e 23
mohamedmoawya 0:e4c5e6ec922e 24 namespace mbed {
mohamedmoawya 0:e4c5e6ec922e 25 /** \addtogroup drivers */
mohamedmoawya 0:e4c5e6ec922e 26
mohamedmoawya 0:e4c5e6ec922e 27 /** A digital input/output, used for setting or reading a bi-directional pin
mohamedmoawya 0:e4c5e6ec922e 28 *
mohamedmoawya 0:e4c5e6ec922e 29 * @note Synchronization level: Interrupt safe
mohamedmoawya 0:e4c5e6ec922e 30 * @ingroup drivers
mohamedmoawya 0:e4c5e6ec922e 31 */
mohamedmoawya 0:e4c5e6ec922e 32 class DigitalInOut {
mohamedmoawya 0:e4c5e6ec922e 33
mohamedmoawya 0:e4c5e6ec922e 34 public:
mohamedmoawya 0:e4c5e6ec922e 35 /** Create a DigitalInOut connected to the specified pin
mohamedmoawya 0:e4c5e6ec922e 36 *
mohamedmoawya 0:e4c5e6ec922e 37 * @param pin DigitalInOut pin to connect to
mohamedmoawya 0:e4c5e6ec922e 38 */
mohamedmoawya 0:e4c5e6ec922e 39 DigitalInOut(PinName pin) : gpio()
mohamedmoawya 0:e4c5e6ec922e 40 {
mohamedmoawya 0:e4c5e6ec922e 41 // No lock needed in the constructor
mohamedmoawya 0:e4c5e6ec922e 42 gpio_init_in(&gpio, pin);
mohamedmoawya 0:e4c5e6ec922e 43 }
mohamedmoawya 0:e4c5e6ec922e 44
mohamedmoawya 0:e4c5e6ec922e 45 /** Create a DigitalInOut connected to the specified pin
mohamedmoawya 0:e4c5e6ec922e 46 *
mohamedmoawya 0:e4c5e6ec922e 47 * @param pin DigitalInOut pin to connect to
mohamedmoawya 0:e4c5e6ec922e 48 * @param direction the initial direction of the pin
mohamedmoawya 0:e4c5e6ec922e 49 * @param mode the initial mode of the pin
mohamedmoawya 0:e4c5e6ec922e 50 * @param value the initial value of the pin if is an output
mohamedmoawya 0:e4c5e6ec922e 51 */
mohamedmoawya 0:e4c5e6ec922e 52 DigitalInOut(PinName pin, PinDirection direction, PinMode mode, int value) : gpio()
mohamedmoawya 0:e4c5e6ec922e 53 {
mohamedmoawya 0:e4c5e6ec922e 54 // No lock needed in the constructor
mohamedmoawya 0:e4c5e6ec922e 55 gpio_init_inout(&gpio, pin, direction, mode, value);
mohamedmoawya 0:e4c5e6ec922e 56 }
mohamedmoawya 0:e4c5e6ec922e 57
mohamedmoawya 0:e4c5e6ec922e 58 /** Set the output, specified as 0 or 1 (int)
mohamedmoawya 0:e4c5e6ec922e 59 *
mohamedmoawya 0:e4c5e6ec922e 60 * @param value An integer specifying the pin output value,
mohamedmoawya 0:e4c5e6ec922e 61 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
mohamedmoawya 0:e4c5e6ec922e 62 */
mohamedmoawya 0:e4c5e6ec922e 63 void write(int value)
mohamedmoawya 0:e4c5e6ec922e 64 {
mohamedmoawya 0:e4c5e6ec922e 65 // Thread safe / atomic HAL call
mohamedmoawya 0:e4c5e6ec922e 66 gpio_write(&gpio, value);
mohamedmoawya 0:e4c5e6ec922e 67 }
mohamedmoawya 0:e4c5e6ec922e 68
mohamedmoawya 0:e4c5e6ec922e 69 /** Return the output setting, represented as 0 or 1 (int)
mohamedmoawya 0:e4c5e6ec922e 70 *
mohamedmoawya 0:e4c5e6ec922e 71 * @returns
mohamedmoawya 0:e4c5e6ec922e 72 * an integer representing the output setting of the pin if it is an output,
mohamedmoawya 0:e4c5e6ec922e 73 * or read the input if set as an input
mohamedmoawya 0:e4c5e6ec922e 74 */
mohamedmoawya 0:e4c5e6ec922e 75 int read()
mohamedmoawya 0:e4c5e6ec922e 76 {
mohamedmoawya 0:e4c5e6ec922e 77 // Thread safe / atomic HAL call
mohamedmoawya 0:e4c5e6ec922e 78 return gpio_read(&gpio);
mohamedmoawya 0:e4c5e6ec922e 79 }
mohamedmoawya 0:e4c5e6ec922e 80
mohamedmoawya 0:e4c5e6ec922e 81 /** Set as an output
mohamedmoawya 0:e4c5e6ec922e 82 */
mohamedmoawya 0:e4c5e6ec922e 83 void output()
mohamedmoawya 0:e4c5e6ec922e 84 {
mohamedmoawya 0:e4c5e6ec922e 85 core_util_critical_section_enter();
mohamedmoawya 0:e4c5e6ec922e 86 gpio_dir(&gpio, PIN_OUTPUT);
mohamedmoawya 0:e4c5e6ec922e 87 core_util_critical_section_exit();
mohamedmoawya 0:e4c5e6ec922e 88 }
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 core_util_critical_section_enter();
mohamedmoawya 0:e4c5e6ec922e 95 gpio_dir(&gpio, PIN_INPUT);
mohamedmoawya 0:e4c5e6ec922e 96 core_util_critical_section_exit();
mohamedmoawya 0:e4c5e6ec922e 97 }
mohamedmoawya 0:e4c5e6ec922e 98
mohamedmoawya 0:e4c5e6ec922e 99 /** Set the input pin mode
mohamedmoawya 0:e4c5e6ec922e 100 *
mohamedmoawya 0:e4c5e6ec922e 101 * @param pull PullUp, PullDown, PullNone, OpenDrain
mohamedmoawya 0:e4c5e6ec922e 102 */
mohamedmoawya 0:e4c5e6ec922e 103 void mode(PinMode pull)
mohamedmoawya 0:e4c5e6ec922e 104 {
mohamedmoawya 0:e4c5e6ec922e 105 core_util_critical_section_enter();
mohamedmoawya 0:e4c5e6ec922e 106 gpio_mode(&gpio, pull);
mohamedmoawya 0:e4c5e6ec922e 107 core_util_critical_section_exit();
mohamedmoawya 0:e4c5e6ec922e 108 }
mohamedmoawya 0:e4c5e6ec922e 109
mohamedmoawya 0:e4c5e6ec922e 110 /** Return the output setting, represented as 0 or 1 (int)
mohamedmoawya 0:e4c5e6ec922e 111 *
mohamedmoawya 0:e4c5e6ec922e 112 * @returns
mohamedmoawya 0:e4c5e6ec922e 113 * Non zero value if pin is connected to uc GPIO
mohamedmoawya 0:e4c5e6ec922e 114 * 0 if gpio object was initialized with NC
mohamedmoawya 0:e4c5e6ec922e 115 */
mohamedmoawya 0:e4c5e6ec922e 116 int is_connected()
mohamedmoawya 0:e4c5e6ec922e 117 {
mohamedmoawya 0:e4c5e6ec922e 118 // Thread safe / atomic HAL call
mohamedmoawya 0:e4c5e6ec922e 119 return gpio_is_connected(&gpio);
mohamedmoawya 0:e4c5e6ec922e 120 }
mohamedmoawya 0:e4c5e6ec922e 121
mohamedmoawya 0:e4c5e6ec922e 122 /** A shorthand for write()
mohamedmoawya 0:e4c5e6ec922e 123 * \sa DigitalInOut::write()
mohamedmoawya 0:e4c5e6ec922e 124 * @code
mohamedmoawya 0:e4c5e6ec922e 125 * DigitalInOut inout(PIN);
mohamedmoawya 0:e4c5e6ec922e 126 * DigitalIn button(BUTTON1);
mohamedmoawya 0:e4c5e6ec922e 127 * inout.output();
mohamedmoawya 0:e4c5e6ec922e 128 *
mohamedmoawya 0:e4c5e6ec922e 129 * inout = button; // Equivalent to inout.write(button.read())
mohamedmoawya 0:e4c5e6ec922e 130 * @endcode
mohamedmoawya 0:e4c5e6ec922e 131 */
mohamedmoawya 0:e4c5e6ec922e 132 DigitalInOut &operator= (int value)
mohamedmoawya 0:e4c5e6ec922e 133 {
mohamedmoawya 0:e4c5e6ec922e 134 // Underlying write is thread safe
mohamedmoawya 0:e4c5e6ec922e 135 write(value);
mohamedmoawya 0:e4c5e6ec922e 136 return *this;
mohamedmoawya 0:e4c5e6ec922e 137 }
mohamedmoawya 0:e4c5e6ec922e 138
mohamedmoawya 0:e4c5e6ec922e 139 /**A shorthand for write() using the assignment operator which copies the
mohamedmoawya 0:e4c5e6ec922e 140 * state from the DigitalInOut argument.
mohamedmoawya 0:e4c5e6ec922e 141 * \sa DigitalInOut::write()
mohamedmoawya 0:e4c5e6ec922e 142 */
mohamedmoawya 0:e4c5e6ec922e 143 DigitalInOut &operator= (DigitalInOut &rhs)
mohamedmoawya 0:e4c5e6ec922e 144 {
mohamedmoawya 0:e4c5e6ec922e 145 core_util_critical_section_enter();
mohamedmoawya 0:e4c5e6ec922e 146 write(rhs.read());
mohamedmoawya 0:e4c5e6ec922e 147 core_util_critical_section_exit();
mohamedmoawya 0:e4c5e6ec922e 148 return *this;
mohamedmoawya 0:e4c5e6ec922e 149 }
mohamedmoawya 0:e4c5e6ec922e 150
mohamedmoawya 0:e4c5e6ec922e 151 /** A shorthand for read()
mohamedmoawya 0:e4c5e6ec922e 152 * \sa DigitalInOut::read()
mohamedmoawya 0:e4c5e6ec922e 153 * @code
mohamedmoawya 0:e4c5e6ec922e 154 * DigitalInOut inout(PIN);
mohamedmoawya 0:e4c5e6ec922e 155 * DigitalOut led(LED1);
mohamedmoawya 0:e4c5e6ec922e 156 *
mohamedmoawya 0:e4c5e6ec922e 157 * inout.input();
mohamedmoawya 0:e4c5e6ec922e 158 * led = inout; // Equivalent to led.write(inout.read())
mohamedmoawya 0:e4c5e6ec922e 159 * @endcode
mohamedmoawya 0:e4c5e6ec922e 160 */
mohamedmoawya 0:e4c5e6ec922e 161 operator int()
mohamedmoawya 0:e4c5e6ec922e 162 {
mohamedmoawya 0:e4c5e6ec922e 163 // Underlying call is thread safe
mohamedmoawya 0:e4c5e6ec922e 164 return read();
mohamedmoawya 0:e4c5e6ec922e 165 }
mohamedmoawya 0:e4c5e6ec922e 166
mohamedmoawya 0:e4c5e6ec922e 167 protected:
mohamedmoawya 0:e4c5e6ec922e 168 #if !defined(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 169 gpio_t gpio;
mohamedmoawya 0:e4c5e6ec922e 170 #endif //!defined(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 171 };
mohamedmoawya 0:e4c5e6ec922e 172
mohamedmoawya 0:e4c5e6ec922e 173 } // namespace mbed
mohamedmoawya 0:e4c5e6ec922e 174
mohamedmoawya 0:e4c5e6ec922e 175 #endif