eRPC API Reference  Rev. 1.11.0
NXP Semiconductors
erpc_rpmsg_lite_rtos_transport.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016, Freescale Semiconductor, Inc.
3  * Copyright 2016-2022 NXP
4  * All rights reserved.
5  *
6  *
7  * SPDX-License-Identifier: BSD-3-Clause
8  */
9 
10 #ifndef _EMBEDDED_RPC__RPMSG_LITE_RTOS_TRANSPORT_H_
11 #define _EMBEDDED_RPC__RPMSG_LITE_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 {
43 {
44 public:
50  RPMsgRTOSTransport(void);
51 
55  virtual ~RPMsgRTOSTransport(void);
56 
69  virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t length,
70  uint32_t rpmsg_link_id);
71 
86  virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t rpmsg_link_id,
87  void (*ready_cb)(void), char *nameservice_name);
88 
99  virtual erpc_status_t receive(MessageBuffer *message);
100 
109  virtual erpc_status_t send(MessageBuffer *message);
110 
116  virtual void setCrc16(Crc16 *crcImpl);
117 
123  virtual Crc16 *getCrc16(void);
131  virtual bool hasMessage(void) { return ((rpmsg_queue_get_current_size(m_rpmsg_queue) > 0) ? true : false); }
132 
133 protected:
134  /* Remote device */
135  struct remote_device *m_rdev;
136  struct rpmsg_channel *m_app_rp_chnl;
137  uint32_t m_dst_addr;
138  rpmsg_queue_handle m_rpmsg_queue;
139  struct rpmsg_lite_endpoint *m_rpmsg_ept;
141 };
142 
143 } // namespace erpc
144 
147 #endif // _EMBEDDED_RPC__RPMSG_LITE_RTOS_TRANSPORT_H_
virtual erpc_status_t receive(MessageBuffer *message)
Store incoming message to message buffer.
Definition: erpc_rpmsg_lite_rtos_transport.cpp:254
enum _erpc_status erpc_status_t
Type used for all status and error return values.
Definition: erpc_common.h:85
Crc16 * m_crcImpl
CRC object.
Definition: erpc_rpmsg_lite_rtos_transport.hpp:140
virtual void setCrc16(Crc16 *crcImpl)
This functions sets the CRC-16 implementation.
Definition: erpc_rpmsg_lite_rtos_transport.cpp:74
Transport that uses RPMsg zero copy RTOS API for interprocessor messaging.
Definition: erpc_rpmsg_lite_rtos_transport.hpp:42
virtual erpc_status_t send(MessageBuffer *message)
Function to send prepared message.
Definition: erpc_rpmsg_lite_rtos_transport.cpp:268
virtual Crc16 * getCrc16(void)
This functions gets the CRC-16 object.
Definition: erpc_rpmsg_lite_rtos_transport.cpp:80
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_lite_rtos_transport.cpp:85
uint32_t m_dst_addr
Definition: erpc_rpmsg_lite_rtos_transport.hpp:137
Represents a memory buffer containing a message.
Definition: erpc_message_buffer.hpp:37
Definition: erpc_arbitrated_client_manager.hpp:25
RPMsgRTOSTransport(void)
Constructor.
Definition: erpc_rpmsg_lite_rtos_transport.cpp:30
Class for compute crc16.
Definition: erpc_crc16.hpp:29
rpmsg_queue_handle m_rpmsg_queue
Definition: erpc_rpmsg_lite_rtos_transport.hpp:138
virtual ~RPMsgRTOSTransport(void)
RPMsgRTOSTransport destructor.
Definition: erpc_rpmsg_lite_rtos_transport.cpp:41
Transport that other RPMsg transports inherits.
Definition: erpc_rpmsg_lite_base_transport.hpp:50
virtual bool hasMessage(void)
Function to check if is message in receive queue and wait for processing.
Definition: erpc_rpmsg_lite_rtos_transport.hpp:131
struct rpmsg_lite_endpoint * m_rpmsg_ept
Definition: erpc_rpmsg_lite_rtos_transport.hpp:139
struct remote_device * m_rdev
Definition: erpc_rpmsg_lite_rtos_transport.hpp:135
struct rpmsg_channel * m_app_rp_chnl
Definition: erpc_rpmsg_lite_rtos_transport.hpp:136