jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

Serial.h@54:71b101360fb9, 2013-01-08 (annotated)

Committer:
emilmont
Date:
Tue Jan 08 12:46:36 2013 +0000
Revision:
54:71b101360fb9
Parent:
51:a076018f59af
Child:
55:d722ed6a4237
Support "stream as file" use case

Unify binary libraries

Update copyright

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 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
emilmont 44:24d45a770a51 22 #ifndef MBED_SERIAL_H
emilmont 44:24d45a770a51 23 #define MBED_SERIAL_H
emilmont 44:24d45a770a51 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 44:24d45a770a51 26
emilmont 44:24d45a770a51 27 #if DEVICE_SERIAL
emilmont 44:24d45a770a51 28
emilmont 44:24d45a770a51 29 #include "Stream.h"
emilmont 44:24d45a770a51 30 #include "FunctionPointer.h"
emilmont 44:24d45a770a51 31 #include "serial_api.h"
emilmont 44:24d45a770a51 32
emilmont 44:24d45a770a51 33 namespace mbed {
emilmont 44:24d45a770a51 34
emilmont 44:24d45a770a51 35 /** A serial port (UART) for communication with other serial devices
emilmont 44:24d45a770a51 36 *
emilmont 44:24d45a770a51 37 * Can be used for Full Duplex communication, or Simplex by specifying
emilmont 44:24d45a770a51 38 * one pin as NC (Not Connected)
emilmont 44:24d45a770a51 39 *
emilmont 44:24d45a770a51 40 * Example:
emilmont 44:24d45a770a51 41 * @code
emilmont 44:24d45a770a51 42 * // Print "Hello World" to the PC
emilmont 44:24d45a770a51 43 *
emilmont 44:24d45a770a51 44 * #include "mbed.h"
emilmont 44:24d45a770a51 45 *
emilmont 44:24d45a770a51 46 * Serial pc(USBTX, USBRX);
emilmont 44:24d45a770a51 47 *
emilmont 44:24d45a770a51 48 * int main() {
emilmont 44:24d45a770a51 49 * pc.printf("Hello World\n");
emilmont 44:24d45a770a51 50 * }
emilmont 44:24d45a770a51 51 * @endcode
emilmont 44:24d45a770a51 52 */
emilmont 44:24d45a770a51 53 class Serial : public Stream {
emilmont 44:24d45a770a51 54
emilmont 44:24d45a770a51 55 public:
emilmont 44:24d45a770a51 56 /** Create a Serial port, connected to the specified transmit and receive pins
emilmont 44:24d45a770a51 57 *
emilmont 44:24d45a770a51 58 * @param tx Transmit pin
emilmont 44:24d45a770a51 59 * @param rx Receive pin
emilmont 44:24d45a770a51 60 *
emilmont 44:24d45a770a51 61 * @note
emilmont 44:24d45a770a51 62 * Either tx or rx may be specified as NC if unused
emilmont 44:24d45a770a51 63 */
emilmont 54:71b101360fb9 64 Serial(PinName tx, PinName rx, const char *name=NULL);
emilmont 54:71b101360fb9 65
emilmont 44:24d45a770a51 66 /** Set the baud rate of the serial port
emilmont 44:24d45a770a51 67 *
emilmont 44:24d45a770a51 68 * @param baudrate The baudrate of the serial port (default = 9600).
emilmont 44:24d45a770a51 69 */
emilmont 54:71b101360fb9 70 void baud(int baudrate);
emilmont 51:a076018f59af 71
emilmont 51:a076018f59af 72 enum Parity {
emilmont 51:a076018f59af 73 None = 0,
emilmont 51:a076018f59af 74 Odd,
emilmont 51:a076018f59af 75 Even,
emilmont 51:a076018f59af 76 Forced1,
emilmont 51:a076018f59af 77 Forced0
emilmont 51:a076018f59af 78 };
emilmont 51:a076018f59af 79
emilmont 51:a076018f59af 80 enum IrqType {
emilmont 51:a076018f59af 81 RxIrq = 0,
emilmont 51:a076018f59af 82 TxIrq
emilmont 51:a076018f59af 83 };
emilmont 44:24d45a770a51 84
emilmont 44:24d45a770a51 85 /** Set the transmission format used by the Serial port
emilmont 44:24d45a770a51 86 *
emilmont 44:24d45a770a51 87 * @param bits The number of bits in a word (5-8; default = 8)
emilmont 44:24d45a770a51 88 * @param parity The parity used (Serial::None, Serial::Odd, Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)
emilmont 44:24d45a770a51 89 * @param stop The number of stop bits (1 or 2; default = 1)
emilmont 44:24d45a770a51 90 */
emilmont 54:71b101360fb9 91 void format(int bits = 8, Parity parity=Serial::None, int stop_bits=1);
emilmont 54:71b101360fb9 92
emilmont 44:24d45a770a51 93 /** Determine if there is a character available to read
emilmont 44:24d45a770a51 94 *
emilmont 44:24d45a770a51 95 * @returns
emilmont 44:24d45a770a51 96 * 1 if there is a character available to read,
emilmont 44:24d45a770a51 97 * 0 otherwise
emilmont 44:24d45a770a51 98 */
emilmont 54:71b101360fb9 99 int readable();
emilmont 54:71b101360fb9 100
emilmont 44:24d45a770a51 101 /** Determine if there is space available to write a character
emilmont 44:24d45a770a51 102 *
emilmont 44:24d45a770a51 103 * @returns
emilmont 44:24d45a770a51 104 * 1 if there is space to write a character,
emilmont 44:24d45a770a51 105 * 0 otherwise
emilmont 44:24d45a770a51 106 */
emilmont 54:71b101360fb9 107 int writeable();
emilmont 54:71b101360fb9 108
emilmont 44:24d45a770a51 109 /** Attach a function to call whenever a serial interrupt is generated
emilmont 44:24d45a770a51 110 *
emilmont 44:24d45a770a51 111 * @param fptr A pointer to a void function, or 0 to set as none
emilmont 44:24d45a770a51 112 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
emilmont 44:24d45a770a51 113 */
emilmont 54:71b101360fb9 114 void attach(void (*fptr)(void), IrqType type=RxIrq);
emilmont 54:71b101360fb9 115
emilmont 44:24d45a770a51 116 /** Attach a member function to call whenever a serial interrupt is generated
emilmont 44:24d45a770a51 117 *
emilmont 44:24d45a770a51 118 * @param tptr pointer to the object to call the member function on
emilmont 44:24d45a770a51 119 * @param mptr pointer to the member function to be called
emilmont 44:24d45a770a51 120 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
emilmont 44:24d45a770a51 121 */
emilmont 44:24d45a770a51 122 template<typename T>
emilmont 51:a076018f59af 123 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
emilmont 44:24d45a770a51 124 if((mptr != NULL) && (tptr != NULL)) {
emilmont 44:24d45a770a51 125 _irq[type].attach(tptr, mptr);
emilmont 51:a076018f59af 126 serial_irq_set(&_serial, (SerialIrq)type, 1);
emilmont 44:24d45a770a51 127 }
emilmont 44:24d45a770a51 128 }
emilmont 44:24d45a770a51 129
emilmont 54:71b101360fb9 130 static void _irq_handler(uint32_t id, SerialIrq irq_type);
emilmont 44:24d45a770a51 131
emilmont 44:24d45a770a51 132 protected:
emilmont 54:71b101360fb9 133 virtual int _getc();
emilmont 54:71b101360fb9 134 virtual int _putc(int c);
emilmont 44:24d45a770a51 135
emilmont 54:71b101360fb9 136 serial_t _serial;
emilmont 44:24d45a770a51 137 FunctionPointer _irq[2];
emilmont 44:24d45a770a51 138 };
emilmont 44:24d45a770a51 139
emilmont 44:24d45a770a51 140 } // namespace mbed
emilmont 44:24d45a770a51 141
emilmont 44:24d45a770a51 142 #endif
emilmont 44:24d45a770a51 143
emilmont 44:24d45a770a51 144 #endif