Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/RawSerial.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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