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@0:38ccae254a29, 2014-10-18 (annotated)

Committer:
mega64
Date:
Sat Oct 18 02:40:17 2014 +0000
Revision:
0:38ccae254a29
Child:
11:79a2d67cd509
only for STM32F030F4

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 0:38ccae254a29 19 #include "platform.h"
mega64 0:38ccae254a29 20
mega64 0:38ccae254a29 21 #if DEVICE_SERIAL
mega64 0:38ccae254a29 22
mega64 0:38ccae254a29 23 #include "Stream.h"
mega64 0:38ccae254a29 24 #include "FunctionPointer.h"
mega64 0:38ccae254a29 25 #include "serial_api.h"
mega64 0:38ccae254a29 26
mega64 0:38ccae254a29 27 namespace mbed {
mega64 0:38ccae254a29 28
mega64 0:38ccae254a29 29 /** A base class for serial port implementations
mega64 0:38ccae254a29 30 * Can't be instantiated directly (use Serial or RawSerial)
mega64 0:38ccae254a29 31 */
mega64 0:38ccae254a29 32 class SerialBase {
mega64 0:38ccae254a29 33
mega64 0:38ccae254a29 34 public:
mega64 0:38ccae254a29 35 /** Set the baud rate of the serial port
mega64 0:38ccae254a29 36 *
mega64 0:38ccae254a29 37 * @param baudrate The baudrate of the serial port (default = 9600).
mega64 0:38ccae254a29 38 */
mega64 0:38ccae254a29 39 void baud(int baudrate);
mega64 0:38ccae254a29 40
mega64 0:38ccae254a29 41 enum Parity {
mega64 0:38ccae254a29 42 None = 0,
mega64 0:38ccae254a29 43 Odd,
mega64 0:38ccae254a29 44 Even,
mega64 0:38ccae254a29 45 Forced1,
mega64 0:38ccae254a29 46 Forced0
mega64 0:38ccae254a29 47 };
mega64 0:38ccae254a29 48
mega64 0:38ccae254a29 49 enum IrqType {
mega64 0:38ccae254a29 50 RxIrq = 0,
mega64 0:38ccae254a29 51 TxIrq
mega64 0:38ccae254a29 52 };
mega64 0:38ccae254a29 53
mega64 0:38ccae254a29 54 enum Flow {
mega64 0:38ccae254a29 55 Disabled = 0,
mega64 0:38ccae254a29 56 RTS,
mega64 0:38ccae254a29 57 CTS,
mega64 0:38ccae254a29 58 RTSCTS
mega64 0:38ccae254a29 59 };
mega64 0:38ccae254a29 60
mega64 0:38ccae254a29 61 /** Set the transmission format used by the serial port
mega64 0:38ccae254a29 62 *
mega64 0:38ccae254a29 63 * @param bits The number of bits in a word (5-8; default = 8)
mega64 0:38ccae254a29 64 * @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
mega64 0:38ccae254a29 65 * @param stop The number of stop bits (1 or 2; default = 1)
mega64 0:38ccae254a29 66 */
mega64 0:38ccae254a29 67 void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1);
mega64 0:38ccae254a29 68
mega64 0:38ccae254a29 69 /** Determine if there is a character available to read
mega64 0:38ccae254a29 70 *
mega64 0:38ccae254a29 71 * @returns
mega64 0:38ccae254a29 72 * 1 if there is a character available to read,
mega64 0:38ccae254a29 73 * 0 otherwise
mega64 0:38ccae254a29 74 */
mega64 0:38ccae254a29 75 int readable();
mega64 0:38ccae254a29 76
mega64 0:38ccae254a29 77 /** Determine if there is space available to write a character
mega64 0:38ccae254a29 78 *
mega64 0:38ccae254a29 79 * @returns
mega64 0:38ccae254a29 80 * 1 if there is space to write a character,
mega64 0:38ccae254a29 81 * 0 otherwise
mega64 0:38ccae254a29 82 */
mega64 0:38ccae254a29 83 int writeable();
mega64 0:38ccae254a29 84
mega64 0:38ccae254a29 85 /** Attach a function to call whenever a serial interrupt is generated
mega64 0:38ccae254a29 86 *
mega64 0:38ccae254a29 87 * @param fptr A pointer to a void function, or 0 to set as none
mega64 0:38ccae254a29 88 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
mega64 0:38ccae254a29 89 */
mega64 0:38ccae254a29 90 void attach(void (*fptr)(void), IrqType type=RxIrq);
mega64 0:38ccae254a29 91
mega64 0:38ccae254a29 92 /** Attach a member function to call whenever a serial interrupt is generated
mega64 0:38ccae254a29 93 *
mega64 0:38ccae254a29 94 * @param tptr pointer to the object to call the member function on
mega64 0:38ccae254a29 95 * @param mptr pointer to the member function to be called
mega64 0:38ccae254a29 96 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
mega64 0:38ccae254a29 97 */
mega64 0:38ccae254a29 98 template<typename T>
mega64 0:38ccae254a29 99 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
mega64 0:38ccae254a29 100 if((mptr != NULL) && (tptr != NULL)) {
mega64 0:38ccae254a29 101 _irq[type].attach(tptr, mptr);
mega64 0:38ccae254a29 102 serial_irq_set(&_serial, (SerialIrq)type, 1);
mega64 0:38ccae254a29 103 }
mega64 0:38ccae254a29 104 }
mega64 0:38ccae254a29 105
mega64 0:38ccae254a29 106 /** Generate a break condition on the serial line
mega64 0:38ccae254a29 107 */
mega64 0:38ccae254a29 108 void send_break();
mega64 0:38ccae254a29 109
mega64 0:38ccae254a29 110 #if DEVICE_SERIAL_FC
mega64 0:38ccae254a29 111 /** Set the flow control type on the serial port
mega64 0:38ccae254a29 112 *
mega64 0:38ccae254a29 113 * @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
mega64 0:38ccae254a29 114 * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
mega64 0:38ccae254a29 115 * @param flow2 the second flow control pin (CTS for RTSCTS)
mega64 0:38ccae254a29 116 */
mega64 0:38ccae254a29 117 void set_flow_control(Flow type, PinName flow1=NC, PinName flow2=NC);
mega64 0:38ccae254a29 118 #endif
mega64 0:38ccae254a29 119
mega64 0:38ccae254a29 120 static void _irq_handler(uint32_t id, SerialIrq irq_type);
mega64 0:38ccae254a29 121
mega64 0:38ccae254a29 122 protected:
mega64 0:38ccae254a29 123 SerialBase(PinName tx, PinName rx);
mega64 0:38ccae254a29 124 virtual ~SerialBase() {
mega64 0:38ccae254a29 125 }
mega64 0:38ccae254a29 126
mega64 0:38ccae254a29 127 int _base_getc();
mega64 0:38ccae254a29 128 int _base_putc(int c);
mega64 0:38ccae254a29 129
mega64 0:38ccae254a29 130 serial_t _serial;
mega64 0:38ccae254a29 131 FunctionPointer _irq[2];
mega64 0:38ccae254a29 132 int _baud;
mega64 0:38ccae254a29 133 };
mega64 0:38ccae254a29 134
mega64 0:38ccae254a29 135 } // namespace mbed
mega64 0:38ccae254a29 136
mega64 0:38ccae254a29 137 #endif
mega64 0:38ccae254a29 138
mega64 0:38ccae254a29 139 #endif