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

SerialHalfDuplex.h@20:029aa53d7323, 2010-06-03 (annotated)

Committer:
simon
Date:
Thu Jun 03 11:17:50 2010 +0000
Revision:
20:029aa53d7323
Child:
27:7110ebee3484
* Add SPISlave, SPIHalfDuplex, SerialHalfDuplex

 * Add I2C repeated start

 * Add ethernet set_link()

 * Add documentation for wait()

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon 20:029aa53d7323 1 /* mbed Microcontroller Library - SerialHalfDuplex
simon 20:029aa53d7323 2 * Copyright (c) 2010 ARM Limited. All rights reserved.
simon 20:029aa53d7323 3 * jward
simon 20:029aa53d7323 4 */
simon 20:029aa53d7323 5
simon 20:029aa53d7323 6 #ifndef MBED_SERIALHALFDUPLEX_H
simon 20:029aa53d7323 7 #define MBED_SERIALHALFDUPLEX_H
simon 20:029aa53d7323 8
simon 20:029aa53d7323 9 #include "Serial.h"
simon 20:029aa53d7323 10 #include "PinNames.h"
simon 20:029aa53d7323 11 #include "PeripheralNames.h"
simon 20:029aa53d7323 12
simon 20:029aa53d7323 13 namespace mbed {
simon 20:029aa53d7323 14
simon 20:029aa53d7323 15 /* Class: SerialHalfDuplex
simon 20:029aa53d7323 16 * A serial port (UART) for communication with other devices, with a single
simon 20:029aa53d7323 17 * shared transmit and receive line.
simon 20:029aa53d7323 18 *
simon 20:029aa53d7323 19 * If the device both transmits and receives, then both (separate) pins need
simon 20:029aa53d7323 20 * to be defined, and tied together externally.
simon 20:029aa53d7323 21 *
simon 20:029aa53d7323 22 * Example:
simon 20:029aa53d7323 23 * > // Send a byte as a master, and receive a byte as a slave
simon 20:029aa53d7323 24 * >
simon 20:029aa53d7323 25 * > #include "mbed.h"
simon 20:029aa53d7323 26 * >
simon 20:029aa53d7323 27 * > SerialHalfDuplex master(p9, p10);
simon 20:029aa53d7323 28 * >
simon 20:029aa53d7323 29 * > int main() {
simon 20:029aa53d7323 30 * > int outbyte = master.putc(0x55);
simon 20:029aa53d7323 31 * > int retbyte = master.getc();
simon 20:029aa53d7323 32 * > printf("Wrote: %02X Read: %02X\n", outbyte, retbyte);
simon 20:029aa53d7323 33 * > }
simon 20:029aa53d7323 34 */
simon 20:029aa53d7323 35 class SerialHalfDuplex : public Serial {
simon 20:029aa53d7323 36
simon 20:029aa53d7323 37 public:
simon 20:029aa53d7323 38 /* Constructor: SerialHalfDuplex
simon 20:029aa53d7323 39 * Create a half-duplex serial port, connected to the specified transmit
simon 20:029aa53d7323 40 * and receive pins.
simon 20:029aa53d7323 41 *
simon 20:029aa53d7323 42 * Variables:
simon 20:029aa53d7323 43 * tx - Transmit pin
simon 20:029aa53d7323 44 * rx - Receive pin
simon 20:029aa53d7323 45 *
simon 20:029aa53d7323 46 * Note: Either tx or rx may be specified as NC if unused
simon 20:029aa53d7323 47 */
simon 20:029aa53d7323 48
simon 20:029aa53d7323 49 SerialHalfDuplex(PinName tx, PinName rx, const char *name = NULL);
simon 20:029aa53d7323 50
simon 20:029aa53d7323 51 #if 0 // Inherited from Serial class, for documentation
simon 20:029aa53d7323 52 /* Function: baud
simon 20:029aa53d7323 53 * Set the baud rate of the serial port
simon 20:029aa53d7323 54 *
simon 20:029aa53d7323 55 * Variables:
simon 20:029aa53d7323 56 * baudrate - The baudrate of the serial port (default = 9600).
simon 20:029aa53d7323 57 */
simon 20:029aa53d7323 58 void baud(int baudrate);
simon 20:029aa53d7323 59
simon 20:029aa53d7323 60 enum Parity {
simon 20:029aa53d7323 61 None = 0
simon 20:029aa53d7323 62 , Odd
simon 20:029aa53d7323 63 , Even
simon 20:029aa53d7323 64 , Forced1
simon 20:029aa53d7323 65 , Forced0
simon 20:029aa53d7323 66 };
simon 20:029aa53d7323 67
simon 20:029aa53d7323 68 /* Function: format
simon 20:029aa53d7323 69 * Set the transmission format used by the Serial port
simon 20:029aa53d7323 70 *
simon 20:029aa53d7323 71 * Variables:
simon 20:029aa53d7323 72 * bits - The number of bits in a word (5-8; default = 8)
simon 20:029aa53d7323 73 * parity - The parity used (Serial::None, Serial::Odd,
simon 20:029aa53d7323 74 Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)
simon 20:029aa53d7323 75 * stop - The number of stop bits (1 or 2; default = 1)
simon 20:029aa53d7323 76 */
simon 20:029aa53d7323 77 void format(int bits = 8, Parity parity = Serial::None, int stop_bits
simon 20:029aa53d7323 78 = 1);
simon 20:029aa53d7323 79
simon 20:029aa53d7323 80 /* Function: putc
simon 20:029aa53d7323 81 * Write a character
simon 20:029aa53d7323 82 *
simon 20:029aa53d7323 83 * Variables:
simon 20:029aa53d7323 84 * c - The character to write to the serial port
simon 20:029aa53d7323 85 */
simon 20:029aa53d7323 86 int putc(int c);
simon 20:029aa53d7323 87
simon 20:029aa53d7323 88 /* Function: getc
simon 20:029aa53d7323 89 * Read a character
simon 20:029aa53d7323 90 *
simon 20:029aa53d7323 91 * Variables:
simon 20:029aa53d7323 92 * returns - The character read from the serial port
simon 20:029aa53d7323 93 */
simon 20:029aa53d7323 94 int getc();
simon 20:029aa53d7323 95
simon 20:029aa53d7323 96 /* Function: printf
simon 20:029aa53d7323 97 * Write a formated string
simon 20:029aa53d7323 98 *
simon 20:029aa53d7323 99 * Variables:
simon 20:029aa53d7323 100 * format - A printf-style format string, followed by the
simon 20:029aa53d7323 101 * variables to use in formating the string.
simon 20:029aa53d7323 102 */
simon 20:029aa53d7323 103 int printf(const char* format, ...);
simon 20:029aa53d7323 104
simon 20:029aa53d7323 105 /* Function: scanf
simon 20:029aa53d7323 106 * Read a formated string
simon 20:029aa53d7323 107 *
simon 20:029aa53d7323 108 * Variables:
simon 20:029aa53d7323 109 * format - A scanf-style format string,
simon 20:029aa53d7323 110 * followed by the pointers to variables to store the results.
simon 20:029aa53d7323 111 */
simon 20:029aa53d7323 112 int scanf(const char* format, ...);
simon 20:029aa53d7323 113
simon 20:029aa53d7323 114 /* Function: readable
simon 20:029aa53d7323 115 * Determine if there is a character available to read
simon 20:029aa53d7323 116 *
simon 20:029aa53d7323 117 * Variables:
simon 20:029aa53d7323 118 * returns - 1 if there is a character available to read, else 0
simon 20:029aa53d7323 119 */
simon 20:029aa53d7323 120 int readable();
simon 20:029aa53d7323 121
simon 20:029aa53d7323 122 /* Function: writeable
simon 20:029aa53d7323 123 * Determine if there is space available to write a character
simon 20:029aa53d7323 124 *
simon 20:029aa53d7323 125 * Variables:
simon 20:029aa53d7323 126 * returns - 1 if there is space to write a character, else 0
simon 20:029aa53d7323 127 */
simon 20:029aa53d7323 128 int writeable();
simon 20:029aa53d7323 129
simon 20:029aa53d7323 130 /* Function: attach
simon 20:029aa53d7323 131 * Attach a function to call whenever a serial interrupt is generated
simon 20:029aa53d7323 132 *
simon 20:029aa53d7323 133 * Variables:
simon 20:029aa53d7323 134 * fptr - A pointer to a void function, or 0 to set as none
simon 20:029aa53d7323 135 */
simon 20:029aa53d7323 136 void attach(void (*fptr)(void));
simon 20:029aa53d7323 137
simon 20:029aa53d7323 138 /* Function: attach
simon 20:029aa53d7323 139 * Attach a member function to call whenever a serial interrupt is generated
simon 20:029aa53d7323 140 *
simon 20:029aa53d7323 141 * Variables:
simon 20:029aa53d7323 142 * tptr - pointer to the object to call the member function on
simon 20:029aa53d7323 143 * mptr - pointer to the member function to be called
simon 20:029aa53d7323 144 */
simon 20:029aa53d7323 145 template<typename T>
simon 20:029aa53d7323 146 void attach(T* tptr, void (T::*mptr)(void));
simon 20:029aa53d7323 147
simon 20:029aa53d7323 148 #endif
simon 20:029aa53d7323 149
simon 20:029aa53d7323 150 protected:
simon 20:029aa53d7323 151 PinName _txpin;
simon 20:029aa53d7323 152 int _pinfunc;
simon 20:029aa53d7323 153
simon 20:029aa53d7323 154 virtual int _putc(int c);
simon 20:029aa53d7323 155 virtual int _getc(void);
simon 20:029aa53d7323 156
simon 20:029aa53d7323 157 }; // End class SerialHalfDuplex
simon 20:029aa53d7323 158
simon 20:029aa53d7323 159 } // End namespace
simon 20:029aa53d7323 160
simon 20:029aa53d7323 161 #endif