Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/Serial.h@57:dd901dec6bd0, 2016-01-30 (annotated)

Committer:
Splith
Date:
Sat Jan 30 16:48:54 2016 +0000
Revision:
57:dd901dec6bd0
Parent:
0:9b334a45a8ff 
Add USART3 pin mapping to Seeed arch max

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