Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/Serial.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_SERIAL_H
mohamedmoawya 0:e4c5e6ec922e 17 #define MBED_SERIAL_H
mohamedmoawya 0:e4c5e6ec922e 18
mohamedmoawya 0:e4c5e6ec922e 19 #include "platform/platform.h"
mohamedmoawya 0:e4c5e6ec922e 20
mohamedmoawya 0:e4c5e6ec922e 21 #if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 22
mohamedmoawya 0:e4c5e6ec922e 23 #include "platform/Stream.h"
mohamedmoawya 0:e4c5e6ec922e 24 #include "SerialBase.h"
mohamedmoawya 0:e4c5e6ec922e 25 #include "platform/PlatformMutex.h"
mohamedmoawya 0:e4c5e6ec922e 26 #include "hal/serial_api.h"
mohamedmoawya 0:e4c5e6ec922e 27 #include "platform/NonCopyable.h"
mohamedmoawya 0:e4c5e6ec922e 28
mohamedmoawya 0:e4c5e6ec922e 29 namespace mbed {
mohamedmoawya 0:e4c5e6ec922e 30 /** \addtogroup drivers */
mohamedmoawya 0:e4c5e6ec922e 31
mohamedmoawya 0:e4c5e6ec922e 32 /** A serial port (UART) for communication with other serial devices
mohamedmoawya 0:e4c5e6ec922e 33 *
mohamedmoawya 0:e4c5e6ec922e 34 * Can be used for Full Duplex communication, or Simplex by specifying
mohamedmoawya 0:e4c5e6ec922e 35 * one pin as NC (Not Connected)
mohamedmoawya 0:e4c5e6ec922e 36 *
mohamedmoawya 0:e4c5e6ec922e 37 * @note Synchronization level: Thread safe
mohamedmoawya 0:e4c5e6ec922e 38 *
mohamedmoawya 0:e4c5e6ec922e 39 * Example:
mohamedmoawya 0:e4c5e6ec922e 40 * @code
mohamedmoawya 0:e4c5e6ec922e 41 * // Print "Hello World" to the PC
mohamedmoawya 0:e4c5e6ec922e 42 *
mohamedmoawya 0:e4c5e6ec922e 43 * #include "mbed.h"
mohamedmoawya 0:e4c5e6ec922e 44 *
mohamedmoawya 0:e4c5e6ec922e 45 * Serial pc(USBTX, USBRX);
mohamedmoawya 0:e4c5e6ec922e 46 *
mohamedmoawya 0:e4c5e6ec922e 47 * int main() {
mohamedmoawya 0:e4c5e6ec922e 48 * pc.printf("Hello World\n");
mohamedmoawya 0:e4c5e6ec922e 49 * }
mohamedmoawya 0:e4c5e6ec922e 50 * @endcode
mohamedmoawya 0:e4c5e6ec922e 51 * @ingroup drivers
mohamedmoawya 0:e4c5e6ec922e 52 */
mohamedmoawya 0:e4c5e6ec922e 53 class Serial : public SerialBase, public Stream, private NonCopyable<Serial> {
mohamedmoawya 0:e4c5e6ec922e 54
mohamedmoawya 0:e4c5e6ec922e 55 public:
mohamedmoawya 0:e4c5e6ec922e 56 #if DEVICE_SERIAL_ASYNCH
mohamedmoawya 0:e4c5e6ec922e 57 using SerialBase::read;
mohamedmoawya 0:e4c5e6ec922e 58 using SerialBase::write;
mohamedmoawya 0:e4c5e6ec922e 59 #endif
mohamedmoawya 0:e4c5e6ec922e 60
mohamedmoawya 0:e4c5e6ec922e 61 /** Create a Serial port, connected to the specified transmit and receive pins
mohamedmoawya 0:e4c5e6ec922e 62 *
mohamedmoawya 0:e4c5e6ec922e 63 * @param tx Transmit pin
mohamedmoawya 0:e4c5e6ec922e 64 * @param rx Receive pin
mohamedmoawya 0:e4c5e6ec922e 65 * @param name The name of the stream associated with this serial port (optional)
mohamedmoawya 0:e4c5e6ec922e 66 * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE or 9600)
mohamedmoawya 0:e4c5e6ec922e 67 *
mohamedmoawya 0:e4c5e6ec922e 68 * @note
mohamedmoawya 0:e4c5e6ec922e 69 * Either tx or rx may be specified as NC (Not Connected) if unused
mohamedmoawya 0:e4c5e6ec922e 70 */
mohamedmoawya 0:e4c5e6ec922e 71 Serial(PinName tx, PinName rx, const char *name = NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
mohamedmoawya 0:e4c5e6ec922e 72
mohamedmoawya 0:e4c5e6ec922e 73
mohamedmoawya 0:e4c5e6ec922e 74 /** Create a Serial port, connected to the specified transmit and receive pins, with the specified baud
mohamedmoawya 0:e4c5e6ec922e 75 *
mohamedmoawya 0:e4c5e6ec922e 76 * @param tx Transmit pin
mohamedmoawya 0:e4c5e6ec922e 77 * @param rx Receive pin
mohamedmoawya 0:e4c5e6ec922e 78 * @param baud The baud rate of the serial port
mohamedmoawya 0:e4c5e6ec922e 79 *
mohamedmoawya 0:e4c5e6ec922e 80 * @note
mohamedmoawya 0:e4c5e6ec922e 81 * Either tx or rx may be specified as NC (Not Connected) if unused
mohamedmoawya 0:e4c5e6ec922e 82 */
mohamedmoawya 0:e4c5e6ec922e 83 Serial(PinName tx, PinName rx, int baud);
mohamedmoawya 0:e4c5e6ec922e 84
mohamedmoawya 0:e4c5e6ec922e 85 /* Stream gives us a FileHandle with non-functional poll()/readable()/writable. Pass through
mohamedmoawya 0:e4c5e6ec922e 86 * the calls from the SerialBase instead for backwards compatibility. This problem is
mohamedmoawya 0:e4c5e6ec922e 87 * part of why Stream and Serial should be deprecated.
mohamedmoawya 0:e4c5e6ec922e 88 */
mohamedmoawya 0:e4c5e6ec922e 89 bool readable()
mohamedmoawya 0:e4c5e6ec922e 90 {
mohamedmoawya 0:e4c5e6ec922e 91 return SerialBase::readable();
mohamedmoawya 0:e4c5e6ec922e 92 }
mohamedmoawya 0:e4c5e6ec922e 93 bool writable()
mohamedmoawya 0:e4c5e6ec922e 94 {
mohamedmoawya 0:e4c5e6ec922e 95 return SerialBase::writeable();
mohamedmoawya 0:e4c5e6ec922e 96 }
mohamedmoawya 0:e4c5e6ec922e 97 bool writeable()
mohamedmoawya 0:e4c5e6ec922e 98 {
mohamedmoawya 0:e4c5e6ec922e 99 return SerialBase::writeable();
mohamedmoawya 0:e4c5e6ec922e 100 }
mohamedmoawya 0:e4c5e6ec922e 101
mohamedmoawya 0:e4c5e6ec922e 102 #if !(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 103 protected:
mohamedmoawya 0:e4c5e6ec922e 104 virtual int _getc();
mohamedmoawya 0:e4c5e6ec922e 105 virtual int _putc(int c);
mohamedmoawya 0:e4c5e6ec922e 106 virtual void lock();
mohamedmoawya 0:e4c5e6ec922e 107 virtual void unlock();
mohamedmoawya 0:e4c5e6ec922e 108
mohamedmoawya 0:e4c5e6ec922e 109 PlatformMutex _mutex;
mohamedmoawya 0:e4c5e6ec922e 110 #endif
mohamedmoawya 0:e4c5e6ec922e 111 };
mohamedmoawya 0:e4c5e6ec922e 112
mohamedmoawya 0:e4c5e6ec922e 113 } // namespace mbed
mohamedmoawya 0:e4c5e6ec922e 114
mohamedmoawya 0:e4c5e6ec922e 115 #endif
mohamedmoawya 0:e4c5e6ec922e 116
mohamedmoawya 0:e4c5e6ec922e 117 #endif