rpmsg_rpc_client_server.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, L&T Technology Services Ltd.
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef RPMSG_RPC_CLIENT_SERVER_H
#define RPMSG_RPC_CLIENT_SERVER_H
 
#include <openamp/open_amp.h>
#include <metal/compiler.h>
 
#if defined __cplusplus
extern "C" {
#endif
 
#define RPMSG_RPC_OK            0
#define RPMSG_RPC_INVALID_ID    (-1L)
#define RPMSG_RPC_SERVICE_NAME "rpmsg-rpc"
 
/* RPMSG_BUFFER_SIZE = 512
 * sizeof(struct rpmsg_hdr) = 16
 * RPMSG_BUFFER_SIZE - sizeof(struct rpmsg_hdr) - 1 = 495
 * Aligning to 64 bits -> 488UL
 */
#define MAX_BUF_LEN     488UL
#define MAX_FUNC_ID_LEN sizeof(uint32_t)
 
struct rpmsg_rpc_clt;
struct rpmsg_rpc_svr;
 
typedef void (*rpmsg_rpc_shutdown_cb)(struct rpmsg_rpc_clt *rpc);
typedef void (*app_cb)(struct rpmsg_rpc_clt *rpc, int status, void *data,
                       size_t len);
typedef int (*rpmsg_rpc_syscall_cb)(void *data, struct rpmsg_rpc_svr *rpcs);
 
struct rpmsg_rpc_request {
        uint32_t id;
        unsigned char params[MAX_BUF_LEN];
};
 
METAL_PACKED_BEGIN
struct rpmsg_rpc_answer {
        uint32_t id;
 
        int32_t status;
 
        unsigned char params[MAX_BUF_LEN];
} METAL_PACKED_END;
 
struct rpmsg_rpc_services {
        uint32_t id;
 
        rpmsg_rpc_syscall_cb cb_function;
};
 
struct rpmsg_rpc_client_services {
        uint32_t id;
 
        app_cb cb;
};
 
struct rpmsg_rpc_svr {
        struct rpmsg_endpoint ept;
 
        const struct rpmsg_rpc_services *services;
 
        unsigned int n_services;
};
 
struct rpmsg_rpc_clt {
        struct rpmsg_endpoint ept;
 
        rpmsg_rpc_shutdown_cb shutdown_cb;
 
        const struct rpmsg_rpc_client_services *services;
 
        unsigned int n_services;
};
 
void rpmsg_rpc_client_release(struct rpmsg_rpc_clt *rpc);
 
int rpmsg_rpc_client_init(struct rpmsg_rpc_clt *rpc,
                          struct rpmsg_device *rdev,
                          rpmsg_rpc_shutdown_cb shutdown_cb,
                          const struct rpmsg_rpc_client_services *services,
                          int len);
 
int rpmsg_rpc_server_init(struct rpmsg_rpc_svr *rpcs, struct rpmsg_device *rdev,
                          const struct rpmsg_rpc_services *services, int len,
                          rpmsg_ns_unbind_cb rpmsg_service_server_unbind);
 
int rpmsg_rpc_client_send(struct rpmsg_rpc_clt *rpc,
                          uint32_t rpc_id, void *request_param,
                          size_t req_param_size);
 
int rpmsg_rpc_server_send(struct rpmsg_rpc_svr *rpcs, uint32_t rpc_id,
                          int status, void *request_param,
                          size_t param_size);
 
#if defined __cplusplus
}
#endif
 
#endif /* RPMSG_RPC_CLIENT_SERVER_H */