Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/RawSerial.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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