DSP Book Yeditepe / mbed_f401re

mbed library sources with internal temperature sensor for nucleo f401

api/RawSerial.h@0:7e2bd16f80af, 2015-01-17 (annotated)

Committer:
elessair
Date:
Sat Jan 17 18:03:58 2015 +0000
Revision:
0:7e2bd16f80af
nucleo f401re internal temperature added

Who changed what in which revision?

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