Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/DigitalIn.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_DIGITALIN_H
mohamedmoawya 0:e4c5e6ec922e 17 #define MBED_DIGITALIN_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, used for reading the state of a pin
mohamedmoawya 0:e4c5e6ec922e 28 *
mohamedmoawya 0:e4c5e6ec922e 29 * @note Synchronization level: Interrupt safe
mohamedmoawya 0:e4c5e6ec922e 30 *
mohamedmoawya 0:e4c5e6ec922e 31 * Example:
mohamedmoawya 0:e4c5e6ec922e 32 * @code
mohamedmoawya 0:e4c5e6ec922e 33 * // Flash an LED while a DigitalIn is true
mohamedmoawya 0:e4c5e6ec922e 34 *
mohamedmoawya 0:e4c5e6ec922e 35 * #include "mbed.h"
mohamedmoawya 0:e4c5e6ec922e 36 *
mohamedmoawya 0:e4c5e6ec922e 37 * DigitalIn enable(p5);
mohamedmoawya 0:e4c5e6ec922e 38 * DigitalOut led(LED1);
mohamedmoawya 0:e4c5e6ec922e 39 *
mohamedmoawya 0:e4c5e6ec922e 40 * int main() {
mohamedmoawya 0:e4c5e6ec922e 41 * while(1) {
mohamedmoawya 0:e4c5e6ec922e 42 * if(enable) {
mohamedmoawya 0:e4c5e6ec922e 43 * led = !led;
mohamedmoawya 0:e4c5e6ec922e 44 * }
mohamedmoawya 0:e4c5e6ec922e 45 * wait(0.25);
mohamedmoawya 0:e4c5e6ec922e 46 * }
mohamedmoawya 0:e4c5e6ec922e 47 * }
mohamedmoawya 0:e4c5e6ec922e 48 * @endcode
mohamedmoawya 0:e4c5e6ec922e 49 * @ingroup drivers
mohamedmoawya 0:e4c5e6ec922e 50 */
mohamedmoawya 0:e4c5e6ec922e 51 class DigitalIn {
mohamedmoawya 0:e4c5e6ec922e 52
mohamedmoawya 0:e4c5e6ec922e 53 public:
mohamedmoawya 0:e4c5e6ec922e 54 /** Create a DigitalIn connected to the specified pin
mohamedmoawya 0:e4c5e6ec922e 55 *
mohamedmoawya 0:e4c5e6ec922e 56 * @param pin DigitalIn pin to connect to
mohamedmoawya 0:e4c5e6ec922e 57 */
mohamedmoawya 0:e4c5e6ec922e 58 DigitalIn(PinName pin) : gpio()
mohamedmoawya 0:e4c5e6ec922e 59 {
mohamedmoawya 0:e4c5e6ec922e 60 // No lock needed in the constructor
mohamedmoawya 0:e4c5e6ec922e 61 gpio_init_in(&gpio, pin);
mohamedmoawya 0:e4c5e6ec922e 62 }
mohamedmoawya 0:e4c5e6ec922e 63
mohamedmoawya 0:e4c5e6ec922e 64 /** Create a DigitalIn connected to the specified pin
mohamedmoawya 0:e4c5e6ec922e 65 *
mohamedmoawya 0:e4c5e6ec922e 66 * @param pin DigitalIn pin to connect to
mohamedmoawya 0:e4c5e6ec922e 67 * @param mode the initial mode of the pin
mohamedmoawya 0:e4c5e6ec922e 68 */
mohamedmoawya 0:e4c5e6ec922e 69 DigitalIn(PinName pin, PinMode mode) : gpio()
mohamedmoawya 0:e4c5e6ec922e 70 {
mohamedmoawya 0:e4c5e6ec922e 71 // No lock needed in the constructor
mohamedmoawya 0:e4c5e6ec922e 72 gpio_init_in_ex(&gpio, pin, mode);
mohamedmoawya 0:e4c5e6ec922e 73 }
mohamedmoawya 0:e4c5e6ec922e 74 /** Read the input, represented as 0 or 1 (int)
mohamedmoawya 0:e4c5e6ec922e 75 *
mohamedmoawya 0:e4c5e6ec922e 76 * @returns
mohamedmoawya 0:e4c5e6ec922e 77 * An integer representing the state of the input pin,
mohamedmoawya 0:e4c5e6ec922e 78 * 0 for logical 0, 1 for logical 1
mohamedmoawya 0:e4c5e6ec922e 79 */
mohamedmoawya 0:e4c5e6ec922e 80 int read()
mohamedmoawya 0:e4c5e6ec922e 81 {
mohamedmoawya 0:e4c5e6ec922e 82 // Thread safe / atomic HAL call
mohamedmoawya 0:e4c5e6ec922e 83 return gpio_read(&gpio);
mohamedmoawya 0:e4c5e6ec922e 84 }
mohamedmoawya 0:e4c5e6ec922e 85
mohamedmoawya 0:e4c5e6ec922e 86 /** Set the input pin mode
mohamedmoawya 0:e4c5e6ec922e 87 *
mohamedmoawya 0:e4c5e6ec922e 88 * @param pull PullUp, PullDown, PullNone, OpenDrain
mohamedmoawya 0:e4c5e6ec922e 89 */
mohamedmoawya 0:e4c5e6ec922e 90 void mode(PinMode pull)
mohamedmoawya 0:e4c5e6ec922e 91 {
mohamedmoawya 0:e4c5e6ec922e 92 core_util_critical_section_enter();
mohamedmoawya 0:e4c5e6ec922e 93 gpio_mode(&gpio, pull);
mohamedmoawya 0:e4c5e6ec922e 94 core_util_critical_section_exit();
mohamedmoawya 0:e4c5e6ec922e 95 }
mohamedmoawya 0:e4c5e6ec922e 96
mohamedmoawya 0:e4c5e6ec922e 97 /** Return the output setting, represented as 0 or 1 (int)
mohamedmoawya 0:e4c5e6ec922e 98 *
mohamedmoawya 0:e4c5e6ec922e 99 * @returns
mohamedmoawya 0:e4c5e6ec922e 100 * Non zero value if pin is connected to uc GPIO
mohamedmoawya 0:e4c5e6ec922e 101 * 0 if gpio object was initialized with NC
mohamedmoawya 0:e4c5e6ec922e 102 */
mohamedmoawya 0:e4c5e6ec922e 103 int is_connected()
mohamedmoawya 0:e4c5e6ec922e 104 {
mohamedmoawya 0:e4c5e6ec922e 105 // Thread safe / atomic HAL call
mohamedmoawya 0:e4c5e6ec922e 106 return gpio_is_connected(&gpio);
mohamedmoawya 0:e4c5e6ec922e 107 }
mohamedmoawya 0:e4c5e6ec922e 108
mohamedmoawya 0:e4c5e6ec922e 109 /** An operator shorthand for read()
mohamedmoawya 0:e4c5e6ec922e 110 * \sa DigitalIn::read()
mohamedmoawya 0:e4c5e6ec922e 111 * @code
mohamedmoawya 0:e4c5e6ec922e 112 * DigitalIn button(BUTTON1);
mohamedmoawya 0:e4c5e6ec922e 113 * DigitalOut led(LED1);
mohamedmoawya 0:e4c5e6ec922e 114 * led = button; // Equivalent to led.write(button.read())
mohamedmoawya 0:e4c5e6ec922e 115 * @endcode
mohamedmoawya 0:e4c5e6ec922e 116 */
mohamedmoawya 0:e4c5e6ec922e 117 operator int()
mohamedmoawya 0:e4c5e6ec922e 118 {
mohamedmoawya 0:e4c5e6ec922e 119 // Underlying read is thread safe
mohamedmoawya 0:e4c5e6ec922e 120 return read();
mohamedmoawya 0:e4c5e6ec922e 121 }
mohamedmoawya 0:e4c5e6ec922e 122
mohamedmoawya 0:e4c5e6ec922e 123 protected:
mohamedmoawya 0:e4c5e6ec922e 124 #if !defined(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 125 gpio_t gpio;
mohamedmoawya 0:e4c5e6ec922e 126 #endif //!defined(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 127 };
mohamedmoawya 0:e4c5e6ec922e 128
mohamedmoawya 0:e4c5e6ec922e 129 } // namespace mbed
mohamedmoawya 0:e4c5e6ec922e 130
mohamedmoawya 0:e4c5e6ec922e 131 #endif