Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

Serial.h@21:3944f1e2fa4f, 2010-06-17 (annotated)

Committer:
simon
Date:
Thu Jun 17 16:23:14 2010 +0000
Revision:
21:3944f1e2fa4f
Parent:
20:029aa53d7323
Child:
27:7110ebee3484
* CAN fixes

 * Serial Interrupt

 * I2C low level routines

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - Serial
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 * sford
rolf.meyer@arm.com 11:1c1ebd0324fa 4 */
rolf.meyer@arm.com 11:1c1ebd0324fa 5
rolf.meyer@arm.com 11:1c1ebd0324fa 6 #ifndef MBED_SERIAL_H
rolf.meyer@arm.com 11:1c1ebd0324fa 7 #define MBED_SERIAL_H
rolf.meyer@arm.com 11:1c1ebd0324fa 8
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 11 #include "PeripheralNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 12 #include "Stream.h"
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 13 #include "FunctionPointer.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 14
rolf.meyer@arm.com 11:1c1ebd0324fa 15 namespace mbed {
rolf.meyer@arm.com 11:1c1ebd0324fa 16
rolf.meyer@arm.com 11:1c1ebd0324fa 17 /* Class: Serial
rolf.meyer@arm.com 11:1c1ebd0324fa 18 * A serial port (UART) for communication with other serial devices
rolf.meyer@arm.com 11:1c1ebd0324fa 19 *
rolf.meyer@arm.com 11:1c1ebd0324fa 20 * Example:
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * > // Print "Hello World" to the PC
rolf.meyer@arm.com 11:1c1ebd0324fa 22 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * > #include "mbed.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * > Serial pc(USBTX, USBRX);
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * > int main() {
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * > pc.printf("Hello World\n");
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 30 */
rolf.meyer@arm.com 11:1c1ebd0324fa 31 class Serial : public Stream {
rolf.meyer@arm.com 11:1c1ebd0324fa 32
rolf.meyer@arm.com 11:1c1ebd0324fa 33 public:
rolf.meyer@arm.com 11:1c1ebd0324fa 34
rolf.meyer@arm.com 11:1c1ebd0324fa 35 /* Constructor: Serial
rolf.meyer@arm.com 11:1c1ebd0324fa 36 * Create a Serial port, connected to the specified transmit and receive pins
rolf.meyer@arm.com 11:1c1ebd0324fa 37 *
rolf.meyer@arm.com 11:1c1ebd0324fa 38 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 39 * tx - Transmit pin
rolf.meyer@arm.com 11:1c1ebd0324fa 40 * rx - Receive pin
rolf.meyer@arm.com 11:1c1ebd0324fa 41 *
simon 20:029aa53d7323 42 * Note: Either tx or rx may be specified as NC if unused
rolf.meyer@arm.com 11:1c1ebd0324fa 43 */
rolf.meyer@arm.com 11:1c1ebd0324fa 44 Serial(PinName tx, PinName rx, const char *name = NULL);
rolf.meyer@arm.com 11:1c1ebd0324fa 45
rolf.meyer@arm.com 11:1c1ebd0324fa 46 /* Function: baud
rolf.meyer@arm.com 11:1c1ebd0324fa 47 * Set the baud rate of the serial port
rolf.meyer@arm.com 11:1c1ebd0324fa 48 *
rolf.meyer@arm.com 11:1c1ebd0324fa 49 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 50 * baudrate - The baudrate of the serial port (default = 9600).
rolf.meyer@arm.com 11:1c1ebd0324fa 51 */
rolf.meyer@arm.com 11:1c1ebd0324fa 52 void baud(int baudrate);
rolf.meyer@arm.com 11:1c1ebd0324fa 53
rolf.meyer@arm.com 11:1c1ebd0324fa 54 enum Parity {
rolf.meyer@arm.com 11:1c1ebd0324fa 55 None = 0
rolf.meyer@arm.com 11:1c1ebd0324fa 56 , Odd
rolf.meyer@arm.com 11:1c1ebd0324fa 57 , Even
rolf.meyer@arm.com 11:1c1ebd0324fa 58 , Forced1
rolf.meyer@arm.com 11:1c1ebd0324fa 59 , Forced0
rolf.meyer@arm.com 11:1c1ebd0324fa 60 };
rolf.meyer@arm.com 11:1c1ebd0324fa 61
simon 21:3944f1e2fa4f 62 enum IrqType {
simon 21:3944f1e2fa4f 63 RxIrq = 0
simon 21:3944f1e2fa4f 64 , TxIrq
simon 21:3944f1e2fa4f 65 };
simon 21:3944f1e2fa4f 66
rolf.meyer@arm.com 11:1c1ebd0324fa 67 /* Function: format
rolf.meyer@arm.com 11:1c1ebd0324fa 68 * Set the transmission format used by the Serial port
rolf.meyer@arm.com 11:1c1ebd0324fa 69 *
rolf.meyer@arm.com 11:1c1ebd0324fa 70 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 71 * bits - The number of bits in a word (5-8; default = 8)
rolf.meyer@arm.com 11:1c1ebd0324fa 72 * parity - The parity used (Serial::None, Serial::Odd, Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)
rolf.meyer@arm.com 11:1c1ebd0324fa 73 * stop - The number of stop bits (1 or 2; default = 1)
rolf.meyer@arm.com 11:1c1ebd0324fa 74 */
rolf.meyer@arm.com 11:1c1ebd0324fa 75 void format(int bits = 8, Parity parity = Serial::None, int stop_bits = 1);
rolf.meyer@arm.com 11:1c1ebd0324fa 76
rolf.meyer@arm.com 11:1c1ebd0324fa 77 #if 0 // Inhereted from Stream, for documentation only
rolf.meyer@arm.com 11:1c1ebd0324fa 78
rolf.meyer@arm.com 11:1c1ebd0324fa 79 /* Function: putc
rolf.meyer@arm.com 11:1c1ebd0324fa 80 * Write a character
rolf.meyer@arm.com 11:1c1ebd0324fa 81 *
rolf.meyer@arm.com 11:1c1ebd0324fa 82 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 83 * c - The character to write to the serial port
rolf.meyer@arm.com 11:1c1ebd0324fa 84 */
rolf.meyer@arm.com 11:1c1ebd0324fa 85 int putc(int c);
rolf.meyer@arm.com 11:1c1ebd0324fa 86
rolf.meyer@arm.com 11:1c1ebd0324fa 87 /* Function: getc
rolf.meyer@arm.com 11:1c1ebd0324fa 88 * Read a character
rolf.meyer@arm.com 11:1c1ebd0324fa 89 *
rolf.meyer@arm.com 11:1c1ebd0324fa 90 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 91 * returns - The character read from the serial port
rolf.meyer@arm.com 11:1c1ebd0324fa 92 */
rolf.meyer@arm.com 11:1c1ebd0324fa 93 int getc();
rolf.meyer@arm.com 11:1c1ebd0324fa 94
rolf.meyer@arm.com 11:1c1ebd0324fa 95 /* Function: printf
rolf.meyer@arm.com 11:1c1ebd0324fa 96 * Write a formated string
rolf.meyer@arm.com 11:1c1ebd0324fa 97 *
rolf.meyer@arm.com 11:1c1ebd0324fa 98 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 99 * format - A printf-style format string, followed by the
rolf.meyer@arm.com 11:1c1ebd0324fa 100 * variables to use in formating the string.
rolf.meyer@arm.com 11:1c1ebd0324fa 101 */
rolf.meyer@arm.com 11:1c1ebd0324fa 102 int printf(const char* format, ...);
rolf.meyer@arm.com 11:1c1ebd0324fa 103
rolf.meyer@arm.com 11:1c1ebd0324fa 104 /* Function: scanf
rolf.meyer@arm.com 11:1c1ebd0324fa 105 * Read a formated string
rolf.meyer@arm.com 11:1c1ebd0324fa 106 *
rolf.meyer@arm.com 11:1c1ebd0324fa 107 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 108 * format - A scanf-style format string,
rolf.meyer@arm.com 11:1c1ebd0324fa 109 * followed by the pointers to variables to store the results.
rolf.meyer@arm.com 11:1c1ebd0324fa 110 */
rolf.meyer@arm.com 11:1c1ebd0324fa 111 int scanf(const char* format, ...);
rolf.meyer@arm.com 11:1c1ebd0324fa 112
rolf.meyer@arm.com 11:1c1ebd0324fa 113 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 114
rolf.meyer@arm.com 11:1c1ebd0324fa 115 /* Function: readable
rolf.meyer@arm.com 11:1c1ebd0324fa 116 * Determine if there is a character available to read
rolf.meyer@arm.com 11:1c1ebd0324fa 117 *
rolf.meyer@arm.com 11:1c1ebd0324fa 118 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 119 * returns - 1 if there is a character available to read, else 0
rolf.meyer@arm.com 11:1c1ebd0324fa 120 */
rolf.meyer@arm.com 11:1c1ebd0324fa 121 int readable();
rolf.meyer@arm.com 11:1c1ebd0324fa 122
rolf.meyer@arm.com 11:1c1ebd0324fa 123 /* Function: writeable
rolf.meyer@arm.com 11:1c1ebd0324fa 124 * Determine if there is space available to write a character
rolf.meyer@arm.com 11:1c1ebd0324fa 125 *
rolf.meyer@arm.com 11:1c1ebd0324fa 126 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 127 * returns - 1 if there is space to write a character, else 0
rolf.meyer@arm.com 11:1c1ebd0324fa 128 */
rolf.meyer@arm.com 11:1c1ebd0324fa 129 int writeable();
rolf.meyer@arm.com 11:1c1ebd0324fa 130
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 131 /* Function: attach
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 132 * Attach a function to call whenever a serial interrupt is generated
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 133 *
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 134 * Variables:
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 135 * fptr - A pointer to a void function, or 0 to set as none
simon 21:3944f1e2fa4f 136 * type - Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 137 */
simon 21:3944f1e2fa4f 138 void attach(void (*fptr)(void), IrqType type = RxIrq);
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 139
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 140 /* Function: attach
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 141 * Attach a member function to call whenever a serial interrupt is generated
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 142 *
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 143 * Variables:
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 144 * tptr - pointer to the object to call the member function on
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 145 * mptr - pointer to the member function to be called
simon 21:3944f1e2fa4f 146 * type - Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 147 */
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 148 template<typename T>
simon 21:3944f1e2fa4f 149 void attach(T* tptr, void (T::*mptr)(void), IrqType type = RxIrq) {
simon 21:3944f1e2fa4f 150 if((mptr != NULL) && (tptr != NULL)) {
simon 21:3944f1e2fa4f 151 _irq[type].attach(tptr, mptr);
simon 21:3944f1e2fa4f 152 setup_interrupt(type);
simon 21:3944f1e2fa4f 153 }
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 154 }
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 155
rolf.meyer@arm.com 11:1c1ebd0324fa 156 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 157 virtual const struct rpc_method *get_rpc_methods();
rolf.meyer@arm.com 11:1c1ebd0324fa 158 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 159 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 160
rolf.meyer@arm.com 11:1c1ebd0324fa 161 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 162
simon 21:3944f1e2fa4f 163 void setup_interrupt(IrqType type);
simon 21:3944f1e2fa4f 164 void remove_interrupt(IrqType type);
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 165
rolf.meyer@arm.com 11:1c1ebd0324fa 166 virtual int _getc();
rolf.meyer@arm.com 11:1c1ebd0324fa 167 virtual int _putc(int c);
rolf.meyer@arm.com 11:1c1ebd0324fa 168
rolf.meyer@arm.com 11:1c1ebd0324fa 169 UARTName _uart;
simon 21:3944f1e2fa4f 170 FunctionPointer _irq[2];
simon 21:3944f1e2fa4f 171 int _uidx;
rolf.meyer@arm.com 11:1c1ebd0324fa 172
rolf.meyer@arm.com 11:1c1ebd0324fa 173 };
rolf.meyer@arm.com 11:1c1ebd0324fa 174
rolf.meyer@arm.com 11:1c1ebd0324fa 175 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 176
rolf.meyer@arm.com 11:1c1ebd0324fa 177 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 178