Ermanno Brusadin / mbed

mbed library sources

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

api/Serial.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_SERIAL_H
ebrus 0:6bc4ac881c8e 17 #define MBED_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 "Stream.h"
ebrus 0:6bc4ac881c8e 24 #include "SerialBase.h"
ebrus 0:6bc4ac881c8e 25 #include "serial_api.h"
ebrus 0:6bc4ac881c8e 26
ebrus 0:6bc4ac881c8e 27 namespace mbed {
ebrus 0:6bc4ac881c8e 28
ebrus 0:6bc4ac881c8e 29 /** A serial port (UART) for communication with other serial devices
ebrus 0:6bc4ac881c8e 30 *
ebrus 0:6bc4ac881c8e 31 * Can be used for Full Duplex communication, or Simplex by specifying
ebrus 0:6bc4ac881c8e 32 * one pin as NC (Not Connected)
ebrus 0:6bc4ac881c8e 33 *
ebrus 0:6bc4ac881c8e 34 * Example:
ebrus 0:6bc4ac881c8e 35 * @code
ebrus 0:6bc4ac881c8e 36 * // Print "Hello World" to the PC
ebrus 0:6bc4ac881c8e 37 *
ebrus 0:6bc4ac881c8e 38 * #include "mbed.h"
ebrus 0:6bc4ac881c8e 39 *
ebrus 0:6bc4ac881c8e 40 * Serial pc(USBTX, USBRX);
ebrus 0:6bc4ac881c8e 41 *
ebrus 0:6bc4ac881c8e 42 * int main() {
ebrus 0:6bc4ac881c8e 43 * pc.printf("Hello World\n");
ebrus 0:6bc4ac881c8e 44 * }
ebrus 0:6bc4ac881c8e 45 * @endcode
ebrus 0:6bc4ac881c8e 46 */
ebrus 0:6bc4ac881c8e 47 class Serial : public SerialBase, public Stream {
ebrus 0:6bc4ac881c8e 48
ebrus 0:6bc4ac881c8e 49 public:
ebrus 0:6bc4ac881c8e 50 /** Create a Serial port, connected to the specified transmit and receive pins
ebrus 0:6bc4ac881c8e 51 *
ebrus 0:6bc4ac881c8e 52 * @param tx Transmit pin
ebrus 0:6bc4ac881c8e 53 * @param rx Receive pin
ebrus 0:6bc4ac881c8e 54 *
ebrus 0:6bc4ac881c8e 55 * @note
ebrus 0:6bc4ac881c8e 56 * Either tx or rx may be specified as NC if unused
ebrus 0:6bc4ac881c8e 57 */
ebrus 0:6bc4ac881c8e 58 Serial(PinName tx, PinName rx, const char *name=NULL);
ebrus 0:6bc4ac881c8e 59
ebrus 0:6bc4ac881c8e 60 protected:
ebrus 0:6bc4ac881c8e 61 virtual int _getc();
ebrus 0:6bc4ac881c8e 62 virtual int _putc(int c);
ebrus 0:6bc4ac881c8e 63 };
ebrus 0:6bc4ac881c8e 64
ebrus 0:6bc4ac881c8e 65 } // namespace mbed
ebrus 0:6bc4ac881c8e 66
ebrus 0:6bc4ac881c8e 67 #endif
ebrus 0:6bc4ac881c8e 68
ebrus 0:6bc4ac881c8e 69 #endif