Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/RawSerial.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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