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.

Committer:
AnnaBridge
Date:
Fri Sep 15 14:46:57 2017 +0100
Revision:
151:675da3299148
Parent:
146:22da6e220af6
Release 151 of the mbed library.

Who changed what in which revision?

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