Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/RawSerial.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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