| /* |
| * Copyright (c) 2018, The OpenThread Authors. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. Neither the name of the copyright holder nor the |
| * names of its contributors may be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| /** |
| * @file |
| * This file includes definitions for the HDLC interface to radio (RCP). |
| */ |
| |
| #ifndef POSIX_APP_HDLC_INTERFACE_HPP_ |
| #define POSIX_APP_HDLC_INTERFACE_HPP_ |
| |
| #include "openthread-posix-config.h" |
| #include "platform-posix.h" |
| #include "lib/hdlc/hdlc.hpp" |
| #include "lib/spinel/openthread-spinel-config.h" |
| #include "lib/spinel/spinel_interface.hpp" |
| |
| #if OPENTHREAD_POSIX_CONFIG_RCP_BUS == OT_POSIX_RCP_BUS_UART |
| |
| namespace ot { |
| namespace Posix { |
| |
| /** |
| * This class defines an HDLC interface to the Radio Co-processor (RCP) |
| * |
| */ |
| class HdlcInterface |
| { |
| public: |
| /** |
| * This constructor initializes the object. |
| * |
| * @param[in] aCallback Callback on frame received |
| * @param[in] aCallbackContext Callback context |
| * @param[in] aFrameBuffer A reference to a `RxFrameBuffer` object. |
| * |
| */ |
| HdlcInterface(Spinel::SpinelInterface::ReceiveFrameCallback aCallback, |
| void * aCallbackContext, |
| Spinel::SpinelInterface::RxFrameBuffer & aFrameBuffer); |
| |
| /** |
| * This destructor deinitializes the object. |
| * |
| */ |
| ~HdlcInterface(void); |
| |
| /** |
| * This method initializes the interface to the Radio Co-processor (RCP) |
| * |
| * @note This method should be called before reading and sending spinel frames to the interface. |
| * |
| * @param[in] aRadioUrl RadioUrl parsed from radio url. |
| * |
| * @retval OT_ERROR_NONE The interface is initialized successfully |
| * @retval OT_ERROR_ALREADY The interface is already initialized. |
| * @retval OT_ERROR_INVALID_ARGS The UART device or executable cannot be found or failed to open/run. |
| * |
| */ |
| otError Init(const Url::Url &aRadioUrl); |
| |
| /** |
| * This method deinitializes the interface to the RCP. |
| * |
| */ |
| void Deinit(void); |
| |
| /** |
| * This method encodes and sends a spinel frame to Radio Co-processor (RCP) over the socket. |
| * |
| * This is blocking call, i.e., if the socket is not writable, this method waits for it to become writable for |
| * up to `kMaxWaitTime` interval. |
| * |
| * @param[in] aFrame A pointer to buffer containing the spinel frame to send. |
| * @param[in] aLength The length (number of bytes) in the frame. |
| * |
| * @retval OT_ERROR_NONE Successfully encoded and sent the spinel frame. |
| * @retval OT_ERROR_NO_BUFS Insufficient buffer space available to encode the frame. |
| * @retval OT_ERROR_FAILED Failed to send due to socket not becoming writable within `kMaxWaitTime`. |
| * |
| */ |
| otError SendFrame(const uint8_t *aFrame, uint16_t aLength); |
| |
| /** |
| * This method waits for receiving part or all of spinel frame within specified interval. |
| * |
| * @param[in] aTimeout The timeout value in microseconds. |
| * |
| * @retval OT_ERROR_NONE Part or all of spinel frame is received. |
| * @retval OT_ERROR_RESPONSE_TIMEOUT No spinel frame is received within @p aTimeout. |
| * |
| */ |
| otError WaitForFrame(uint64_t aTimeoutUs); |
| |
| /** |
| * This method updates the file descriptor sets with file descriptors used by the radio driver. |
| * |
| * @param[in,out] aReadFdSet A reference to the read file descriptors. |
| * @param[in,out] aWriteFdSet A reference to the write file descriptors. |
| * @param[in,out] aMaxFd A reference to the max file descriptor. |
| * @param[in,out] aTimeout A reference to the timeout. |
| * |
| */ |
| void UpdateFdSet(fd_set &aReadFdSet, fd_set &aWriteFdSet, int &aMaxFd, struct timeval &aTimeout); |
| |
| /** |
| * This method performs radio driver processing. |
| * |
| * @param[in] aContext The context containing fd_sets. |
| * |
| */ |
| void Process(const RadioProcessContext &aContext); |
| |
| #if OPENTHREAD_POSIX_VIRTUAL_TIME |
| /** |
| * This method process read data (decode the data). |
| * |
| * This method is intended only for virtual time simulation. Its behavior is similar to `Read()` but instead of |
| * reading the data from the radio socket, it uses the given data in @p `aEvent`. |
| * |
| * @param[in] aEvent The data event. |
| * |
| */ |
| void Process(const VirtualTimeEvent &aEvent) { Decode(aEvent.mData, aEvent.mDataLength); } |
| #endif |
| |
| /** |
| * This method returns the bus speed between the host and the radio. |
| * |
| * @returns Bus speed in bits/second. |
| * |
| */ |
| uint32_t GetBusSpeed(void) const { return mBaudRate; } |
| |
| /** |
| * This method is called when RCP failure detected and resets internal states of the interface. |
| * |
| */ |
| void OnRcpReset(void); |
| |
| /** |
| * This method is called when RCP is reset to recreate the connection with it. |
| * |
| */ |
| otError ResetConnection(void); |
| |
| private: |
| /** |
| * This method instructs `HdlcInterface` to read and decode data from radio over the socket. |
| * |
| * If a full HDLC frame is decoded while reading data, this method invokes the `HandleReceivedFrame()` (on the |
| * `aCallback` object from constructor) to pass the received frame to be processed. |
| * |
| */ |
| void Read(void); |
| |
| /** |
| * This method waits for the socket file descriptor associated with the HDLC interface to become writable within |
| * `kMaxWaitTime` interval. |
| * |
| * @retval OT_ERROR_NONE Socket is writable. |
| * @retval OT_ERROR_FAILED Socket did not become writable within `kMaxWaitTime`. |
| * |
| */ |
| otError WaitForWritable(void); |
| |
| /** |
| * This method writes a given frame to the socket. |
| * |
| * This is blocking call, i.e., if the socket is not writable, this method waits for it to become writable for |
| * up to `kMaxWaitTime` interval. |
| * |
| * @param[in] aFrame A pointer to buffer containing the frame to write. |
| * @param[in] aLength The length (number of bytes) in the frame. |
| * |
| * @retval OT_ERROR_NONE Frame was written successfully. |
| * @retval OT_ERROR_FAILED Failed to write due to socket not becoming writable within `kMaxWaitTime`. |
| * |
| */ |
| otError Write(const uint8_t *aFrame, uint16_t aLength); |
| |
| /** |
| * This method performs HDLC decoding on received data. |
| * |
| * If a full HDLC frame is decoded while reading data, this method invokes the `HandleReceivedFrame()` (on the |
| * `aCallback` object from constructor) to pass the received frame to be processed. |
| * |
| * @param[in] aBuffer A pointer to buffer containing data. |
| * @param[in] aLength The length (number of bytes) in the buffer. |
| * |
| */ |
| void Decode(const uint8_t *aBuffer, uint16_t aLength); |
| |
| static void HandleHdlcFrame(void *aContext, otError aError); |
| void HandleHdlcFrame(otError aError); |
| |
| /** |
| * This method opens file specified by aRadioUrl. |
| * |
| * @param[in] aRadioUrl A reference to object containing path to file and data for configuring |
| * the connection with tty type file. |
| * |
| * @retval The file descriptor of newly opened file. |
| */ |
| int OpenFile(const Url::Url &aRadioUrl); |
| |
| /** |
| * This method closes file associated with the file descriptor. |
| * |
| */ |
| void CloseFile(void); |
| |
| #if OPENTHREAD_POSIX_CONFIG_RCP_PTY_ENABLE |
| static int ForkPty(const Url::Url &aRadioUrl); |
| #endif |
| |
| enum |
| { |
| kMaxFrameSize = Spinel::SpinelInterface::kMaxFrameSize, |
| kMaxWaitTime = 2000, ///< Maximum wait time in Milliseconds for socket to become writable (see `SendFrame`). |
| kResetTimeout = 5000, ///< Maximum wait time in Milliseconds for file to become ready (see `ResetConnection`). |
| kOpenFileDelay = 500, ///< Delay between open file calls, in Milliseconds (see `ResetConnection`). |
| kRemoveRcpDelay = |
| 2000, ///< Delay for removing RCP device from host OS after hard reset (see `ResetConnection`). |
| }; |
| |
| Spinel::SpinelInterface::ReceiveFrameCallback mReceiveFrameCallback; |
| void * mReceiveFrameContext; |
| Spinel::SpinelInterface::RxFrameBuffer & mReceiveFrameBuffer; |
| |
| int mSockFd; |
| uint32_t mBaudRate; |
| Hdlc::Decoder mHdlcDecoder; |
| const Url::Url *mRadioUrl; |
| |
| // Non-copyable, intentionally not implemented. |
| HdlcInterface(const HdlcInterface &); |
| HdlcInterface &operator=(const HdlcInterface &); |
| }; |
| |
| } // namespace Posix |
| } // namespace ot |
| |
| #endif // OPENTHREAD_POSIX_CONFIG_RCP_BUS == OT_POSIX_RCP_BUS_UART |
| #endif // POSIX_APP_HDLC_INTERFACE_HPP_ |