Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

Serial.h@2:e9a661555b58, 2012-10-10 (annotated)

Committer:
emilmont
Date:
Wed Oct 10 14:14:12 2012 +0000
Revision:
2:e9a661555b58
Parent:
0:8024c367e29f
Child:
7:73c5efe92a6c
Add PWM and I2C implementation;

Who changed what in which revision?

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