eRPC API Reference  Rev. 1.11.0
NXP Semiconductors
erpc_rpmsg_lite_transport.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016, Freescale Semiconductor, Inc.
3  * Copyright 2016-2023 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_crc16.hpp"
14 #include "erpc_config_internal.h"
15 #include "erpc_message_buffer.hpp"
17 #include "erpc_static_queue.hpp"
18 
19 extern "C" {
20 #include "rpmsg_lite.h"
21 }
22 
29 // Definitions
32 
34 // Classes
36 
37 namespace erpc {
44 {
45 public:
51  RPMsgTransport(void);
52 
56  virtual ~RPMsgTransport(void);
57 
72  virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t length,
73  uint32_t rpmsg_link_id);
74 
91  virtual erpc_status_t init(uint32_t src_addr, uint32_t dst_addr, void *base_address, uint32_t rpmsg_link_id,
92  void (*ready_cb)(void), char *nameservice_name);
93 
103  virtual erpc_status_t receive(MessageBuffer *message);
104 
113  virtual erpc_status_t send(MessageBuffer *message);
114 
120  virtual void setCrc16(Crc16 *crcImpl);
121 
127  virtual Crc16 *getCrc16(void);
135  virtual bool hasMessage(void) { return ((0UL < m_messageQueue.size()) ? true: false); }
136 
137 protected:
151  static int32_t rpmsg_read_cb(void *payload, uint32_t payload_len, uint32_t src, void *priv);
152 
156  uint32_t m_dst_addr;
157  struct rpmsg_lite_endpoint *m_rpmsg_ept;
159 };
160 
161 } // namespace erpc
162 
165 #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:30
virtual ~RPMsgTransport(void)
RPMsgTransport destructor.
Definition: erpc_rpmsg_lite_transport.cpp:50
enum _erpc_status erpc_status_t
Type used for all status and error return values.
Definition: erpc_common.h:85
struct rpmsg_lite_endpoint * m_rpmsg_ept
Definition: erpc_rpmsg_lite_transport.hpp:157
RPMsgTransport(void)
Constructor.
Definition: erpc_rpmsg_lite_transport.cpp:42
virtual bool hasMessage(void)
Function to check if is message in receive queue and wait for processing.
Definition: erpc_rpmsg_lite_transport.hpp:135
virtual void setCrc16(Crc16 *crcImpl)
This functions sets the CRC-16 implementation.
Definition: erpc_rpmsg_lite_transport.cpp:75
virtual erpc_status_t receive(MessageBuffer *message)
Set message to first received message.
Definition: erpc_rpmsg_lite_transport.cpp:213
StaticQueue< MessageBuffer, 2U *ERPC_DEFAULT_BUFFERS_COUNT > m_messageQueue
Definition: erpc_rpmsg_lite_transport.hpp:154
Represents a memory buffer containing a message.
Definition: erpc_message_buffer.hpp:37
Definition: erpc_arbitrated_client_manager.hpp: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:86
Transport that uses RPMsg zero copy API for interprocessor messaging.
Definition: erpc_rpmsg_lite_transport.hpp:43
uint32_t m_dst_addr
Definition: erpc_rpmsg_lite_transport.hpp:156
Class for compute crc16.
Definition: erpc_crc16.hpp:29
virtual Crc16 * getCrc16(void)
This functions gets the CRC-16 object.
Definition: erpc_rpmsg_lite_transport.cpp:81
Transport that other RPMsg transports inherits.
Definition: erpc_rpmsg_lite_base_transport.hpp:50
Crc16 * m_crcImpl
CRC object.
Definition: erpc_rpmsg_lite_transport.hpp:158
virtual erpc_status_t send(MessageBuffer *message)
Function to send prepared message.
Definition: erpc_rpmsg_lite_transport.cpp:222
Template class which implements static queue as ring buffer.
Definition: erpc_static_queue.hpp:32