RPMsg-Lite User's Guide  Rev. 2.2.0
NXP Semiconductors
rpmsg_ns.h
1 /*
2  * Copyright (c) 2014, Mentor Graphics Corporation
3  * Copyright (c) 2015 Xilinx, Inc.
4  * Copyright (c) 2016 Freescale Semiconductor, Inc.
5  * Copyright 2016 NXP
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice,
12  * this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  * 3. Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef _RPMSG_NS_H
34 #define _RPMSG_NS_H
35 
36 #include "rpmsg_lite.h"
37 
40 
41 #define RL_NS_EPT_ADDR (0x35)
42 
43 /* Up to 32 flags available */
44 enum rpmsg_ns_flags
45 {
46  RL_NS_CREATE = 0,
47  RL_NS_DESTROY = 1,
48 };
49 
53 typedef void (*rpmsg_ns_new_ept_cb)(unsigned int new_ept,
54  const char *new_ept_name,
55  unsigned long flags,
56  void *user_data);
57 
59 {
61  void *user_data;
62 };
63 
65 {
66  struct rpmsg_lite_endpoint *ept;
67  struct rpmsg_ns_callback_data *cb_ctxt;
68 };
69 
70 typedef struct rpmsg_ns_context *rpmsg_ns_handle;
71 
73 {
74  struct rpmsg_lite_ept_static_context ept_ctxt;
75  struct rpmsg_ns_callback_data cb_ctxt;
76  struct rpmsg_ns_context ns_ctxt;
77 };
78 
79 typedef struct rpmsg_ns_static_context_container rpmsg_ns_static_context;
80 
81 #if defined(__cplusplus)
82 extern "C" {
83 #endif
84 
85 /*******************************************************************************
86  * API
87  ******************************************************************************/
88 
89 /* Exported API functions */
90 
101 #if defined(RL_USE_STATIC_API) && (RL_USE_STATIC_API == 1)
102 rpmsg_ns_handle rpmsg_ns_bind(struct rpmsg_lite_instance *rpmsg_lite_dev,
103  rpmsg_ns_new_ept_cb app_cb,
104  void *user_data,
105  rpmsg_ns_static_context *ns_ept_ctxt);
106 #else
107 rpmsg_ns_handle rpmsg_ns_bind(struct rpmsg_lite_instance *rpmsg_lite_dev, rpmsg_ns_new_ept_cb app_cb, void *user_data);
108 #endif /* RL_USE_STATIC_API */
109 
119 int rpmsg_ns_unbind(struct rpmsg_lite_instance *rpmsg_lite_dev, rpmsg_ns_handle handle);
120 
132 int rpmsg_ns_announce(struct rpmsg_lite_instance *rpmsg_lite_dev,
133  struct rpmsg_lite_endpoint *new_ept,
134  char *ept_name,
135  unsigned long flags);
136 
138 
139 #if defined(__cplusplus)
140 }
141 #endif
142 
143 #endif /* _RPMSG_NS_H */
int rpmsg_ns_unbind(struct rpmsg_lite_instance *rpmsg_lite_dev, rpmsg_ns_handle handle)
Unregisters application nameservice callback and cleans up.
int rpmsg_ns_announce(struct rpmsg_lite_instance *rpmsg_lite_dev, struct rpmsg_lite_endpoint *new_ept, char *ept_name, unsigned long flags)
Sends name service announcement to remote device.
Definition: rpmsg_lite.h:124
Definition: rpmsg_ns.h:72
Definition: rpmsg_lite.h:112
Definition: rpmsg_ns.h:64
void(* rpmsg_ns_new_ept_cb)(unsigned int new_ept, const char *new_ept_name, unsigned long flags, void *user_data)
New endpoint NS callback function type.
Definition: rpmsg_ns.h:53
rpmsg_ns_handle rpmsg_ns_bind(struct rpmsg_lite_instance *rpmsg_lite_dev, rpmsg_ns_new_ept_cb app_cb, void *user_data)
Registers application nameservice callback.
Definition: rpmsg_ns.h:58
Definition: rpmsg_lite.h:100