Vladimir Vana / mbed

pro vyuku PSS v Jecne

RawSerial.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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