clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/Serial.h@0:c03cffe402df, 2016-02-03 (annotated)

Committer:
slowness
Date:
Wed Feb 03 14:01:53 2016 +0000
Revision:
0:c03cffe402df
Pour configurer les AX12 avec la carte NXP1768 sur les Pin 9 et 10

Who changed what in which revision?

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