Einstein Filho / Mbed 2 deprecated MANGUEBAJA2019_BOX

Mangue Baja Box

Dependencies:   mbed

mbed/SerialBase.h@0:0dee8840a1c0, 2019-07-29 (annotated)

Committer:
einsteingustavo
Date:
Mon Jul 29 20:38:00 2019 +0000
Revision:
0:0dee8840a1c0
Mangue Baja Box

Who changed what in which revision?

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