Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

SerialBase.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

UserRevisionLine numberNew contents of line
esokic 0:05aad811ea07 1 /* mbed Microcontroller Library
esokic 0:05aad811ea07 2 * Copyright (c) 2006-2013 ARM Limited
esokic 0:05aad811ea07 3 *
esokic 0:05aad811ea07 4 * Licensed under the Apache License, Version 2.0 (the "License");
esokic 0:05aad811ea07 5 * you may not use this file except in compliance with the License.
esokic 0:05aad811ea07 6 * You may obtain a copy of the License at
esokic 0:05aad811ea07 7 *
esokic 0:05aad811ea07 8 * http://www.apache.org/licenses/LICENSE-2.0
esokic 0:05aad811ea07 9 *
esokic 0:05aad811ea07 10 * Unless required by applicable law or agreed to in writing, software
esokic 0:05aad811ea07 11 * distributed under the License is distributed on an "AS IS" BASIS,
esokic 0:05aad811ea07 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
esokic 0:05aad811ea07 13 * See the License for the specific language governing permissions and
esokic 0:05aad811ea07 14 * limitations under the License.
esokic 0:05aad811ea07 15 */
esokic 0:05aad811ea07 16 #ifndef MBED_SERIALBASE_H
esokic 0:05aad811ea07 17 #define MBED_SERIALBASE_H
esokic 0:05aad811ea07 18
esokic 0:05aad811ea07 19 #include "platform.h"
esokic 0:05aad811ea07 20
esokic 0:05aad811ea07 21 #if DEVICE_SERIAL
esokic 0:05aad811ea07 22
esokic 0:05aad811ea07 23 #include "Stream.h"
esokic 0:05aad811ea07 24 #include "FunctionPointer.h"
esokic 0:05aad811ea07 25 #include "serial_api.h"
esokic 0:05aad811ea07 26
esokic 0:05aad811ea07 27 namespace mbed {
esokic 0:05aad811ea07 28
esokic 0:05aad811ea07 29 /** A base class for serial port implementations
esokic 0:05aad811ea07 30 * Can't be instantiated directly (use Serial or RawSerial)
esokic 0:05aad811ea07 31 */
esokic 0:05aad811ea07 32 class SerialBase {
esokic 0:05aad811ea07 33
esokic 0:05aad811ea07 34 public:
esokic 0:05aad811ea07 35 /** Set the baud rate of the serial port
esokic 0:05aad811ea07 36 *
esokic 0:05aad811ea07 37 * @param baudrate The baudrate of the serial port (default = 9600).
esokic 0:05aad811ea07 38 */
esokic 0:05aad811ea07 39 void baud(int baudrate);
esokic 0:05aad811ea07 40
esokic 0:05aad811ea07 41 enum Parity {
esokic 0:05aad811ea07 42 None = 0,
esokic 0:05aad811ea07 43 Odd,
esokic 0:05aad811ea07 44 Even,
esokic 0:05aad811ea07 45 Forced1,
esokic 0:05aad811ea07 46 Forced0
esokic 0:05aad811ea07 47 };
esokic 0:05aad811ea07 48
esokic 0:05aad811ea07 49 enum IrqType {
esokic 0:05aad811ea07 50 RxIrq = 0,
esokic 0:05aad811ea07 51 TxIrq
esokic 0:05aad811ea07 52 };
esokic 0:05aad811ea07 53
esokic 0:05aad811ea07 54 enum Flow {
esokic 0:05aad811ea07 55 Disabled = 0,
esokic 0:05aad811ea07 56 RTS,
esokic 0:05aad811ea07 57 CTS,
esokic 0:05aad811ea07 58 RTSCTS
esokic 0:05aad811ea07 59 };
esokic 0:05aad811ea07 60
esokic 0:05aad811ea07 61 /** Set the transmission format used by the serial port
esokic 0:05aad811ea07 62 *
esokic 0:05aad811ea07 63 * @param bits The number of bits in a word (5-8; default = 8)
esokic 0:05aad811ea07 64 * @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
esokic 0:05aad811ea07 65 * @param stop The number of stop bits (1 or 2; default = 1)
esokic 0:05aad811ea07 66 */
esokic 0:05aad811ea07 67 void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1);
esokic 0:05aad811ea07 68
esokic 0:05aad811ea07 69 /** Determine if there is a character available to read
esokic 0:05aad811ea07 70 *
esokic 0:05aad811ea07 71 * @returns
esokic 0:05aad811ea07 72 * 1 if there is a character available to read,
esokic 0:05aad811ea07 73 * 0 otherwise
esokic 0:05aad811ea07 74 */
esokic 0:05aad811ea07 75 int readable();
esokic 0:05aad811ea07 76
esokic 0:05aad811ea07 77 /** Determine if there is space available to write a character
esokic 0:05aad811ea07 78 *
esokic 0:05aad811ea07 79 * @returns
esokic 0:05aad811ea07 80 * 1 if there is space to write a character,
esokic 0:05aad811ea07 81 * 0 otherwise
esokic 0:05aad811ea07 82 */
esokic 0:05aad811ea07 83 int writeable();
esokic 0:05aad811ea07 84
esokic 0:05aad811ea07 85 /** Attach a function to call whenever a serial interrupt is generated
esokic 0:05aad811ea07 86 *
esokic 0:05aad811ea07 87 * @param fptr A pointer to a void function, or 0 to set as none
esokic 0:05aad811ea07 88 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
esokic 0:05aad811ea07 89 */
esokic 0:05aad811ea07 90 void attach(void (*fptr)(void), IrqType type=RxIrq);
esokic 0:05aad811ea07 91
esokic 0:05aad811ea07 92 /** Attach a member function to call whenever a serial interrupt is generated
esokic 0:05aad811ea07 93 *
esokic 0:05aad811ea07 94 * @param tptr pointer to the object to call the member function on
esokic 0:05aad811ea07 95 * @param mptr pointer to the member function to be called
esokic 0:05aad811ea07 96 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
esokic 0:05aad811ea07 97 */
esokic 0:05aad811ea07 98 template<typename T>
esokic 0:05aad811ea07 99 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
esokic 0:05aad811ea07 100 if((mptr != NULL) && (tptr != NULL)) {
esokic 0:05aad811ea07 101 _irq[type].attach(tptr, mptr);
esokic 0:05aad811ea07 102 serial_irq_set(&_serial, (SerialIrq)type, 1);
esokic 0:05aad811ea07 103 }
esokic 0:05aad811ea07 104 }
esokic 0:05aad811ea07 105
esokic 0:05aad811ea07 106 /** Generate a break condition on the serial line
esokic 0:05aad811ea07 107 */
esokic 0:05aad811ea07 108 void send_break();
esokic 0:05aad811ea07 109
esokic 0:05aad811ea07 110 #if DEVICE_SERIAL_FC
esokic 0:05aad811ea07 111 /** Set the flow control type on the serial port
esokic 0:05aad811ea07 112 *
esokic 0:05aad811ea07 113 * @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
esokic 0:05aad811ea07 114 * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
esokic 0:05aad811ea07 115 * @param flow2 the second flow control pin (CTS for RTSCTS)
esokic 0:05aad811ea07 116 */
esokic 0:05aad811ea07 117 void set_flow_control(Flow type, PinName flow1=NC, PinName flow2=NC);
esokic 0:05aad811ea07 118 #endif
esokic 0:05aad811ea07 119
esokic 0:05aad811ea07 120 static void _irq_handler(uint32_t id, SerialIrq irq_type);
esokic 0:05aad811ea07 121
esokic 0:05aad811ea07 122 protected:
esokic 0:05aad811ea07 123 SerialBase(PinName tx, PinName rx);
esokic 0:05aad811ea07 124
esokic 0:05aad811ea07 125 int _base_getc();
esokic 0:05aad811ea07 126 int _base_putc(int c);
esokic 0:05aad811ea07 127
esokic 0:05aad811ea07 128 serial_t _serial;
esokic 0:05aad811ea07 129 FunctionPointer _irq[2];
esokic 0:05aad811ea07 130 int _baud;
esokic 0:05aad811ea07 131 };
esokic 0:05aad811ea07 132
esokic 0:05aad811ea07 133 } // namespace mbed
esokic 0:05aad811ea07 134
esokic 0:05aad811ea07 135 #endif
esokic 0:05aad811ea07 136
esokic 0:05aad811ea07 137 #endif