ju Lei / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

Serial.h@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 59:0883845fe643 4 * Licensed under the Apache License, Version 2.0 (the "License");
emilmont 59:0883845fe643 5 * you may not use this file except in compliance with the License.
emilmont 59:0883845fe643 6 * You may obtain a copy of the License at
emilmont 59:0883845fe643 7 *
emilmont 59:0883845fe643 8 * http://www.apache.org/licenses/LICENSE-2.0
emilmont 44:24d45a770a51 9 *
emilmont 59:0883845fe643 10 * Unless required by applicable law or agreed to in writing, software
emilmont 59:0883845fe643 11 * distributed under the License is distributed on an "AS IS" BASIS,
emilmont 59:0883845fe643 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
emilmont 59:0883845fe643 13 * See the License for the specific language governing permissions and
emilmont 59:0883845fe643 14 * limitations under the License.
emilmont 44:24d45a770a51 15 */
emilmont 44:24d45a770a51 16 #ifndef MBED_SERIAL_H
emilmont 44:24d45a770a51 17 #define MBED_SERIAL_H
emilmont 44:24d45a770a51 18
emilmont 44:24d45a770a51 19 #include "platform.h"
emilmont 44:24d45a770a51 20
emilmont 44:24d45a770a51 21 #if DEVICE_SERIAL
emilmont 44:24d45a770a51 22
emilmont 44:24d45a770a51 23 #include "Stream.h"
emilmont 44:24d45a770a51 24 #include "FunctionPointer.h"
emilmont 44:24d45a770a51 25 #include "serial_api.h"
emilmont 44:24d45a770a51 26
emilmont 44:24d45a770a51 27 namespace mbed {
emilmont 44:24d45a770a51 28
emilmont 44:24d45a770a51 29 /** A serial port (UART) for communication with other serial devices
emilmont 44:24d45a770a51 30 *
emilmont 55:d722ed6a4237 31 * Can be used for Full Duplex communication, or Simplex by specifying
emilmont 44:24d45a770a51 32 * one pin as NC (Not Connected)
emilmont 44:24d45a770a51 33 *
emilmont 44:24d45a770a51 34 * Example:
emilmont 44:24d45a770a51 35 * @code
emilmont 44:24d45a770a51 36 * // Print "Hello World" to the PC
emilmont 44:24d45a770a51 37 *
emilmont 44:24d45a770a51 38 * #include "mbed.h"
emilmont 44:24d45a770a51 39 *
emilmont 44:24d45a770a51 40 * Serial pc(USBTX, USBRX);
emilmont 44:24d45a770a51 41 *
emilmont 44:24d45a770a51 42 * int main() {
emilmont 44:24d45a770a51 43 * pc.printf("Hello World\n");
emilmont 44:24d45a770a51 44 * }
emilmont 44:24d45a770a51 45 * @endcode
emilmont 44:24d45a770a51 46 */
emilmont 44:24d45a770a51 47 class Serial : public Stream {
emilmont 44:24d45a770a51 48
emilmont 44:24d45a770a51 49 public:
emilmont 44:24d45a770a51 50 /** Create a Serial port, connected to the specified transmit and receive pins
emilmont 44:24d45a770a51 51 *
emilmont 55:d722ed6a4237 52 * @param tx Transmit pin
emilmont 44:24d45a770a51 53 * @param rx Receive pin
emilmont 44:24d45a770a51 54 *
emilmont 44:24d45a770a51 55 * @note
emilmont 44:24d45a770a51 56 * Either tx or rx may be specified as NC if unused
emilmont 44:24d45a770a51 57 */
emilmont 54:71b101360fb9 58 Serial(PinName tx, PinName rx, const char *name=NULL);
emilmont 55:d722ed6a4237 59
emilmont 44:24d45a770a51 60 /** Set the baud rate of the serial port
emilmont 55:d722ed6a4237 61 *
emilmont 44:24d45a770a51 62 * @param baudrate The baudrate of the serial port (default = 9600).
emilmont 44:24d45a770a51 63 */
emilmont 54:71b101360fb9 64 void baud(int baudrate);
emilmont 55:d722ed6a4237 65
emilmont 51:a076018f59af 66 enum Parity {
emilmont 51:a076018f59af 67 None = 0,
emilmont 51:a076018f59af 68 Odd,
emilmont 51:a076018f59af 69 Even,
emilmont 51:a076018f59af 70 Forced1,
emilmont 51:a076018f59af 71 Forced0
emilmont 51:a076018f59af 72 };
emilmont 55:d722ed6a4237 73
emilmont 51:a076018f59af 74 enum IrqType {
emilmont 51:a076018f59af 75 RxIrq = 0,
emilmont 51:a076018f59af 76 TxIrq
emilmont 51:a076018f59af 77 };
emilmont 44:24d45a770a51 78
emilmont 44:24d45a770a51 79 /** Set the transmission format used by the Serial port
emilmont 44:24d45a770a51 80 *
emilmont 44:24d45a770a51 81 * @param bits The number of bits in a word (5-8; default = 8)
emilmont 44:24d45a770a51 82 * @param parity The parity used (Serial::None, Serial::Odd, Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)
emilmont 44:24d45a770a51 83 * @param stop The number of stop bits (1 or 2; default = 1)
emilmont 44:24d45a770a51 84 */
emilmont 54:71b101360fb9 85 void format(int bits = 8, Parity parity=Serial::None, int stop_bits=1);
emilmont 55:d722ed6a4237 86
emilmont 44:24d45a770a51 87 /** Determine if there is a character available to read
emilmont 44:24d45a770a51 88 *
emilmont 44:24d45a770a51 89 * @returns
emilmont 44:24d45a770a51 90 * 1 if there is a character available to read,
emilmont 44:24d45a770a51 91 * 0 otherwise
emilmont 44:24d45a770a51 92 */
emilmont 54:71b101360fb9 93 int readable();
emilmont 55:d722ed6a4237 94
emilmont 44:24d45a770a51 95 /** Determine if there is space available to write a character
emilmont 55:d722ed6a4237 96 *
emilmont 44:24d45a770a51 97 * @returns
emilmont 44:24d45a770a51 98 * 1 if there is space to write a character,
emilmont 44:24d45a770a51 99 * 0 otherwise
emilmont 44:24d45a770a51 100 */
emilmont 54:71b101360fb9 101 int writeable();
emilmont 55:d722ed6a4237 102
emilmont 44:24d45a770a51 103 /** Attach a function to call whenever a serial interrupt is generated
emilmont 44:24d45a770a51 104 *
emilmont 44:24d45a770a51 105 * @param fptr A pointer to a void function, or 0 to set as none
emilmont 44:24d45a770a51 106 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
emilmont 44:24d45a770a51 107 */
emilmont 54:71b101360fb9 108 void attach(void (*fptr)(void), IrqType type=RxIrq);
emilmont 55:d722ed6a4237 109
emilmont 44:24d45a770a51 110 /** Attach a member function to call whenever a serial interrupt is generated
emilmont 55:d722ed6a4237 111 *
emilmont 44:24d45a770a51 112 * @param tptr pointer to the object to call the member function on
emilmont 44:24d45a770a51 113 * @param mptr pointer to the member function to be called
emilmont 44:24d45a770a51 114 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
emilmont 44:24d45a770a51 115 */
emilmont 44:24d45a770a51 116 template<typename T>
emilmont 51:a076018f59af 117 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
emilmont 44:24d45a770a51 118 if((mptr != NULL) && (tptr != NULL)) {
emilmont 44:24d45a770a51 119 _irq[type].attach(tptr, mptr);
emilmont 51:a076018f59af 120 serial_irq_set(&_serial, (SerialIrq)type, 1);
emilmont 44:24d45a770a51 121 }
emilmont 44:24d45a770a51 122 }
emilmont 55:d722ed6a4237 123
emilmont 54:71b101360fb9 124 static void _irq_handler(uint32_t id, SerialIrq irq_type);
emilmont 44:24d45a770a51 125
emilmont 44:24d45a770a51 126 protected:
emilmont 54:71b101360fb9 127 virtual int _getc();
emilmont 54:71b101360fb9 128 virtual int _putc(int c);
emilmont 55:d722ed6a4237 129
emilmont 54:71b101360fb9 130 serial_t _serial;
emilmont 44:24d45a770a51 131 FunctionPointer _irq[2];
emilmont 44:24d45a770a51 132 };
emilmont 44:24d45a770a51 133
emilmont 44:24d45a770a51 134 } // namespace mbed
emilmont 44:24d45a770a51 135
emilmont 44:24d45a770a51 136 #endif
emilmont 44:24d45a770a51 137
emilmont 44:24d45a770a51 138 #endif