Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/RawSerial.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_RAW_SERIAL_H
mohamedmoawya 0:e4c5e6ec922e 17 #define MBED_RAW_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 "drivers/SerialBase.h"
mohamedmoawya 0:e4c5e6ec922e 24 #include "hal/serial_api.h"
mohamedmoawya 0:e4c5e6ec922e 25 #include "platform/NonCopyable.h"
mohamedmoawya 0:e4c5e6ec922e 26
mohamedmoawya 0:e4c5e6ec922e 27 namespace mbed {
mohamedmoawya 0:e4c5e6ec922e 28 /** \addtogroup drivers */
mohamedmoawya 0:e4c5e6ec922e 29
mohamedmoawya 0:e4c5e6ec922e 30 /** A serial port (UART) for communication with other serial devices
mohamedmoawya 0:e4c5e6ec922e 31 * This is a variation of the Serial class that doesn't use streams,
mohamedmoawya 0:e4c5e6ec922e 32 * thus making it safe to use in interrupt handlers with the RTOS.
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: Not protected
mohamedmoawya 0:e4c5e6ec922e 38 *
mohamedmoawya 0:e4c5e6ec922e 39 * Example:
mohamedmoawya 0:e4c5e6ec922e 40 * @code
mohamedmoawya 0:e4c5e6ec922e 41 * // Send a char to the PC
mohamedmoawya 0:e4c5e6ec922e 42 *
mohamedmoawya 0:e4c5e6ec922e 43 * #include "mbed.h"
mohamedmoawya 0:e4c5e6ec922e 44 *
mohamedmoawya 0:e4c5e6ec922e 45 * RawSerial pc(USBTX, USBRX);
mohamedmoawya 0:e4c5e6ec922e 46 *
mohamedmoawya 0:e4c5e6ec922e 47 * int main() {
mohamedmoawya 0:e4c5e6ec922e 48 * pc.putc('A');
mohamedmoawya 0:e4c5e6ec922e 49 * }
mohamedmoawya 0:e4c5e6ec922e 50 * @endcode
mohamedmoawya 0:e4c5e6ec922e 51 * @ingroup drivers
mohamedmoawya 0:e4c5e6ec922e 52 */
mohamedmoawya 0:e4c5e6ec922e 53 class RawSerial: public SerialBase, private NonCopyable<RawSerial> {
mohamedmoawya 0:e4c5e6ec922e 54
mohamedmoawya 0:e4c5e6ec922e 55 public:
mohamedmoawya 0:e4c5e6ec922e 56 /** Create a RawSerial port, connected to the specified transmit and receive pins, with the specified baud.
mohamedmoawya 0:e4c5e6ec922e 57 *
mohamedmoawya 0:e4c5e6ec922e 58 * @param tx Transmit pin
mohamedmoawya 0:e4c5e6ec922e 59 * @param rx Receive pin
mohamedmoawya 0:e4c5e6ec922e 60 * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
mohamedmoawya 0:e4c5e6ec922e 61 *
mohamedmoawya 0:e4c5e6ec922e 62 * @note
mohamedmoawya 0:e4c5e6ec922e 63 * Either tx or rx may be specified as NC if unused
mohamedmoawya 0:e4c5e6ec922e 64 */
mohamedmoawya 0:e4c5e6ec922e 65 RawSerial(PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
mohamedmoawya 0:e4c5e6ec922e 66
mohamedmoawya 0:e4c5e6ec922e 67 /** Write a char to the serial port
mohamedmoawya 0:e4c5e6ec922e 68 *
mohamedmoawya 0:e4c5e6ec922e 69 * @param c The char to write
mohamedmoawya 0:e4c5e6ec922e 70 *
mohamedmoawya 0:e4c5e6ec922e 71 * @returns The written char or -1 if an error occurred
mohamedmoawya 0:e4c5e6ec922e 72 */
mohamedmoawya 0:e4c5e6ec922e 73 int putc(int c);
mohamedmoawya 0:e4c5e6ec922e 74
mohamedmoawya 0:e4c5e6ec922e 75 /** Read a char from the serial port
mohamedmoawya 0:e4c5e6ec922e 76 *
mohamedmoawya 0:e4c5e6ec922e 77 * @returns The char read from the serial port
mohamedmoawya 0:e4c5e6ec922e 78 */
mohamedmoawya 0:e4c5e6ec922e 79 int getc();
mohamedmoawya 0:e4c5e6ec922e 80
mohamedmoawya 0:e4c5e6ec922e 81 /** Write a string to the serial port
mohamedmoawya 0:e4c5e6ec922e 82 *
mohamedmoawya 0:e4c5e6ec922e 83 * @param str The string to write
mohamedmoawya 0:e4c5e6ec922e 84 *
mohamedmoawya 0:e4c5e6ec922e 85 * @returns 0 if the write succeeds, EOF for error
mohamedmoawya 0:e4c5e6ec922e 86 */
mohamedmoawya 0:e4c5e6ec922e 87 int puts(const char *str);
mohamedmoawya 0:e4c5e6ec922e 88
mohamedmoawya 0:e4c5e6ec922e 89 int printf(const char *format, ...);
mohamedmoawya 0:e4c5e6ec922e 90
mohamedmoawya 0:e4c5e6ec922e 91 #if !(DOXYGEN_ONLY)
mohamedmoawya 0:e4c5e6ec922e 92 protected:
mohamedmoawya 0:e4c5e6ec922e 93
mohamedmoawya 0:e4c5e6ec922e 94 /* Acquire exclusive access to this serial port
mohamedmoawya 0:e4c5e6ec922e 95 */
mohamedmoawya 0:e4c5e6ec922e 96 virtual void lock(void);
mohamedmoawya 0:e4c5e6ec922e 97
mohamedmoawya 0:e4c5e6ec922e 98 /* Release exclusive access to this serial port
mohamedmoawya 0:e4c5e6ec922e 99 */
mohamedmoawya 0:e4c5e6ec922e 100 virtual void unlock(void);
mohamedmoawya 0:e4c5e6ec922e 101 #endif
mohamedmoawya 0:e4c5e6ec922e 102 };
mohamedmoawya 0:e4c5e6ec922e 103
mohamedmoawya 0:e4c5e6ec922e 104 } // namespace mbed
mohamedmoawya 0:e4c5e6ec922e 105
mohamedmoawya 0:e4c5e6ec922e 106 #endif
mohamedmoawya 0:e4c5e6ec922e 107
mohamedmoawya 0:e4c5e6ec922e 108 #endif