mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/RawSerial.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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