Sergey Solodunov / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/RawSerial.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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