Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

RawSerial.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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