NuMaker RS485 lib
Dependents: NuMaker-mbed-modbus-sample
MyUnbufferedSerial.h
- Committer:
- morgandu
- Date:
- 4 months ago
- Revision:
- 6:531888b928d6
- Parent:
- 4:3bdf456890b6
File content as of revision 6:531888b928d6:
/* mbed Microcontroller Library * Copyright (c) 2019 ARM Limited * SPDX-License-Identifier: Apache-2.0 * * 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_MYUNBUFFERED_SERIAL_H #define MBED_MYUNBUFFERED_SERIAL_H #include "mbed.h" #if (MBED_MAJOR_VERSION >= 6) #include "platform/platform.h" #if DEVICE_SERIAL || defined(DOXYGEN_ONLY) #include <cstdarg> #include "drivers/SerialBase.h" #include "platform/FileHandle.h" #include "platform/mbed_toolchain.h" #include "platform/NonCopyable.h" namespace mbed { /** \defgroup drivers-public-api-uart UART * \ingroup drivers-public-api */ /** * \defgroup drivers_MyUnbufferedSerial MyUnbufferedSerial class * \ingroup drivers-public-api-uart * @{ */ /** * Class implementation for unbuffered I/O for an interrupt driven application * or one that needs to have more control. */ class MyUnbufferedSerial: public SerialBase, public FileHandle, private NonCopyable<MyUnbufferedSerial> { public: /** * Create a serial port instance connected to the specified transmit and * receive pins, with the specified 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) * * @note * Either tx or rx may be specified as NC if unused */ MyUnbufferedSerial( PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE ); /** Create a MyUnbufferedSerial port, connected to the specified transmit and * receive pins, with a particular baud rate. * @param static_pinmap reference to structure which holds static pinmap * @param baud The baud rate of the serial port (optional, defaults to * MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE) */ MyUnbufferedSerial( const serial_pinmap_t &static_pinmap, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE ); /** Write the contents of a buffer to a file * * Blocks until all data is written * * @param buffer The buffer to write from * @param size The number of bytes to write * @return The number of bytes written */ ssize_t write(const void *buffer, size_t size) override; /** Read the contents of a file into a buffer * * Blocks and reads exactly one character * * @param buffer The buffer to read in to * @param size The number of bytes to read * @return The number of bytes read */ ssize_t read(void *buffer, size_t size) override; /** Move the file position to a given offset from from a given location * * Not valid for a device type FileHandle like MyUnbufferedSerial. * In case of MyUnbufferedSerial, returns ESPIPE * * @param offset The offset from whence to move to * @param whence The start of where to seek * SEEK_SET to start from beginning of file, * SEEK_CUR to start from current position in file, * SEEK_END to start from end of file * @return The new offset of the file, negative error code on failure */ off_t seek(off_t offset, int whence = SEEK_SET) override { return -ESPIPE; } /** Get the size of the file * * @return Size of the file in bytes */ off_t size() override { return -EINVAL; } /** Check if the file in an interactive terminal device * * @return True if the file is a terminal * @return False if the file is not a terminal * @return Negative error code on failure */ int isatty() override { return true; } /** Close a file * * @return 0 on success, negative error code on failure */ int close() override { return 0; } /** Enable or disable input * * Control enabling of device for input. This is primarily intended * for temporary power-saving; the overall ability of the device to operate * for input and/or output may be fixed at creation time, but this call can * allow input to be temporarily disabled to permit power saving without * losing device state. * * @param enabled true to enable input, false to disable. * * @return 0 on success * @return Negative error code on failure */ int enable_input(bool enabled) override; /** Enable or disable output * * Control enabling of device for output. This is primarily intended * for temporary power-saving; the overall ability of the device to operate * for input and/or output may be fixed at creation time, but this call can * allow output to be temporarily disabled to permit power saving without * losing device state. * * @param enabled true to enable output, false to disable. * * @return 0 on success * @return Negative error code on failure */ int enable_output(bool enabled) override; /** Check for poll event flags * Check the events listed in events to see if data can be read or written * without blocking. * Call is nonblocking - returns state of events. * * @param events bitmask of poll events we're interested in - POLLIN/POLLOUT etc. * * @returns bitmask of poll events that have occurred. */ short poll(short events) const override; using SerialBase::attach; using SerialBase::baud; using SerialBase::format; using SerialBase::readable; using SerialBase::writeable; using SerialBase::IrqCnt; using SerialBase::RxIrq; using SerialBase::TxIrq; #if DEVICE_SERIAL_FC // For now use the base enum - but in future we may have extra options // such as XON/XOFF or manual GPIO RTSCTS. using SerialBase::Flow; // In C++11, we wouldn't need to also have using directives for each value using SerialBase::Disabled; using SerialBase::RTS; using SerialBase::CTS; using SerialBase::RTSCTS; /** Set the flow control type on the serial port * * @param type the flow control type (Disabled, RTS, CTS, RTSCTS) * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS) * @param flow2 the second flow control pin (CTS for RTSCTS) */ void set_flow_control(Flow type, PinName flow1 = NC, PinName flow2 = NC); #endif // DEVICE_SERIAL_FC }; } // namespace mbed #endif // DEVICE_SERIAL || defined(DOXYGEN_ONLY) #endif // (MBED_MAJOR_VERSION >= 6 ) #endif // MBED_MYUNBUFFERED_SERIAL_H