Lancaster University / mbed-lite-test

test

Serial.h@1:a7c51b5e0534, 2016-04-07 (annotated)

Committer:
jamesadevine
Date:
Thu Apr 07 17:50:29 2016 +0000
Revision:
1:a7c51b5e0534
Parent:
0:e1a608bb55e8 
Added correct nrf51.h ; Added scatter file.

Who changed what in which revision?

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