eRPC API Reference  Rev. 1.11.0
NXP Semiconductors
erpc_rpmsg_tty_rtos_transport.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Freescale Semiconductor, Inc.
3  * Copyright 2020 NXP
4  * All rights reserved.
5  *
6  *
7  * SPDX-License-Identifier: BSD-3-Clause
8  */
9 
10 #ifndef _EMBEDDED_RPC__RPMSG_LITE_TTY_RTOS_TRANSPORT_H_
11 #define _EMBEDDED_RPC__RPMSG_LITE_TTY_RTOS_TRANSPORT_H_
12 
13 #include "erpc_crc16.hpp"
14 #include "erpc_message_buffer.hpp"
16 
17 extern "C" {
18 #include "rpmsg_lite.h"
19 #include "rpmsg_queue.h"
20 }
21 
28 // Definitions
31 
33 // Classes
35 
36 namespace erpc {
44 {
45 public:
52 
56  virtual ~RPMsgTTYRTOSTransport(void);
57 
73  virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t length,
74  uint32_t rpmsg_link_id);
75 
94  virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t rpmsg_link_id,
95  void (*ready_cb)(void), char *nameservice_name);
96 
108  virtual erpc_status_t receive(MessageBuffer *message);
109 
118  virtual erpc_status_t send(MessageBuffer *message);
119 
125  virtual void setCrc16(Crc16 *crcImpl);
126 
132  virtual Crc16 *getCrc16(void);
133 
134 protected:
135  uint32_t m_dst_addr;
136  rpmsg_queue_handle m_rpmsg_queue;
137  struct rpmsg_lite_endpoint *m_rpmsg_ept;
139 };
140 
141 } // namespace erpc
142 
145 #endif // _EMBEDDED_RPC__RPMSG_LITE_TTY_RTOS_TRANSPORT_H_
uint32_t m_dst_addr
Definition: erpc_rpmsg_tty_rtos_transport.hpp:135
Transport that uses RPMsg zero copy RTOS API for interprocessor messaging.
Definition: erpc_rpmsg_tty_rtos_transport.hpp:43
enum _erpc_status erpc_status_t
Type used for all status and error return values.
Definition: erpc_common.h:85
RPMsgTTYRTOSTransport(void)
Constructor.
Definition: erpc_rpmsg_tty_rtos_transport.cpp:33
struct rpmsg_lite_endpoint * m_rpmsg_ept
Definition: erpc_rpmsg_tty_rtos_transport.hpp:137
Crc16 * m_crcImpl
CRC object.
Definition: erpc_rpmsg_tty_rtos_transport.hpp:138
Represents a memory buffer containing a message.
Definition: erpc_message_buffer.hpp:37
virtual erpc_status_t send(MessageBuffer *message)
Function to send prepared message.
Definition: erpc_rpmsg_tty_rtos_transport.cpp:291
Definition: erpc_arbitrated_client_manager.hpp:25
virtual void setCrc16(Crc16 *crcImpl)
This functions sets the CRC-16 implementation.
Definition: erpc_rpmsg_tty_rtos_transport.cpp:75
Class for compute crc16.
Definition: erpc_crc16.hpp:29
rpmsg_queue_handle m_rpmsg_queue
Definition: erpc_rpmsg_tty_rtos_transport.hpp:136
virtual Crc16 * getCrc16(void)
This functions gets the CRC-16 object.
Definition: erpc_rpmsg_tty_rtos_transport.cpp:81
Transport that other RPMsg transports inherits.
Definition: erpc_rpmsg_lite_base_transport.hpp:50
virtual erpc_status_t receive(MessageBuffer *message)
Store incoming message to message buffer.
Definition: erpc_rpmsg_tty_rtos_transport.cpp:255
virtual ~RPMsgTTYRTOSTransport(void)
RPMsgRTOSTransport destructor.
Definition: erpc_rpmsg_tty_rtos_transport.cpp:42
virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t length, uint32_t rpmsg_link_id)
This function call RPMsg rtos init function - as RPMsg master.
Definition: erpc_rpmsg_tty_rtos_transport.cpp:86