clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/SerialHalfDuplex.h@2:91b6646ea994, 2017-02-01 (annotated)

Committer:
clementlignie
Date:
Wed Feb 01 13:42:30 2017 +0000
Revision:
2:91b6646ea994
Parent:
0:c03cffe402df 
config AX12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:c03cffe402df 1 /* mbed Microcontroller Library - SerialHalfDuplex
slowness 0:c03cffe402df 2 * Copyright (c) 2010-2011 ARM Limited. All rights reserved.
slowness 0:c03cffe402df 3 */
slowness 0:c03cffe402df 4
slowness 0:c03cffe402df 5 #ifndef MBED_SERIALHALFDUPLEX_H
slowness 0:c03cffe402df 6 #define MBED_SERIALHALFDUPLEX_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 #include "device.h"
slowness 0:c03cffe402df 9
slowness 0:c03cffe402df 10 #if DEVICE_SERIAL
slowness 0:c03cffe402df 11
slowness 0:c03cffe402df 12 #include "Serial.h"
slowness 0:c03cffe402df 13 #include "PinNames.h"
slowness 0:c03cffe402df 14 #include "PeripheralNames.h"
slowness 0:c03cffe402df 15
slowness 0:c03cffe402df 16 namespace mbed {
slowness 0:c03cffe402df 17
slowness 0:c03cffe402df 18 /* Class: SerialHalfDuplex
slowness 0:c03cffe402df 19 * A serial port (UART) for communication with other devices using
slowness 0:c03cffe402df 20 * Half-Duplex, allowing transmit and receive on a single
slowness 0:c03cffe402df 21 * shared transmit and receive line. Only one end should be transmitting
slowness 0:c03cffe402df 22 * at a time.
slowness 0:c03cffe402df 23 *
slowness 0:c03cffe402df 24 * Both the tx and rx pin should be defined, and wired together.
slowness 0:c03cffe402df 25 * This is in addition to them being wired to the other serial
slowness 0:c03cffe402df 26 * device to allow both read and write functions to operate.
slowness 0:c03cffe402df 27 *
slowness 0:c03cffe402df 28 * Example:
slowness 0:c03cffe402df 29 * > // Send a byte to a second HalfDuplex device, and read the response
slowness 0:c03cffe402df 30 * >
slowness 0:c03cffe402df 31 * > #include "mbed.h"
slowness 0:c03cffe402df 32 * >
slowness 0:c03cffe402df 33 * > // p9 and p10 should be wired together to form "a"
slowness 0:c03cffe402df 34 * > // p28 and p27 should be wired together to form "b"
slowness 0:c03cffe402df 35 * > // p9/p10 should be wired to p28/p27 as the Half Duplex connection
slowness 0:c03cffe402df 36 * >
slowness 0:c03cffe402df 37 * > SerialHalfDuplex a(p9, p10);
slowness 0:c03cffe402df 38 * > SerialHalfDuplex b(p28, p27);
slowness 0:c03cffe402df 39 * >
slowness 0:c03cffe402df 40 * > void b_rx() { // second device response
slowness 0:c03cffe402df 41 * > b.putc(b.getc() + 4);
slowness 0:c03cffe402df 42 * > }
slowness 0:c03cffe402df 43 * >
slowness 0:c03cffe402df 44 * > int main() {
slowness 0:c03cffe402df 45 * > b.attach(&b_rx);
slowness 0:c03cffe402df 46 * > for(int c = 'A'; c < 'Z'; c++) {
slowness 0:c03cffe402df 47 * > a.putc(c);
slowness 0:c03cffe402df 48 * > printf("sent [%c]\n", c);
slowness 0:c03cffe402df 49 * > wait(0.5); // b should respond
slowness 0:c03cffe402df 50 * > if(a.readable()) {
slowness 0:c03cffe402df 51 * > printf("received [%c]\n", a.getc());
slowness 0:c03cffe402df 52 * > }
slowness 0:c03cffe402df 53 * > }
slowness 0:c03cffe402df 54 * > }
slowness 0:c03cffe402df 55 *
slowness 0:c03cffe402df 56 * For Simplex and Full-Duplex Serial communication, see <Serial>
slowness 0:c03cffe402df 57 */
slowness 0:c03cffe402df 58 class SerialHalfDuplex : public Serial {
slowness 0:c03cffe402df 59
slowness 0:c03cffe402df 60 public:
slowness 0:c03cffe402df 61 /* Constructor: SerialHalfDuplex
slowness 0:c03cffe402df 62 * Create a half-duplex serial port, connected to the specified transmit
slowness 0:c03cffe402df 63 * and receive pins.
slowness 0:c03cffe402df 64 *
slowness 0:c03cffe402df 65 * These pins should be wired together, as well as to the target device
slowness 0:c03cffe402df 66 *
slowness 0:c03cffe402df 67 * Variables:
slowness 0:c03cffe402df 68 * tx - Transmit pin
slowness 0:c03cffe402df 69 * rx - Receive pin
slowness 0:c03cffe402df 70 */
slowness 0:c03cffe402df 71 SerialHalfDuplex(PinName tx, PinName rx, const char *name = NULL);
slowness 0:c03cffe402df 72
slowness 0:c03cffe402df 73 #if 0 // Inherited from Serial class, for documentation
slowness 0:c03cffe402df 74 /* Function: baud
slowness 0:c03cffe402df 75 * Set the baud rate of the serial port
slowness 0:c03cffe402df 76 *
slowness 0:c03cffe402df 77 * Variables:
slowness 0:c03cffe402df 78 * baudrate - The baudrate of the serial port (default = 9600).
slowness 0:c03cffe402df 79 */
slowness 0:c03cffe402df 80 void baud(int baudrate);
slowness 0:c03cffe402df 81
slowness 0:c03cffe402df 82 enum Parity {
slowness 0:c03cffe402df 83 None = 0
slowness 0:c03cffe402df 84 , Odd
slowness 0:c03cffe402df 85 , Even
slowness 0:c03cffe402df 86 , Forced1
slowness 0:c03cffe402df 87 , Forced0
slowness 0:c03cffe402df 88 };
slowness 0:c03cffe402df 89
slowness 0:c03cffe402df 90 /* Function: format
slowness 0:c03cffe402df 91 * Set the transmission format used by the Serial port
slowness 0:c03cffe402df 92 *
slowness 0:c03cffe402df 93 * Variables:
slowness 0:c03cffe402df 94 * bits - The number of bits in a word (5-8; default = 8)
slowness 0:c03cffe402df 95 * parity - The parity used (Serial::None, Serial::Odd,
slowness 0:c03cffe402df 96 Serial::Even, Serial::Forced1, Serial::Forced0; default = Serial::None)
slowness 0:c03cffe402df 97 * stop - The number of stop bits (1 or 2; default = 1)
slowness 0:c03cffe402df 98 */
slowness 0:c03cffe402df 99 void format(int bits = 8, Parity parity = Serial::None, int stop_bits
slowness 0:c03cffe402df 100 = 1);
slowness 0:c03cffe402df 101
slowness 0:c03cffe402df 102 /* Function: putc
slowness 0:c03cffe402df 103 * Write a character
slowness 0:c03cffe402df 104 *
slowness 0:c03cffe402df 105 * Variables:
slowness 0:c03cffe402df 106 * c - The character to write to the serial port
slowness 0:c03cffe402df 107 */
slowness 0:c03cffe402df 108 int putc(int c);
slowness 0:c03cffe402df 109
slowness 0:c03cffe402df 110 /* Function: getc
slowness 0:c03cffe402df 111 * Read a character
slowness 0:c03cffe402df 112 *
slowness 0:c03cffe402df 113 * Read a character from the serial port. This call will block
slowness 0:c03cffe402df 114 * until a character is available. For testing if a character is
slowness 0:c03cffe402df 115 * available for reading, see <readable>.
slowness 0:c03cffe402df 116 *
slowness 0:c03cffe402df 117 * Variables:
slowness 0:c03cffe402df 118 * returns - The character read from the serial port
slowness 0:c03cffe402df 119 */
slowness 0:c03cffe402df 120 int getc();
slowness 0:c03cffe402df 121
slowness 0:c03cffe402df 122 /* Function: printf
slowness 0:c03cffe402df 123 * Write a formated string
slowness 0:c03cffe402df 124 *
slowness 0:c03cffe402df 125 * Variables:
slowness 0:c03cffe402df 126 * format - A printf-style format string, followed by the
slowness 0:c03cffe402df 127 * variables to use in formating the string.
slowness 0:c03cffe402df 128 */
slowness 0:c03cffe402df 129 int printf(const char* format, ...);
slowness 0:c03cffe402df 130
slowness 0:c03cffe402df 131 /* Function: scanf
slowness 0:c03cffe402df 132 * Read a formated string
slowness 0:c03cffe402df 133 *
slowness 0:c03cffe402df 134 * Variables:
slowness 0:c03cffe402df 135 * format - A scanf-style format string,
slowness 0:c03cffe402df 136 * followed by the pointers to variables to store the results.
slowness 0:c03cffe402df 137 */
slowness 0:c03cffe402df 138 int scanf(const char* format, ...);
slowness 0:c03cffe402df 139
slowness 0:c03cffe402df 140 /* Function: readable
slowness 0:c03cffe402df 141 * Determine if there is a character available to read
slowness 0:c03cffe402df 142 *
slowness 0:c03cffe402df 143 * Variables:
slowness 0:c03cffe402df 144 * returns - 1 if there is a character available to read, else 0
slowness 0:c03cffe402df 145 */
slowness 0:c03cffe402df 146 int readable();
slowness 0:c03cffe402df 147
slowness 0:c03cffe402df 148 /* Function: writeable
slowness 0:c03cffe402df 149 * Determine if there is space available to write a character
slowness 0:c03cffe402df 150 *
slowness 0:c03cffe402df 151 * Variables:
slowness 0:c03cffe402df 152 * returns - 1 if there is space to write a character, else 0
slowness 0:c03cffe402df 153 */
slowness 0:c03cffe402df 154 int writeable();
slowness 0:c03cffe402df 155
slowness 0:c03cffe402df 156 /* Function: attach
slowness 0:c03cffe402df 157 * Attach a function to call whenever a serial interrupt is generated
slowness 0:c03cffe402df 158 *
slowness 0:c03cffe402df 159 * Variables:
slowness 0:c03cffe402df 160 * fptr - A pointer to a void function, or 0 to set as none
slowness 0:c03cffe402df 161 */
slowness 0:c03cffe402df 162 void attach(void (*fptr)(void));
slowness 0:c03cffe402df 163
slowness 0:c03cffe402df 164 /* Function: attach
slowness 0:c03cffe402df 165 * Attach a member function to call whenever a serial interrupt is generated
slowness 0:c03cffe402df 166 *
slowness 0:c03cffe402df 167 * Variables:
slowness 0:c03cffe402df 168 * tptr - pointer to the object to call the member function on
slowness 0:c03cffe402df 169 * mptr - pointer to the member function to be called
slowness 0:c03cffe402df 170 */
slowness 0:c03cffe402df 171 template<typename T>
slowness 0:c03cffe402df 172 void attach(T* tptr, void (T::*mptr)(void));
slowness 0:c03cffe402df 173
slowness 0:c03cffe402df 174 #endif
slowness 0:c03cffe402df 175
slowness 0:c03cffe402df 176 protected:
slowness 0:c03cffe402df 177 PinName _txpin;
slowness 0:c03cffe402df 178
slowness 0:c03cffe402df 179 virtual int _putc(int c);
slowness 0:c03cffe402df 180 virtual int _getc(void);
slowness 0:c03cffe402df 181
slowness 0:c03cffe402df 182 }; // End class SerialHalfDuplex
slowness 0:c03cffe402df 183
slowness 0:c03cffe402df 184 } // End namespace
slowness 0:c03cffe402df 185
slowness 0:c03cffe402df 186 #endif
slowness 0:c03cffe402df 187
slowness 0:c03cffe402df 188 #endif