Jhon Plantikow / Dataloger

Dataloger

RawSerial.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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