1 /* mbed Microcontroller Library
2 * Copyright (c) 2006-2013 ARM Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 #ifndef MBED_RAW_SERIAL_H
17 #define MBED_RAW_SERIAL_H
23 #include "SerialBase.h"
24 #include "serial_api.h"
28 /** A serial port (UART) for communication with other serial devices
29 * This is a variation of the Serial class that doesn't use streams,
30 * thus making it safe to use in interrupt handlers with the RTOS.
32 * Can be used for Full Duplex communication, or Simplex by specifying
33 * one pin as NC (Not Connected)
37 * // Send a char to the PC
41 * RawSerial pc(USBTX, USBRX);
48 class RawSerial: public SerialBase {
51 /** Create a RawSerial port, connected to the specified transmit and receive pins
53 * @param tx Transmit pin
54 * @param rx Receive pin
57 * Either tx or rx may be specified as NC if unused
59 RawSerial(PinName tx, PinName rx);
61 /** Write a char to the serial port
63 * @param c The char to write
65 * @returns The written char or -1 if an error occured
69 /** Read a char from the serial port
71 * @returns The char read from the serial port
75 /** Write a string to the serial port
77 * @param str The string to write
79 * @returns 0 if the write succeeds, EOF for error
81 int puts(const char *str);
83 int printf(const char *format, ...);