Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

Serial.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
85:024bf7f99721
Child:
98:8ab26030e058
dgdgr

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 66:9c8f0e3462fb 1 /* mbed Microcontroller Library
bogdanm 66:9c8f0e3462fb 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 66:9c8f0e3462fb 3 *
bogdanm 66:9c8f0e3462fb 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 66:9c8f0e3462fb 5 * you may not use this file except in compliance with the License.
bogdanm 66:9c8f0e3462fb 6 * You may obtain a copy of the License at
bogdanm 66:9c8f0e3462fb 7 *
bogdanm 66:9c8f0e3462fb 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 66:9c8f0e3462fb 9 *
bogdanm 66:9c8f0e3462fb 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 66:9c8f0e3462fb 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 66:9c8f0e3462fb 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 66:9c8f0e3462fb 13 * See the License for the specific language governing permissions and
bogdanm 66:9c8f0e3462fb 14 * limitations under the License.
bogdanm 66:9c8f0e3462fb 15 */
bogdanm 66:9c8f0e3462fb 16 #ifndef MBED_SERIAL_H
bogdanm 66:9c8f0e3462fb 17 #define MBED_SERIAL_H
bogdanm 66:9c8f0e3462fb 18
bogdanm 66:9c8f0e3462fb 19 #include "platform.h"
bogdanm 66:9c8f0e3462fb 20
bogdanm 66:9c8f0e3462fb 21 #if DEVICE_SERIAL
bogdanm 66:9c8f0e3462fb 22
bogdanm 66:9c8f0e3462fb 23 #include "Stream.h"
bogdanm 68:f37f3b9c9f0b 24 #include "SerialBase.h"
bogdanm 66:9c8f0e3462fb 25 #include "serial_api.h"
bogdanm 66:9c8f0e3462fb 26
bogdanm 66:9c8f0e3462fb 27 namespace mbed {
bogdanm 66:9c8f0e3462fb 28
bogdanm 66:9c8f0e3462fb 29 /** A serial port (UART) for communication with other serial devices
bogdanm 66:9c8f0e3462fb 30 *
bogdanm 66:9c8f0e3462fb 31 * Can be used for Full Duplex communication, or Simplex by specifying
bogdanm 66:9c8f0e3462fb 32 * one pin as NC (Not Connected)
bogdanm 66:9c8f0e3462fb 33 *
bogdanm 66:9c8f0e3462fb 34 * Example:
bogdanm 66:9c8f0e3462fb 35 * @code
bogdanm 66:9c8f0e3462fb 36 * // Print "Hello World" to the PC
bogdanm 66:9c8f0e3462fb 37 *
bogdanm 66:9c8f0e3462fb 38 * #include "mbed.h"
bogdanm 66:9c8f0e3462fb 39 *
bogdanm 66:9c8f0e3462fb 40 * Serial pc(USBTX, USBRX);
bogdanm 66:9c8f0e3462fb 41 *
bogdanm 66:9c8f0e3462fb 42 * int main() {
bogdanm 66:9c8f0e3462fb 43 * pc.printf("Hello World\n");
bogdanm 66:9c8f0e3462fb 44 * }
bogdanm 66:9c8f0e3462fb 45 * @endcode
bogdanm 66:9c8f0e3462fb 46 */
bogdanm 68:f37f3b9c9f0b 47 class Serial : public SerialBase, public Stream {
bogdanm 66:9c8f0e3462fb 48
bogdanm 66:9c8f0e3462fb 49 public:
bogdanm 66:9c8f0e3462fb 50 /** Create a Serial port, connected to the specified transmit and receive pins
bogdanm 66:9c8f0e3462fb 51 *
bogdanm 66:9c8f0e3462fb 52 * @param tx Transmit pin
bogdanm 66:9c8f0e3462fb 53 * @param rx Receive pin
bogdanm 66:9c8f0e3462fb 54 *
bogdanm 66:9c8f0e3462fb 55 * @note
bogdanm 66:9c8f0e3462fb 56 * Either tx or rx may be specified as NC if unused
bogdanm 66:9c8f0e3462fb 57 */
bogdanm 66:9c8f0e3462fb 58 Serial(PinName tx, PinName rx, const char *name=NULL);
bogdanm 66:9c8f0e3462fb 59
bogdanm 66:9c8f0e3462fb 60 protected:
bogdanm 66:9c8f0e3462fb 61 virtual int _getc();
bogdanm 85:024bf7f99721 62 virtual int _putc(int c);
bogdanm 66:9c8f0e3462fb 63 };
bogdanm 66:9c8f0e3462fb 64
bogdanm 66:9c8f0e3462fb 65 } // namespace mbed
bogdanm 66:9c8f0e3462fb 66
bogdanm 66:9c8f0e3462fb 67 #endif
bogdanm 66:9c8f0e3462fb 68
bogdanm 66:9c8f0e3462fb 69 #endif