dev01 Brautlecht / mbed-STM32F030F4

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   STM32F031_Blink_Aug17

Fork of mbed-STM32F030F4 by Nothing Special

api/SerialBase.h@11:79a2d67cd509, 2017-02-14 (annotated)

Committer:
mega64
Date:
Tue Feb 14 21:52:10 2017 +0000
Revision:
11:79a2d67cd509
Parent:
0:38ccae254a29 
repair the effects of improvements in the mbed environment (Ch.1, serial_set_flow_control )

Who changed what in which revision?

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