nrf_rpc_serialize.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_RPC_SERIALIZE_H_
#define NRF_RPC_SERIALIZE_H_
 
#include <zephyr/net/buf.h>
#include <zephyr/sys/util.h>
#include <nrf_rpc_cbor.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF_RPC_SCRATCHPAD_ALIGN(size) WB_UP(size)
 
#define NRF_RPC_SCRATCHPAD_DECLARE(_scratchpad, _ctx)                                              \
        (_scratchpad)->ctx = _ctx;                                                                 \
        uint32_t _scratchpad_size = nrf_rpc_decode_uint(_ctx);                                     \
        uint32_t _scratchpad_data[NRF_RPC_SCRATCHPAD_ALIGN(_scratchpad_size) / sizeof(uint32_t)];  \
        net_buf_simple_init_with_data(&(_scratchpad)->buf, _scratchpad_data, _scratchpad_size);    \
        net_buf_simple_reset(&(_scratchpad)->buf)
 
struct nrf_rpc_scratchpad {
        /* CBOR decoding context */
        struct nrf_rpc_cbor_ctx *ctx;
 
        struct net_buf_simple buf;
};
 
static inline void *nrf_rpc_scratchpad_add(struct nrf_rpc_scratchpad *scratchpad, size_t size)
{
        return net_buf_simple_add(&scratchpad->buf, NRF_RPC_SCRATCHPAD_ALIGN(size));
}
 
void nrf_rpc_encode_null(struct nrf_rpc_cbor_ctx *ctx);
 
void nrf_rpc_encode_undefined(struct nrf_rpc_cbor_ctx *ctx);
 
void nrf_rpc_encode_bool(struct nrf_rpc_cbor_ctx *ctx, bool value);
 
void nrf_rpc_encode_uint(struct nrf_rpc_cbor_ctx *ctx, uint32_t value);
 
void nrf_rpc_encode_int(struct nrf_rpc_cbor_ctx *ctx, int32_t value);
 
void nrf_rpc_encode_uint64(struct nrf_rpc_cbor_ctx *ctx, uint64_t value);
 
void nrf_rpc_encode_int64(struct nrf_rpc_cbor_ctx *ctx, int64_t value);
 
void nrf_rpc_encode_str(struct nrf_rpc_cbor_ctx *ctx, const char *value, int len);
 
void nrf_rpc_encode_buffer(struct nrf_rpc_cbor_ctx *ctx, const void *data, size_t size);
 
void nrf_rpc_encode_callback(struct nrf_rpc_cbor_ctx *ctx, void *callback);
 
static inline void nrf_rpc_encode_callback_call(struct nrf_rpc_cbor_ctx *ctx, uint32_t slot)
{
        nrf_rpc_encode_uint(ctx, slot);
}
 
void nrf_rpc_encoder_invalid(struct nrf_rpc_cbor_ctx *ctx);
 
void nrf_rpc_decode_skip(struct nrf_rpc_cbor_ctx *ctx);
 
bool nrf_rpc_decode_is_null(struct nrf_rpc_cbor_ctx *ctx);
 
bool nrf_rpc_decode_is_undefined(struct nrf_rpc_cbor_ctx *ctx);
 
bool nrf_rpc_decode_bool(struct nrf_rpc_cbor_ctx *ctx);
 
uint32_t nrf_rpc_decode_uint(struct nrf_rpc_cbor_ctx *ctx);
 
int32_t nrf_rpc_decode_int(struct nrf_rpc_cbor_ctx *ctx);
 
uint64_t nrf_rpc_decode_uint64(struct nrf_rpc_cbor_ctx *ctx);
 
int64_t nrf_rpc_decode_int64(struct nrf_rpc_cbor_ctx *ctx);
 
char *nrf_rpc_decode_str(struct nrf_rpc_cbor_ctx *ctx, char *buffer, size_t buffer_size);
 
char *nrf_rpc_decode_str_into_scratchpad(struct nrf_rpc_scratchpad *scratchpad, size_t *len);
 
void *nrf_rpc_decode_buffer(struct nrf_rpc_cbor_ctx *ctx, void *buffer, size_t buffer_size);
 
const void *nrf_rpc_decode_buffer_ptr_and_size(struct nrf_rpc_cbor_ctx *ctx, size_t *size);
 
void *nrf_rpc_decode_buffer_into_scratchpad(struct nrf_rpc_scratchpad *scratchpad, size_t *len);
 
void *nrf_rpc_decode_callbackd(struct nrf_rpc_cbor_ctx *ctx, void *handler);
 
void *nrf_rpc_decode_callback_call(struct nrf_rpc_cbor_ctx *ctx);
 
void nrf_rpc_decoder_invalid(struct nrf_rpc_cbor_ctx *ctx, int err);
 
bool nrf_rpc_decode_valid(const struct nrf_rpc_cbor_ctx *ctx);
 
bool nrf_rpc_decoding_done_and_check(const struct nrf_rpc_group *group,
                                     struct nrf_rpc_cbor_ctx *ctx);
 
void nrf_rpc_rsp_decode_bool(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                             void *handler_data);
 
void nrf_rpc_rsp_decode_uint(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                             void *result, size_t result_size);
 
void nrf_rpc_rsp_decode_u8(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                           void *handler_data);
 
void nrf_rpc_rsp_decode_u16(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                            void *handler_data);
 
void nrf_rpc_rsp_decode_u32(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                            void *handler_data);
 
void nrf_rpc_rsp_decode_int(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                            void *result, size_t result_size);
 
void nrf_rpc_rsp_decode_i8(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                           void *handler_data);
 
void nrf_rpc_rsp_decode_i16(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                            void *handler_data);
 
void nrf_rpc_rsp_decode_i32(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                            void *handler_data);
 
void nrf_rpc_rsp_decode_void(const struct nrf_rpc_group *group, struct nrf_rpc_cbor_ctx *ctx,
                             void *handler_data);
 
void nrf_rpc_rsp_send_int(const struct nrf_rpc_group *group, int32_t response);
 
void nrf_rpc_rsp_send_uint(const struct nrf_rpc_group *group, uint32_t response);
 
void nrf_rpc_rsp_send_bool(const struct nrf_rpc_group *group, bool response);
 
void nrf_rpc_rsp_send_void(const struct nrf_rpc_group *group);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_RPC_SERIALIZE_H_ */