R L / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/Serial.h@636:21ce76d41a4f, 2016-02-21 (annotated)

Committer:
rllamado
Date:
Sun Feb 21 07:27:08 2016 +0000
Revision:
636:21ce76d41a4f
Parent:
525:c320967f86b9 
something

Who changed what in which revision?

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