Benjamin Hepp / BufferedSerial

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.

Dependencies:   Buffer

Fork of BufferedSerial by Sam Grove

BufferedSerial.h@12:c7947d444267, 2016-02-13 (annotated)

Committer:
bhepp
Date:
Sat Feb 13 14:14:50 2016 +0000
Revision:
12:c7947d444267
Parent:
11:779304f9c5d2
Child:
13:b4080afc8cd5
Added blocking when write buffer is full

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sam_grove 0:a977d0a3d81e 1 /**
bhepp 12:c7947d444267 2 * Adapted by Benjamin Hepp (benjamin.hepp@inf.ethz.ch) to include blocking when write-buffer is full.
bhepp 12:c7947d444267 3 *
sam_grove 0:a977d0a3d81e 4 * @file BufferedSerial.h
sam_grove 0:a977d0a3d81e 5 * @brief Software Buffer - Extends mbed Serial functionallity adding irq driven TX and RX
sam_grove 0:a977d0a3d81e 6 * @author sam grove
sam_grove 0:a977d0a3d81e 7 * @version 1.0
sam_grove 0:a977d0a3d81e 8 * @see
sam_grove 0:a977d0a3d81e 9 *
sam_grove 0:a977d0a3d81e 10 * Copyright (c) 2013
sam_grove 0:a977d0a3d81e 11 *
sam_grove 0:a977d0a3d81e 12 * Licensed under the Apache License, Version 2.0 (the "License");
sam_grove 0:a977d0a3d81e 13 * you may not use this file except in compliance with the License.
sam_grove 0:a977d0a3d81e 14 * You may obtain a copy of the License at
sam_grove 0:a977d0a3d81e 15 *
sam_grove 0:a977d0a3d81e 16 * http://www.apache.org/licenses/LICENSE-2.0
sam_grove 0:a977d0a3d81e 17 *
sam_grove 0:a977d0a3d81e 18 * Unless required by applicable law or agreed to in writing, software
sam_grove 0:a977d0a3d81e 19 * distributed under the License is distributed on an "AS IS" BASIS,
sam_grove 0:a977d0a3d81e 20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sam_grove 0:a977d0a3d81e 21 * See the License for the specific language governing permissions and
sam_grove 0:a977d0a3d81e 22 * limitations under the License.
sam_grove 0:a977d0a3d81e 23 */
sam_grove 0:a977d0a3d81e 24
sam_grove 0:a977d0a3d81e 25 #ifndef BUFFEREDSERIAL_H
sam_grove 0:a977d0a3d81e 26 #define BUFFEREDSERIAL_H
sam_grove 0:a977d0a3d81e 27
sam_grove 0:a977d0a3d81e 28 #include "mbed.h"
sam_grove 0:a977d0a3d81e 29 #include "Buffer.h"
sam_grove 0:a977d0a3d81e 30
sam_grove 0:a977d0a3d81e 31 /** A serial port (UART) for communication with other serial devices
sam_grove 0:a977d0a3d81e 32 *
sam_grove 0:a977d0a3d81e 33 * Can be used for Full Duplex communication, or Simplex by specifying
sam_grove 0:a977d0a3d81e 34 * one pin as NC (Not Connected)
sam_grove 0:a977d0a3d81e 35 *
sam_grove 0:a977d0a3d81e 36 * Example:
sam_grove 0:a977d0a3d81e 37 * @code
sam_grove 0:a977d0a3d81e 38 * #include "mbed.h"
sam_grove 0:a977d0a3d81e 39 * #include "BufferedSerial.h"
sam_grove 0:a977d0a3d81e 40 *
sam_grove 0:a977d0a3d81e 41 * BufferedSerial pc(USBTX, USBRX);
sam_grove 0:a977d0a3d81e 42 *
sam_grove 0:a977d0a3d81e 43 * int main()
sam_grove 5:4d6a311fc8bf 44 * {
sam_grove 0:a977d0a3d81e 45 * while(1)
sam_grove 0:a977d0a3d81e 46 * {
sam_grove 0:a977d0a3d81e 47 * Timer s;
sam_grove 0:a977d0a3d81e 48 *
sam_grove 0:a977d0a3d81e 49 * s.start();
sam_grove 5:4d6a311fc8bf 50 * pc.printf("Hello World - buffered\n");
sam_grove 0:a977d0a3d81e 51 * int buffered_time = s.read_us();
sam_grove 0:a977d0a3d81e 52 * wait(0.1f); // give time for the buffer to empty
sam_grove 0:a977d0a3d81e 53 *
sam_grove 0:a977d0a3d81e 54 * s.reset();
sam_grove 5:4d6a311fc8bf 55 * printf("Hello World - blocking\n");
sam_grove 0:a977d0a3d81e 56 * int polled_time = s.read_us();
sam_grove 0:a977d0a3d81e 57 * s.stop();
sam_grove 0:a977d0a3d81e 58 * wait(0.1f); // give time for the buffer to empty
sam_grove 0:a977d0a3d81e 59 *
sam_grove 0:a977d0a3d81e 60 * pc.printf("printf buffered took %d us\n", buffered_time);
sam_grove 5:4d6a311fc8bf 61 * pc.printf("printf blocking took %d us\n", polled_time);
sam_grove 0:a977d0a3d81e 62 * wait(0.5f);
sam_grove 0:a977d0a3d81e 63 * }
sam_grove 0:a977d0a3d81e 64 * }
sam_grove 0:a977d0a3d81e 65 * @endcode
sam_grove 0:a977d0a3d81e 66 */
sam_grove 0:a977d0a3d81e 67
sam_grove 0:a977d0a3d81e 68 /**
sam_grove 0:a977d0a3d81e 69 * @class BufferedSerial
sam_grove 0:a977d0a3d81e 70 * @brief Software buffers and interrupt driven tx and rx for Serial
sam_grove 0:a977d0a3d81e 71 */
sam_grove 11:779304f9c5d2 72 class BufferedSerial : public RawSerial
sam_grove 0:a977d0a3d81e 73 {
sam_grove 0:a977d0a3d81e 74 private:
sam_grove 3:6b76fcf27545 75 Buffer <char> _rxbuf;
sam_grove 3:6b76fcf27545 76 Buffer <char> _txbuf;
ansond 10:9ee15ae3d1a3 77 uint32_t _buf_size;
bhepp 12:c7947d444267 78 uint32_t _buffered_bytes;
sam_grove 0:a977d0a3d81e 79
sam_grove 0:a977d0a3d81e 80 void rxIrq(void);
sam_grove 0:a977d0a3d81e 81 void txIrq(void);
sam_grove 1:57a11fb5d529 82 void prime(void);
bhepp 12:c7947d444267 83
sam_grove 0:a977d0a3d81e 84 public:
sam_grove 0:a977d0a3d81e 85 /** Create a BufferedSerial port, connected to the specified transmit and receive pins
sam_grove 0:a977d0a3d81e 86 * @param tx Transmit pin
sam_grove 0:a977d0a3d81e 87 * @param rx Receive pin
bhepp 12:c7947d444267 88 * @param buf_size Write and read buffer size
sam_grove 0:a977d0a3d81e 89 * @note Either tx or rx may be specified as NC if unused
sam_grove 0:a977d0a3d81e 90 */
bhepp 12:c7947d444267 91 BufferedSerial(PinName tx, PinName rx, uint32_t buf_size = 4096);
bhepp 12:c7947d444267 92
bhepp 12:c7947d444267 93 /** Create a BufferedSerial port, connected to the specified transmit and receive pins
bhepp 12:c7947d444267 94 * @param tx Transmit pin
bhepp 12:c7947d444267 95 * @param rx Receive pin
bhepp 12:c7947d444267 96 * @param baud_rate Baud rate
bhepp 12:c7947d444267 97 * @param buf_size Write and read Buffer size
bhepp 12:c7947d444267 98 * @note Either tx or rx may be specified as NC if unused
bhepp 12:c7947d444267 99 */
bhepp 12:c7947d444267 100 BufferedSerial(PinName tx, PinName rx, int baud_rate, uint32_t buf_size = 4096);
bhepp 12:c7947d444267 101
sam_grove 0:a977d0a3d81e 102 /** Destroy a BufferedSerial port
sam_grove 0:a977d0a3d81e 103 */
sam_grove 0:a977d0a3d81e 104 virtual ~BufferedSerial(void);
sam_grove 0:a977d0a3d81e 105
sam_grove 0:a977d0a3d81e 106 /** Check on how many bytes are in the rx buffer
sam_grove 0:a977d0a3d81e 107 * @return 1 if something exists, 0 otherwise
sam_grove 0:a977d0a3d81e 108 */
sam_grove 0:a977d0a3d81e 109 virtual int readable(void);
sam_grove 0:a977d0a3d81e 110
sam_grove 0:a977d0a3d81e 111 /** Check to see if the tx buffer has room
bhepp 12:c7947d444267 112 * @return 1 if there is space left in the ring-buffer, 0 otherwise
sam_grove 0:a977d0a3d81e 113 */
sam_grove 0:a977d0a3d81e 114 virtual int writeable(void);
sam_grove 0:a977d0a3d81e 115
sam_grove 0:a977d0a3d81e 116 /** Get a single byte from the BufferedSerial Port.
sam_grove 0:a977d0a3d81e 117 * Should check readable() before calling this.
sam_grove 0:a977d0a3d81e 118 * @return A byte that came in on the Serial Port
sam_grove 0:a977d0a3d81e 119 */
sam_grove 0:a977d0a3d81e 120 virtual int getc(void);
sam_grove 0:a977d0a3d81e 121
sam_grove 0:a977d0a3d81e 122 /** Write a single byte to the BufferedSerial Port.
sam_grove 0:a977d0a3d81e 123 * @param c The byte to write to the Serial Port
sam_grove 2:7e8a450a9101 124 * @return The byte that was written to the Serial Port Buffer
sam_grove 0:a977d0a3d81e 125 */
sam_grove 0:a977d0a3d81e 126 virtual int putc(int c);
sam_grove 0:a977d0a3d81e 127
sam_grove 0:a977d0a3d81e 128 /** Write a string to the BufferedSerial Port. Must be NULL terminated
sam_grove 0:a977d0a3d81e 129 * @param s The string to write to the Serial Port
sam_grove 2:7e8a450a9101 130 * @return The number of bytes written to the Serial Port Buffer
sam_grove 0:a977d0a3d81e 131 */
sam_grove 0:a977d0a3d81e 132 virtual int puts(const char *s);
sam_grove 0:a977d0a3d81e 133
sam_grove 0:a977d0a3d81e 134 /** Write a formatted string to the BufferedSerial Port.
sam_grove 0:a977d0a3d81e 135 * @param format The string + format specifiers to write to the Serial Port
sam_grove 2:7e8a450a9101 136 * @return The number of bytes written to the Serial Port Buffer
sam_grove 0:a977d0a3d81e 137 */
sam_grove 0:a977d0a3d81e 138 virtual int printf(const char* format, ...);
sam_grove 0:a977d0a3d81e 139
sam_grove 2:7e8a450a9101 140 /** Write data to the Buffered Serial Port
sam_grove 2:7e8a450a9101 141 * @param s A pointer to data to send
sam_grove 2:7e8a450a9101 142 * @param length The amount of data being pointed to
sam_grove 2:7e8a450a9101 143 * @return The number of bytes written to the Serial Port Buffer
sam_grove 2:7e8a450a9101 144 */
sam_grove 2:7e8a450a9101 145 virtual ssize_t write(const void *s, std::size_t length);
sam_grove 0:a977d0a3d81e 146 };
sam_grove 0:a977d0a3d81e 147
sam_grove 0:a977d0a3d81e 148 #endif