mirror of https://github.com/ARMmbed/mbed-os.git
112 lines
3.1 KiB
C++
112 lines
3.1 KiB
C++
/* mbed Microcontroller Library
|
|
* Copyright (c) 2006-2017 ARM Limited
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef MBED_BUFFEREDSERIAL_H
|
|
#define MBED_BUFFEREDSERIAL_H
|
|
|
|
#include "platform/platform.h"
|
|
|
|
#if DEVICE_SERIAL
|
|
|
|
#include "FileHandle.h"
|
|
#include "SerialBase.h"
|
|
#include "InterruptIn.h"
|
|
#include "PlatformMutex.h"
|
|
#include "serial_api.h"
|
|
#include "CircularBuffer.h"
|
|
|
|
namespace mbed {
|
|
class BufferedSerial : private SerialBase, public FileHandle {
|
|
public:
|
|
/** Create a BufferedSerial port, connected to the specified transmit and receive pins, with a particular baud rate.
|
|
* @param tx Transmit pin
|
|
* @param rx Receive pin
|
|
* @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
|
|
*/
|
|
BufferedSerial(PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
|
|
virtual ~BufferedSerial();
|
|
|
|
/** Equivalent to POSIX poll(). Derived from FileHandle.
|
|
* Provides a mechanism to multiplex input/output over a set of file handles.
|
|
*/
|
|
virtual short poll(short events) const;
|
|
|
|
virtual ssize_t write(const void* buffer, size_t length);
|
|
|
|
virtual ssize_t read(void* buffer, size_t length);
|
|
|
|
/** Acquire mutex */
|
|
virtual void lock(void);
|
|
|
|
/** Release mutex */
|
|
virtual void unlock(void);
|
|
|
|
virtual int close();
|
|
|
|
virtual int isatty();
|
|
|
|
virtual off_t seek(off_t offset, int whence);
|
|
|
|
virtual int sync();
|
|
|
|
virtual int set_blocking(bool blocking) { _blocking = blocking; return 0; }
|
|
|
|
virtual void sigio(Callback<void()> func);
|
|
|
|
void set_data_carrier_detect(PinName DCD_pin, bool active_high=false);
|
|
|
|
|
|
private:
|
|
|
|
/** Software serial buffers
|
|
* By default buffer size is 256 for TX and 256 for RX. Configurable through mbed_app.json
|
|
*/
|
|
CircularBuffer<char, MBED_CONF_PLATFORM_BUFFERED_SERIAL_RXBUF_SIZE> _rxbuf;
|
|
CircularBuffer<char, MBED_CONF_PLATFORM_BUFFERED_SERIAL_TXBUF_SIZE> _txbuf;
|
|
|
|
PlatformMutex _mutex;
|
|
|
|
Callback<void()> _sigio_cb;
|
|
|
|
bool _blocking;
|
|
bool _tx_irq_enabled;
|
|
InterruptIn *_dcd;
|
|
|
|
/** Device Hanged up
|
|
* Determines if the device hanged up on us.
|
|
*
|
|
* @return True, if hanged up
|
|
*/
|
|
bool hup() const;
|
|
|
|
/** ISRs for serial
|
|
* Routines to handle interrupts on serial pins.
|
|
* Copies data into Circular Buffer.
|
|
* Reports the state change to File handle.
|
|
*/
|
|
void tx_irq(void);
|
|
void rx_irq(void);
|
|
|
|
void wake(void);
|
|
|
|
void DCD_IRQ(void);
|
|
};
|
|
} //namespace mbed
|
|
|
|
|
|
#endif //DEVICE_SERIAL
|
|
#endif /* MBED_BUFFEREDSERIAL_H */
|