Jasper Lee / mbed_helloworld

change some io settings for TWR-K22F-120M

Dependents:   twr_helloworld

RawSerial.h@0:b16d94660a33, 2014-12-23 (annotated)

Committer:
Jasper_lee
Date:
Tue Dec 23 03:35:08 2014 +0000
Revision:
0:b16d94660a33
change some io setting used in TWR-K22F120M

Who changed what in which revision?

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