ssf_client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef SSF_CLIENT_H__
#define SSF_CLIENT_H__
 
#include <stddef.h>
#include <stdint.h>
 
#include <sdfw/sdfw_services/ssf_errno.h>
 
struct ssf_client_raw_data {
        uint8_t *data;
        size_t len;
};
 
typedef int (*request_encoder)(uint8_t *payload, size_t payload_len, void *input,
                               size_t *payload_len_out);
 
typedef int (*response_decoder)(const uint8_t *payload, size_t payload_len, void *result,
                                size_t *payload_len_out);
 
struct ssf_client_srvc {
        /* Service ID (unique) */
        uint16_t id;
        /* Client's version number */
        uint16_t version;
        /* Request encoder */
        request_encoder req_encode;
        /* Response decoder */
        response_decoder rsp_decode;
        /* Request buffer size */
        size_t req_buf_size;
};
 
#define SSF_CLIENT_SERVICE_DEFINE(_name, _srvc_name, _req_encode, _rsp_decode)                     \
        static const struct ssf_client_srvc _name = {                                              \
                .id = (CONFIG_SSF_##_srvc_name##_SERVICE_ID),                                      \
                .version = (CONFIG_SSF_##_srvc_name##_SERVICE_VERSION),                            \
                .req_encode = (request_encoder)_req_encode,                                        \
                .rsp_decode = (response_decoder)_rsp_decode,                                       \
                .req_buf_size = (CONFIG_SSF_##_srvc_name##_SERVICE_BUFFER_SIZE)                    \
        }
 
int ssf_client_init(void);
 
int ssf_client_send_request(const struct ssf_client_srvc *srvc, void *req, void *decoded_rsp,
                            const uint8_t **rsp_pkt);
 
int ssf_client_send_raw_request(const struct ssf_client_srvc *srvc,
                                struct ssf_client_raw_data raw_req,
                                struct ssf_client_raw_data *raw_rsp);
 
void ssf_client_decode_done(const uint8_t *rsp_pkt);
 
#endif /* SSF_CLIENT_H__ */