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