eRPC API Reference  Rev. 1.9.0
NXP Semiconductors
erpc_rpmsg_lite_transport.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016, Freescale Semiconductor, Inc.
3  * Copyright 2016-2021 NXP
4  * All rights reserved.
5  *
6  *
7  * SPDX-License-Identifier: BSD-3-Clause
8  */
9 
10 #ifndef _EMBEDDED_RPC__RPMSG_LITE_TRANSPORT_H_
11 #define _EMBEDDED_RPC__RPMSG_LITE_TRANSPORT_H_
12 
13 #include "erpc_config_internal.h"
14 #include "erpc_message_buffer.h"
16 #include "erpc_static_queue.h"
17 
18 #include "rpmsg_lite.h"
19 
26 // Definitions
29 
31 // Classes
33 
34 namespace erpc {
41 {
42 public:
48  RPMsgTransport(void);
49 
53  virtual ~RPMsgTransport(void);
54 
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 
88  virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t rpmsg_link_id,
89  void (*ready_cb)(void), char *nameservice_name);
90 
100  virtual erpc_status_t receive(MessageBuffer *message);
101 
110  virtual erpc_status_t send(MessageBuffer *message);
111 
119  virtual bool hasMessage(void) { return m_messageQueue.size(); }
120 
121 protected:
135  static int32_t rpmsg_read_cb(void *payload, uint32_t payload_len, uint32_t src, void *priv);
136 
140  uint32_t m_dst_addr;
141  struct rpmsg_lite_endpoint *m_rpmsg_ept;
142 };
143 
144 } // namespace erpc
145 
148 #endif // _EMBEDDED_RPC__RPMSG_LITE_TRANSPORT_H_
static int32_t rpmsg_read_cb(void *payload, uint32_t payload_len, uint32_t src, void *priv)
RPMSG callback for receiving data.
Definition: erpc_rpmsg_lite_transport.cpp:28
virtual ~RPMsgTransport(void)
RPMsgTransport destructor.
Definition: erpc_rpmsg_lite_transport.cpp:47
enum _erpc_status erpc_status_t
Type used for all status and error return values.
Definition: erpc_common.h:87
struct rpmsg_lite_endpoint * m_rpmsg_ept
Definition: erpc_rpmsg_lite_transport.h:141
RPMsgTransport(void)
Constructor.
Definition: erpc_rpmsg_lite_transport.cpp:40
virtual bool hasMessage(void)
Function to check if is message in receive queue and wait for processing.
Definition: erpc_rpmsg_lite_transport.h:119
StaticQueue< MessageBuffer, ERPC_DEFAULT_BUFFERS_COUNT > m_messageQueue
Definition: erpc_rpmsg_lite_transport.h:138
virtual erpc_status_t receive(MessageBuffer *message)
Set message to first received message.
Definition: erpc_rpmsg_lite_transport.cpp:201
Represents a memory buffer containing a message.
Definition: erpc_message_buffer.h:37
Definition: erpc_arbitrated_client_manager.h:25
virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t length, uint32_t rpmsg_link_id)
Initialization of RPMsgTransport layer - as RPMsg master.
Definition: erpc_rpmsg_lite_transport.cpp:72
Transport that uses RPMsg zero copy API for interprocessor messaging.
Definition: erpc_rpmsg_lite_transport.h:40
uint32_t m_dst_addr
Definition: erpc_rpmsg_lite_transport.h:140
Transport that other RPMsg transports inherits.
Definition: erpc_rpmsg_lite_base_transport.h:49
virtual erpc_status_t send(MessageBuffer *message)
Function to send prepared message.
Definition: erpc_rpmsg_lite_transport.cpp:210
Template class which implements static queue as ring buffer.
Definition: erpc_static_queue.h:32