George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/SerialBase.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

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