David DiCarlo / mbed-src-KL05Z-smart-sensor

Fork of mbed for KL05Z based smart sensor which has no crystal on the board, so MCG FEI mode is required.

Dependents:   smart-sensor-KL05Z-debug

Fork of mbed-src by Ermanno Brusadin

api/Serial.h@0:0a673c671a56, 2016-07-27 (annotated)

Committer:
ebrus
Date:
Wed Jul 27 18:35:32 2016 +0000
Revision:
0:0a673c671a56
4

Who changed what in which revision?

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