Jeremy Hammel / Mbed 2 deprecated ATT_Smart_Home

FRDM-K64F, Avnet M14A2A, Grove Shield, to create smart home system. In use with AT&Ts M2x & Flow.

Dependencies:   mbed FXOS8700CQ MODSERIAL

mbed/SerialBase.h@84:fc8c9b39723a, 2019-03-06 (annotated)

Committer:
jwhammel
Date:
Wed Mar 06 21:11:49 2019 +0000
Revision:
84:fc8c9b39723a
Embedded Systems Midterm Project Spring 2019

Who changed what in which revision?

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