Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

drivers/RawSerial.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
NYX 0:85b3fd62ea1a 1 /* mbed Microcontroller Library
NYX 0:85b3fd62ea1a 2 * Copyright (c) 2006-2013 ARM Limited
NYX 0:85b3fd62ea1a 3 *
NYX 0:85b3fd62ea1a 4 * Licensed under the Apache License, Version 2.0 (the "License");
NYX 0:85b3fd62ea1a 5 * you may not use this file except in compliance with the License.
NYX 0:85b3fd62ea1a 6 * You may obtain a copy of the License at
NYX 0:85b3fd62ea1a 7 *
NYX 0:85b3fd62ea1a 8 * http://www.apache.org/licenses/LICENSE-2.0
NYX 0:85b3fd62ea1a 9 *
NYX 0:85b3fd62ea1a 10 * Unless required by applicable law or agreed to in writing, software
NYX 0:85b3fd62ea1a 11 * distributed under the License is distributed on an "AS IS" BASIS,
NYX 0:85b3fd62ea1a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
NYX 0:85b3fd62ea1a 13 * See the License for the specific language governing permissions and
NYX 0:85b3fd62ea1a 14 * limitations under the License.
NYX 0:85b3fd62ea1a 15 */
NYX 0:85b3fd62ea1a 16 #ifndef MBED_RAW_SERIAL_H
NYX 0:85b3fd62ea1a 17 #define MBED_RAW_SERIAL_H
NYX 0:85b3fd62ea1a 18
NYX 0:85b3fd62ea1a 19 #include "platform/platform.h"
NYX 0:85b3fd62ea1a 20
NYX 0:85b3fd62ea1a 21 #if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY)
NYX 0:85b3fd62ea1a 22
NYX 0:85b3fd62ea1a 23 #include "drivers/SerialBase.h"
NYX 0:85b3fd62ea1a 24 #include "hal/serial_api.h"
NYX 0:85b3fd62ea1a 25 #include "platform/NonCopyable.h"
NYX 0:85b3fd62ea1a 26
NYX 0:85b3fd62ea1a 27 namespace mbed {
NYX 0:85b3fd62ea1a 28 /** \addtogroup drivers */
NYX 0:85b3fd62ea1a 29
NYX 0:85b3fd62ea1a 30 /** A serial port (UART) for communication with other serial devices
NYX 0:85b3fd62ea1a 31 * This is a variation of the Serial class that doesn't use streams,
NYX 0:85b3fd62ea1a 32 * thus making it safe to use in interrupt handlers with the RTOS.
NYX 0:85b3fd62ea1a 33 *
NYX 0:85b3fd62ea1a 34 * Can be used for Full Duplex communication, or Simplex by specifying
NYX 0:85b3fd62ea1a 35 * one pin as NC (Not Connected)
NYX 0:85b3fd62ea1a 36 *
NYX 0:85b3fd62ea1a 37 * @note Synchronization level: Not protected
NYX 0:85b3fd62ea1a 38 *
NYX 0:85b3fd62ea1a 39 * Example:
NYX 0:85b3fd62ea1a 40 * @code
NYX 0:85b3fd62ea1a 41 * // Send a char to the PC
NYX 0:85b3fd62ea1a 42 *
NYX 0:85b3fd62ea1a 43 * #include "mbed.h"
NYX 0:85b3fd62ea1a 44 *
NYX 0:85b3fd62ea1a 45 * RawSerial pc(USBTX, USBRX);
NYX 0:85b3fd62ea1a 46 *
NYX 0:85b3fd62ea1a 47 * int main() {
NYX 0:85b3fd62ea1a 48 * pc.putc('A');
NYX 0:85b3fd62ea1a 49 * }
NYX 0:85b3fd62ea1a 50 * @endcode
NYX 0:85b3fd62ea1a 51 * @ingroup drivers
NYX 0:85b3fd62ea1a 52 */
NYX 0:85b3fd62ea1a 53 class RawSerial: public SerialBase, private NonCopyable<RawSerial> {
NYX 0:85b3fd62ea1a 54
NYX 0:85b3fd62ea1a 55 public:
NYX 0:85b3fd62ea1a 56 /** Create a RawSerial port, connected to the specified transmit and receive pins, with the specified baud.
NYX 0:85b3fd62ea1a 57 *
NYX 0:85b3fd62ea1a 58 * @param tx Transmit pin
NYX 0:85b3fd62ea1a 59 * @param rx Receive pin
NYX 0:85b3fd62ea1a 60 * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
NYX 0:85b3fd62ea1a 61 *
NYX 0:85b3fd62ea1a 62 * @note
NYX 0:85b3fd62ea1a 63 * Either tx or rx may be specified as NC if unused
NYX 0:85b3fd62ea1a 64 */
NYX 0:85b3fd62ea1a 65 RawSerial(PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
NYX 0:85b3fd62ea1a 66
NYX 0:85b3fd62ea1a 67 /** Write a char to the serial port
NYX 0:85b3fd62ea1a 68 *
NYX 0:85b3fd62ea1a 69 * @param c The char to write
NYX 0:85b3fd62ea1a 70 *
NYX 0:85b3fd62ea1a 71 * @returns The written char or -1 if an error occured
NYX 0:85b3fd62ea1a 72 */
NYX 0:85b3fd62ea1a 73 int putc(int c);
NYX 0:85b3fd62ea1a 74
NYX 0:85b3fd62ea1a 75 /** Read a char from the serial port
NYX 0:85b3fd62ea1a 76 *
NYX 0:85b3fd62ea1a 77 * @returns The char read from the serial port
NYX 0:85b3fd62ea1a 78 */
NYX 0:85b3fd62ea1a 79 int getc();
NYX 0:85b3fd62ea1a 80
NYX 0:85b3fd62ea1a 81 /** Write a string to the serial port
NYX 0:85b3fd62ea1a 82 *
NYX 0:85b3fd62ea1a 83 * @param str The string to write
NYX 0:85b3fd62ea1a 84 *
NYX 0:85b3fd62ea1a 85 * @returns 0 if the write succeeds, EOF for error
NYX 0:85b3fd62ea1a 86 */
NYX 0:85b3fd62ea1a 87 int puts(const char *str);
NYX 0:85b3fd62ea1a 88
NYX 0:85b3fd62ea1a 89 int printf(const char *format, ...);
NYX 0:85b3fd62ea1a 90
NYX 0:85b3fd62ea1a 91 protected:
NYX 0:85b3fd62ea1a 92
NYX 0:85b3fd62ea1a 93 /* Acquire exclusive access to this serial port
NYX 0:85b3fd62ea1a 94 */
NYX 0:85b3fd62ea1a 95 virtual void lock(void);
NYX 0:85b3fd62ea1a 96
NYX 0:85b3fd62ea1a 97 /* Release exclusive access to this serial port
NYX 0:85b3fd62ea1a 98 */
NYX 0:85b3fd62ea1a 99 virtual void unlock(void);
NYX 0:85b3fd62ea1a 100 };
NYX 0:85b3fd62ea1a 101
NYX 0:85b3fd62ea1a 102 } // namespace mbed
NYX 0:85b3fd62ea1a 103
NYX 0:85b3fd62ea1a 104 #endif
NYX 0:85b3fd62ea1a 105
NYX 0:85b3fd62ea1a 106 #endif