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@15:d1a9de3f4fe0, 2009-11-16 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Mon Nov 16 17:23:08 2009 +0000
Revision:
15:d1a9de3f4fe0
Parent:
11:1c1ebd0324fa
Child:
20:029aa53d7323
* Update Serial to support primitive interrupt event

 * Update some CMSIS-level interrupt functions

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 *
rolf.meyer@arm.com 11:1c1ebd0324fa 42 * Note: Either tx or rx may be specified as NOT_CONNECTED 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
rolf.meyer@arm.com 11:1c1ebd0324fa 62 /* Function: format
rolf.meyer@arm.com 11:1c1ebd0324fa 63 * Set the transmission format used by the Serial port
rolf.meyer@arm.com 11:1c1ebd0324fa 64 *
rolf.meyer@arm.com 11:1c1ebd0324fa 65 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 66 * bits - The number of bits in a word (5-8; default = 8)
rolf.meyer@arm.com 11:1c1ebd0324fa 67 * parity - The parity used (Serial::None, Serial::Odd, Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)
rolf.meyer@arm.com 11:1c1ebd0324fa 68 * stop - The number of stop bits (1 or 2; default = 1)
rolf.meyer@arm.com 11:1c1ebd0324fa 69 */
rolf.meyer@arm.com 11:1c1ebd0324fa 70 void format(int bits = 8, Parity parity = Serial::None, int stop_bits = 1);
rolf.meyer@arm.com 11:1c1ebd0324fa 71
rolf.meyer@arm.com 11:1c1ebd0324fa 72 #if 0 // Inhereted from Stream, for documentation only
rolf.meyer@arm.com 11:1c1ebd0324fa 73
rolf.meyer@arm.com 11:1c1ebd0324fa 74 /* Function: putc
rolf.meyer@arm.com 11:1c1ebd0324fa 75 * Write a character
rolf.meyer@arm.com 11:1c1ebd0324fa 76 *
rolf.meyer@arm.com 11:1c1ebd0324fa 77 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 78 * c - The character to write to the serial port
rolf.meyer@arm.com 11:1c1ebd0324fa 79 */
rolf.meyer@arm.com 11:1c1ebd0324fa 80 int putc(int c);
rolf.meyer@arm.com 11:1c1ebd0324fa 81
rolf.meyer@arm.com 11:1c1ebd0324fa 82 /* Function: getc
rolf.meyer@arm.com 11:1c1ebd0324fa 83 * Read a character
rolf.meyer@arm.com 11:1c1ebd0324fa 84 *
rolf.meyer@arm.com 11:1c1ebd0324fa 85 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 86 * returns - The character read from the serial port
rolf.meyer@arm.com 11:1c1ebd0324fa 87 */
rolf.meyer@arm.com 11:1c1ebd0324fa 88 int getc();
rolf.meyer@arm.com 11:1c1ebd0324fa 89
rolf.meyer@arm.com 11:1c1ebd0324fa 90 /* Function: printf
rolf.meyer@arm.com 11:1c1ebd0324fa 91 * Write a formated string
rolf.meyer@arm.com 11:1c1ebd0324fa 92 *
rolf.meyer@arm.com 11:1c1ebd0324fa 93 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 94 * format - A printf-style format string, followed by the
rolf.meyer@arm.com 11:1c1ebd0324fa 95 * variables to use in formating the string.
rolf.meyer@arm.com 11:1c1ebd0324fa 96 */
rolf.meyer@arm.com 11:1c1ebd0324fa 97 int printf(const char* format, ...);
rolf.meyer@arm.com 11:1c1ebd0324fa 98
rolf.meyer@arm.com 11:1c1ebd0324fa 99 /* Function: scanf
rolf.meyer@arm.com 11:1c1ebd0324fa 100 * Read a formated string
rolf.meyer@arm.com 11:1c1ebd0324fa 101 *
rolf.meyer@arm.com 11:1c1ebd0324fa 102 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 103 * format - A scanf-style format string,
rolf.meyer@arm.com 11:1c1ebd0324fa 104 * followed by the pointers to variables to store the results.
rolf.meyer@arm.com 11:1c1ebd0324fa 105 */
rolf.meyer@arm.com 11:1c1ebd0324fa 106 int scanf(const char* format, ...);
rolf.meyer@arm.com 11:1c1ebd0324fa 107
rolf.meyer@arm.com 11:1c1ebd0324fa 108 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 109
rolf.meyer@arm.com 11:1c1ebd0324fa 110 /* Function: readable
rolf.meyer@arm.com 11:1c1ebd0324fa 111 * Determine if there is a character available to read
rolf.meyer@arm.com 11:1c1ebd0324fa 112 *
rolf.meyer@arm.com 11:1c1ebd0324fa 113 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 114 * returns - 1 if there is a character available to read, else 0
rolf.meyer@arm.com 11:1c1ebd0324fa 115 */
rolf.meyer@arm.com 11:1c1ebd0324fa 116 int readable();
rolf.meyer@arm.com 11:1c1ebd0324fa 117
rolf.meyer@arm.com 11:1c1ebd0324fa 118 /* Function: writeable
rolf.meyer@arm.com 11:1c1ebd0324fa 119 * Determine if there is space available to write a character
rolf.meyer@arm.com 11:1c1ebd0324fa 120 *
rolf.meyer@arm.com 11:1c1ebd0324fa 121 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 122 * returns - 1 if there is space to write a character, else 0
rolf.meyer@arm.com 11:1c1ebd0324fa 123 */
rolf.meyer@arm.com 11:1c1ebd0324fa 124 int writeable();
rolf.meyer@arm.com 11:1c1ebd0324fa 125
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 126 /* Function: attach
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 127 * Attach a function to call whenever a serial interrupt is generated
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 128 *
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 129 * Variables:
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 130 * fptr - A pointer to a void function, or 0 to set as none
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 131 */
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 132 void attach(void (*fptr)(void));
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 133
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 134 /* Function: attach
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 135 * Attach a member function to call whenever a serial interrupt is generated
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 136 *
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 137 * Variables:
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 138 * tptr - pointer to the object to call the member function on
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 139 * mptr - pointer to the member function to be called
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 140 */
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 141 template<typename T>
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 142 void attach(T* tptr, void (T::*mptr)(void)) {
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 143 _irq.attach(tptr, mptr);
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 144 setup_interrupt();
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 145 }
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 146
rolf.meyer@arm.com 11:1c1ebd0324fa 147 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 148 virtual const struct rpc_method *get_rpc_methods();
rolf.meyer@arm.com 11:1c1ebd0324fa 149 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 150 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 151
rolf.meyer@arm.com 11:1c1ebd0324fa 152 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 153
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 154 void setup_interrupt();
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 155 void remove_interrupt();
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 156
rolf.meyer@arm.com 11:1c1ebd0324fa 157 virtual int _getc();
rolf.meyer@arm.com 11:1c1ebd0324fa 158 virtual int _putc(int c);
rolf.meyer@arm.com 11:1c1ebd0324fa 159
rolf.meyer@arm.com 11:1c1ebd0324fa 160 UARTName _uart;
simon.ford@mbed.co.uk 15:d1a9de3f4fe0 161 FunctionPointer _irq;
rolf.meyer@arm.com 11:1c1ebd0324fa 162
rolf.meyer@arm.com 11:1c1ebd0324fa 163 };
rolf.meyer@arm.com 11:1c1ebd0324fa 164
rolf.meyer@arm.com 11:1c1ebd0324fa 165 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 166
rolf.meyer@arm.com 11:1c1ebd0324fa 167 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 168