Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/RawSerial.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

UserRevisionLine numberNew contents of line
yihui 0:700cadd8b708 1 /* mbed Microcontroller Library
yihui 0:700cadd8b708 2 * Copyright (c) 2006-2013 ARM Limited
yihui 0:700cadd8b708 3 *
yihui 0:700cadd8b708 4 * Licensed under the Apache License, Version 2.0 (the "License");
yihui 0:700cadd8b708 5 * you may not use this file except in compliance with the License.
yihui 0:700cadd8b708 6 * You may obtain a copy of the License at
yihui 0:700cadd8b708 7 *
yihui 0:700cadd8b708 8 * http://www.apache.org/licenses/LICENSE-2.0
yihui 0:700cadd8b708 9 *
yihui 0:700cadd8b708 10 * Unless required by applicable law or agreed to in writing, software
yihui 0:700cadd8b708 11 * distributed under the License is distributed on an "AS IS" BASIS,
yihui 0:700cadd8b708 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
yihui 0:700cadd8b708 13 * See the License for the specific language governing permissions and
yihui 0:700cadd8b708 14 * limitations under the License.
yihui 0:700cadd8b708 15 */
yihui 0:700cadd8b708 16 #ifndef MBED_RAW_SERIAL_H
yihui 0:700cadd8b708 17 #define MBED_RAW_SERIAL_H
yihui 0:700cadd8b708 18
yihui 0:700cadd8b708 19 #include "platform.h"
yihui 0:700cadd8b708 20
yihui 0:700cadd8b708 21 #if DEVICE_SERIAL
yihui 0:700cadd8b708 22
yihui 0:700cadd8b708 23 #include "SerialBase.h"
yihui 0:700cadd8b708 24 #include "serial_api.h"
yihui 0:700cadd8b708 25
yihui 0:700cadd8b708 26 namespace mbed {
yihui 0:700cadd8b708 27
yihui 0:700cadd8b708 28 /** A serial port (UART) for communication with other serial devices
yihui 0:700cadd8b708 29 * This is a variation of the Serial class that doesn't use streams,
yihui 0:700cadd8b708 30 * thus making it safe to use in interrupt handlers with the RTOS.
yihui 0:700cadd8b708 31 *
yihui 0:700cadd8b708 32 * Can be used for Full Duplex communication, or Simplex by specifying
yihui 0:700cadd8b708 33 * one pin as NC (Not Connected)
yihui 0:700cadd8b708 34 *
yihui 0:700cadd8b708 35 * Example:
yihui 0:700cadd8b708 36 * @code
yihui 0:700cadd8b708 37 * // Send a char to the PC
yihui 0:700cadd8b708 38 *
yihui 0:700cadd8b708 39 * #include "mbed.h"
yihui 0:700cadd8b708 40 *
yihui 0:700cadd8b708 41 * RawSerial pc(USBTX, USBRX);
yihui 0:700cadd8b708 42 *
yihui 0:700cadd8b708 43 * int main() {
yihui 0:700cadd8b708 44 * pc.putc('A');
yihui 0:700cadd8b708 45 * }
yihui 0:700cadd8b708 46 * @endcode
yihui 0:700cadd8b708 47 */
yihui 0:700cadd8b708 48 class RawSerial: public SerialBase {
yihui 0:700cadd8b708 49
yihui 0:700cadd8b708 50 public:
yihui 0:700cadd8b708 51 /** Create a RawSerial port, connected to the specified transmit and receive pins
yihui 0:700cadd8b708 52 *
yihui 0:700cadd8b708 53 * @param tx Transmit pin
yihui 0:700cadd8b708 54 * @param rx Receive pin
yihui 0:700cadd8b708 55 *
yihui 0:700cadd8b708 56 * @note
yihui 0:700cadd8b708 57 * Either tx or rx may be specified as NC if unused
yihui 0:700cadd8b708 58 */
yihui 0:700cadd8b708 59 RawSerial(PinName tx, PinName rx);
yihui 0:700cadd8b708 60
yihui 0:700cadd8b708 61 /** Write a char to the serial port
yihui 0:700cadd8b708 62 *
yihui 0:700cadd8b708 63 * @param c The char to write
yihui 0:700cadd8b708 64 *
yihui 0:700cadd8b708 65 * @returns The written char or -1 if an error occured
yihui 0:700cadd8b708 66 */
yihui 0:700cadd8b708 67 int putc(int c);
yihui 0:700cadd8b708 68
yihui 0:700cadd8b708 69 /** Read a char from the serial port
yihui 0:700cadd8b708 70 *
yihui 0:700cadd8b708 71 * @returns The char read from the serial port
yihui 0:700cadd8b708 72 */
yihui 0:700cadd8b708 73 int getc();
yihui 0:700cadd8b708 74
yihui 0:700cadd8b708 75 /** Write a string to the serial port
yihui 0:700cadd8b708 76 *
yihui 0:700cadd8b708 77 * @param str The string to write
yihui 0:700cadd8b708 78 *
yihui 0:700cadd8b708 79 * @returns 0 if the write succeeds, EOF for error
yihui 0:700cadd8b708 80 */
yihui 0:700cadd8b708 81 int puts(const char *str);
yihui 0:700cadd8b708 82
yihui 0:700cadd8b708 83 int printf(const char *format, ...);
yihui 0:700cadd8b708 84 };
yihui 0:700cadd8b708 85
yihui 0:700cadd8b708 86 } // namespace mbed
yihui 0:700cadd8b708 87
yihui 0:700cadd8b708 88 #endif
yihui 0:700cadd8b708 89
yihui 0:700cadd8b708 90 #endif