Greg Steiert / maxim_dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   sensomed

drivers/RawSerial.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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