Julien Tiron / AX12

kk

Dependents:   2-FisherMan 2-FisherMan

Fork of AX12 by Chris Styles

SerialHalfDuplex.h@4:c1835649c36f, 2016-05-06 (annotated)

Committer:
julientiron
Date:
Fri May 06 07:21:41 2016 +0000
Revision:
4:c1835649c36f
d

Who changed what in which revision?

UserRevisionLine numberNew contents of line
julientiron 4:c1835649c36f 1 /* mbed Microcontroller Library
julientiron 4:c1835649c36f 2 * Copyright (c) 2006-2012 ARM Limited
julientiron 4:c1835649c36f 3 *
julientiron 4:c1835649c36f 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
julientiron 4:c1835649c36f 5 * of this software and associated documentation files (the "Software"), to deal
julientiron 4:c1835649c36f 6 * in the Software without restriction, including without limitation the rights
julientiron 4:c1835649c36f 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
julientiron 4:c1835649c36f 8 * copies of the Software, and to permit persons to whom the Software is
julientiron 4:c1835649c36f 9 * furnished to do so, subject to the following conditions:
julientiron 4:c1835649c36f 10 *
julientiron 4:c1835649c36f 11 * The above copyright notice and this permission notice shall be included in
julientiron 4:c1835649c36f 12 * all copies or substantial portions of the Software.
julientiron 4:c1835649c36f 13 *
julientiron 4:c1835649c36f 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
julientiron 4:c1835649c36f 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
julientiron 4:c1835649c36f 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
julientiron 4:c1835649c36f 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
julientiron 4:c1835649c36f 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
julientiron 4:c1835649c36f 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
julientiron 4:c1835649c36f 20 * SOFTWARE.
julientiron 4:c1835649c36f 21 *
julientiron 4:c1835649c36f 22 * NOTE: This is an unsupported legacy untested library.
julientiron 4:c1835649c36f 23 */
julientiron 4:c1835649c36f 24 #ifndef MBED_SERIALHALFDUPLEX_H
julientiron 4:c1835649c36f 25 #define MBED_SERIALHALFDUPLEX_H
julientiron 4:c1835649c36f 26
julientiron 4:c1835649c36f 27 #include "device.h"
julientiron 4:c1835649c36f 28
julientiron 4:c1835649c36f 29 #if DEVICE_SERIAL
julientiron 4:c1835649c36f 30
julientiron 4:c1835649c36f 31 #include "Serial.h"
julientiron 4:c1835649c36f 32 #include "PinNames.h"
julientiron 4:c1835649c36f 33 #include "PeripheralNames.h"
julientiron 4:c1835649c36f 34
julientiron 4:c1835649c36f 35 namespace mbed {
julientiron 4:c1835649c36f 36
julientiron 4:c1835649c36f 37 /* Class: SerialHalfDuplex
julientiron 4:c1835649c36f 38 * A serial port (UART) for communication with other devices using
julientiron 4:c1835649c36f 39 * Half-Duplex, allowing transmit and receive on a single
julientiron 4:c1835649c36f 40 * shared transmit and receive line. Only one end should be transmitting
julientiron 4:c1835649c36f 41 * at a time.
julientiron 4:c1835649c36f 42 *
julientiron 4:c1835649c36f 43 * Both the tx and rx pin should be defined, and wired together.
julientiron 4:c1835649c36f 44 * This is in addition to them being wired to the other serial
julientiron 4:c1835649c36f 45 * device to allow both read and write functions to operate.
julientiron 4:c1835649c36f 46 *
julientiron 4:c1835649c36f 47 * Example:
julientiron 4:c1835649c36f 48 * > // Send a byte to a second HalfDuplex device, and read the response
julientiron 4:c1835649c36f 49 * >
julientiron 4:c1835649c36f 50 * > #include "mbed.h"
julientiron 4:c1835649c36f 51 * >
julientiron 4:c1835649c36f 52 * > // p9 and p10 should be wired together to form "a"
julientiron 4:c1835649c36f 53 * > // p28 and p27 should be wired together to form "b"
julientiron 4:c1835649c36f 54 * > // p9/p10 should be wired to p28/p27 as the Half Duplex connection
julientiron 4:c1835649c36f 55 * >
julientiron 4:c1835649c36f 56 * > SerialHalfDuplex a(p9, p10);
julientiron 4:c1835649c36f 57 * > SerialHalfDuplex b(p28, p27);
julientiron 4:c1835649c36f 58 * >
julientiron 4:c1835649c36f 59 * > void b_rx() { // second device response
julientiron 4:c1835649c36f 60 * > b.putc(b.getc() + 4);
julientiron 4:c1835649c36f 61 * > }
julientiron 4:c1835649c36f 62 * >
julientiron 4:c1835649c36f 63 * > int main() {
julientiron 4:c1835649c36f 64 * > b.attach(&b_rx);
julientiron 4:c1835649c36f 65 * > for(int c = 'A'; c < 'Z'; c++) {
julientiron 4:c1835649c36f 66 * > a.putc(c);
julientiron 4:c1835649c36f 67 * > printf("sent [%c]\n", c);
julientiron 4:c1835649c36f 68 * > wait(0.5); // b should respond
julientiron 4:c1835649c36f 69 * > if(a.readable()) {
julientiron 4:c1835649c36f 70 * > printf("received [%c]\n", a.getc());
julientiron 4:c1835649c36f 71 * > }
julientiron 4:c1835649c36f 72 * > }
julientiron 4:c1835649c36f 73 * > }
julientiron 4:c1835649c36f 74 *
julientiron 4:c1835649c36f 75 * For Simplex and Full-Duplex Serial communication, see <Serial>
julientiron 4:c1835649c36f 76 */
julientiron 4:c1835649c36f 77 class SerialHalfDuplex : public Serial {
julientiron 4:c1835649c36f 78
julientiron 4:c1835649c36f 79 public:
julientiron 4:c1835649c36f 80 /* Constructor: SerialHalfDuplex
julientiron 4:c1835649c36f 81 * Create a half-duplex serial port, connected to the specified transmit
julientiron 4:c1835649c36f 82 * and receive pins.
julientiron 4:c1835649c36f 83 *
julientiron 4:c1835649c36f 84 * These pins should be wired together, as well as to the target device
julientiron 4:c1835649c36f 85 *
julientiron 4:c1835649c36f 86 * Variables:
julientiron 4:c1835649c36f 87 * tx - Transmit pin
julientiron 4:c1835649c36f 88 * rx - Receive pin
julientiron 4:c1835649c36f 89 */
julientiron 4:c1835649c36f 90 SerialHalfDuplex(PinName tx, PinName rx, const char *name = NULL);
julientiron 4:c1835649c36f 91
julientiron 4:c1835649c36f 92 #if 0 // Inherited from Serial class, for documentation
julientiron 4:c1835649c36f 93 /* Function: baud
julientiron 4:c1835649c36f 94 * Set the baud rate of the serial port
julientiron 4:c1835649c36f 95 *
julientiron 4:c1835649c36f 96 * Variables:
julientiron 4:c1835649c36f 97 * baudrate - The baudrate of the serial port (default = 9600).
julientiron 4:c1835649c36f 98 */
julientiron 4:c1835649c36f 99 void baud(int baudrate);
julientiron 4:c1835649c36f 100
julientiron 4:c1835649c36f 101 enum Parity {
julientiron 4:c1835649c36f 102 None = 0
julientiron 4:c1835649c36f 103 , Odd
julientiron 4:c1835649c36f 104 , Even
julientiron 4:c1835649c36f 105 , Forced1
julientiron 4:c1835649c36f 106 , Forced0
julientiron 4:c1835649c36f 107 };
julientiron 4:c1835649c36f 108
julientiron 4:c1835649c36f 109 /* Function: format
julientiron 4:c1835649c36f 110 * Set the transmission format used by the Serial port
julientiron 4:c1835649c36f 111 *
julientiron 4:c1835649c36f 112 * Variables:
julientiron 4:c1835649c36f 113 * bits - The number of bits in a word (5-8; default = 8)
julientiron 4:c1835649c36f 114 * parity - The parity used (Serial::None, Serial::Odd,
julientiron 4:c1835649c36f 115 Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)
julientiron 4:c1835649c36f 116 * stop - The number of stop bits (1 or 2; default = 1)
julientiron 4:c1835649c36f 117 */
julientiron 4:c1835649c36f 118 void format(int bits = 8, Parity parity = Serial::None, int stop_bits
julientiron 4:c1835649c36f 119 = 1);
julientiron 4:c1835649c36f 120
julientiron 4:c1835649c36f 121 /* Function: putc
julientiron 4:c1835649c36f 122 * Write a character
julientiron 4:c1835649c36f 123 *
julientiron 4:c1835649c36f 124 * Variables:
julientiron 4:c1835649c36f 125 * c - The character to write to the serial port
julientiron 4:c1835649c36f 126 */
julientiron 4:c1835649c36f 127 int putc(int c);
julientiron 4:c1835649c36f 128
julientiron 4:c1835649c36f 129 /* Function: getc
julientiron 4:c1835649c36f 130 * Read a character
julientiron 4:c1835649c36f 131 *
julientiron 4:c1835649c36f 132 * Read a character from the serial port. This call will block
julientiron 4:c1835649c36f 133 * until a character is available. For testing if a character is
julientiron 4:c1835649c36f 134 * available for reading, see <readable>.
julientiron 4:c1835649c36f 135 *
julientiron 4:c1835649c36f 136 * Variables:
julientiron 4:c1835649c36f 137 * returns - The character read from the serial port
julientiron 4:c1835649c36f 138 */
julientiron 4:c1835649c36f 139 int getc();
julientiron 4:c1835649c36f 140
julientiron 4:c1835649c36f 141 /* Function: printf
julientiron 4:c1835649c36f 142 * Write a formated string
julientiron 4:c1835649c36f 143 *
julientiron 4:c1835649c36f 144 * Variables:
julientiron 4:c1835649c36f 145 * format - A printf-style format string, followed by the
julientiron 4:c1835649c36f 146 * variables to use in formating the string.
julientiron 4:c1835649c36f 147 */
julientiron 4:c1835649c36f 148 int printf(const char* format, ...);
julientiron 4:c1835649c36f 149
julientiron 4:c1835649c36f 150 /* Function: scanf
julientiron 4:c1835649c36f 151 * Read a formated string
julientiron 4:c1835649c36f 152 *
julientiron 4:c1835649c36f 153 * Variables:
julientiron 4:c1835649c36f 154 * format - A scanf-style format string,
julientiron 4:c1835649c36f 155 * followed by the pointers to variables to store the results.
julientiron 4:c1835649c36f 156 */
julientiron 4:c1835649c36f 157 int scanf(const char* format, ...);
julientiron 4:c1835649c36f 158
julientiron 4:c1835649c36f 159 /* Function: readable
julientiron 4:c1835649c36f 160 * Determine if there is a character available to read
julientiron 4:c1835649c36f 161 *
julientiron 4:c1835649c36f 162 * Variables:
julientiron 4:c1835649c36f 163 * returns - 1 if there is a character available to read, else 0
julientiron 4:c1835649c36f 164 */
julientiron 4:c1835649c36f 165 int readable();
julientiron 4:c1835649c36f 166
julientiron 4:c1835649c36f 167 /* Function: writeable
julientiron 4:c1835649c36f 168 * Determine if there is space available to write a character
julientiron 4:c1835649c36f 169 *
julientiron 4:c1835649c36f 170 * Variables:
julientiron 4:c1835649c36f 171 * returns - 1 if there is space to write a character, else 0
julientiron 4:c1835649c36f 172 */
julientiron 4:c1835649c36f 173 int writeable();
julientiron 4:c1835649c36f 174
julientiron 4:c1835649c36f 175 /* Function: attach
julientiron 4:c1835649c36f 176 * Attach a function to call whenever a serial interrupt is generated
julientiron 4:c1835649c36f 177 *
julientiron 4:c1835649c36f 178 * Variables:
julientiron 4:c1835649c36f 179 * fptr - A pointer to a void function, or 0 to set as none
julientiron 4:c1835649c36f 180 */
julientiron 4:c1835649c36f 181 void attach(void (*fptr)(void));
julientiron 4:c1835649c36f 182
julientiron 4:c1835649c36f 183 /* Function: attach
julientiron 4:c1835649c36f 184 * Attach a member function to call whenever a serial interrupt is generated
julientiron 4:c1835649c36f 185 *
julientiron 4:c1835649c36f 186 * Variables:
julientiron 4:c1835649c36f 187 * tptr - pointer to the object to call the member function on
julientiron 4:c1835649c36f 188 * mptr - pointer to the member function to be called
julientiron 4:c1835649c36f 189 */
julientiron 4:c1835649c36f 190 template<typename T>
julientiron 4:c1835649c36f 191 void attach(T* tptr, void (T::*mptr)(void));
julientiron 4:c1835649c36f 192
julientiron 4:c1835649c36f 193 #endif
julientiron 4:c1835649c36f 194
julientiron 4:c1835649c36f 195 protected:
julientiron 4:c1835649c36f 196 PinName _txpin;
julientiron 4:c1835649c36f 197
julientiron 4:c1835649c36f 198 virtual int _putc(int c);
julientiron 4:c1835649c36f 199 virtual int _getc(void);
julientiron 4:c1835649c36f 200
julientiron 4:c1835649c36f 201 }; // End class SerialHalfDuplex
julientiron 4:c1835649c36f 202
julientiron 4:c1835649c36f 203 } // End namespace
julientiron 4:c1835649c36f 204
julientiron 4:c1835649c36f 205 #endif
julientiron 4:c1835649c36f 206
julientiron 4:c1835649c36f 207 #endif