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 
38 //! @addtogroup rpmsg_ns
39 //! @{
40 
41 #define RL_NS_EPT_ADDR (0x35u)
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 
50 /*! \typedef rpmsg_ns_new_ept_cb
51     \brief New endpoint NS callback function type.
52 */
53 typedef void (*rpmsg_ns_new_ept_cb)(uint32_t new_ept, const char *new_ept_name, uint32_t flags, void *user_data);
54 
55 struct rpmsg_ns_callback_data
56 {
57     rpmsg_ns_new_ept_cb cb;
58     void *user_data;
59 };
60 
61 struct rpmsg_ns_context
62 {
63     struct rpmsg_lite_endpoint *ept;
64     struct rpmsg_ns_callback_data *cb_ctxt;
65 };
66 
67 typedef struct rpmsg_ns_context *rpmsg_ns_handle;
68 
69 struct rpmsg_ns_static_context_container
70 {
71     struct rpmsg_lite_ept_static_context ept_ctxt;
72     struct rpmsg_ns_callback_data cb_ctxt;
73     struct rpmsg_ns_context ns_ctxt;
74 };
75 
76 typedef struct rpmsg_ns_static_context_container rpmsg_ns_static_context;
77 
78 #if defined(__cplusplus)
79 extern "C" {
80 #endif
81 
82 /*******************************************************************************
83  * API
84  ******************************************************************************/
85 
86 /* Exported API functions */
87 
88 /*!
89  * @brief Registers application nameservice callback
90  *
91  * @param rpmsg_lite_dev    RPMsg-Lite instance
92  * @param app_cb            Application nameservice callback
93  * @param user_data         Application nameservice callback data
94  * @param ns_ept_ctxt       Nameservice endpoint preallocated context pointer, used in case of static api
95  * (RL_USE_STATIC_API)
96  *
97  * @return RL_NULL on error, NameService handle on success.
98  *
99  */
100 #if defined(RL_USE_STATIC_API) && (RL_USE_STATIC_API == 1)
101 rpmsg_ns_handle rpmsg_ns_bind(struct rpmsg_lite_instance *rpmsg_lite_dev,
102                               rpmsg_ns_new_ept_cb app_cb,
103                               void *user_data,
104                               rpmsg_ns_static_context *ns_ept_ctxt);
105 #else
106 rpmsg_ns_handle rpmsg_ns_bind(struct rpmsg_lite_instance *rpmsg_lite_dev, rpmsg_ns_new_ept_cb app_cb, void *user_data);
107 #endif /* RL_USE_STATIC_API */
108 
109 /*!
110  * @brief Unregisters application nameservice callback and cleans up
111  *
112  * @param rpmsg_lite_dev    RPMsg-Lite instance
113  * @param handle            NameService handle
114  *
115  * @return Status of function execution, RL_SUCCESS on success.
116  *
117  */
118 int32_t rpmsg_ns_unbind(struct rpmsg_lite_instance *rpmsg_lite_dev, rpmsg_ns_handle handle);
119 
120 /*!
121  * @brief Sends name service announcement to remote device
122  *
123  * @param rpmsg_lite_dev    RPMsg-Lite instance
124  * @param new_ept           New endpoint to announce
125  * @param ept_name          Name for the announced endpoint
126  * @param flags             Channel creation/deletion flags
127  *
128  * @return Status of function execution, RL_SUCCESS on success
129  *
130  */
131 int32_t rpmsg_ns_announce(struct rpmsg_lite_instance *rpmsg_lite_dev,
132                           struct rpmsg_lite_endpoint *new_ept,
133                           const char *ept_name,
134                           uint32_t flags);
135 
136 //! @}
137 
138 #if defined(__cplusplus)
139 }
140 #endif
141 
142 #endif /* RPMSG_NS_H_ */
143