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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
165:d1b4690b3f8b
Release 155 of the mbed library.

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