Gan likun / mbed1-dev

001

drivers/RawSerial.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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