ssf_client.h File Reference

#include <stddef.h>
#include <stdint.h>
#include <sdfw/sdfw_services/ssf_errno.h>

Go to the source code of this file.

Data Structures
struct	ssf_client_raw_data
	Structure to hold a raw request or response. More...
struct	ssf_client_srvc
	SSF service definition (client). More...

Macros
#define	SSF_CLIENT_SERVICE_DEFINE(_name, _srvc_name, _req_encode, _rsp_decode)
	Define a read-only service definition object.

Typedefs
typedef int(*	request_encoder) (uint8_t *payload, size_t payload_len, void *input, size_t *payload_len_out)
	SSF request encode function prototype. Function of this type are typically generated from cddl with zcbor.
typedef int(*	response_decoder) (const uint8_t *payload, size_t payload_len, void *result, size_t *payload_len_out)
	SSF response decode function prototype. Function of this type are typically generated from cddl with zcbor.

Functions
int	ssf_client_init (void)
	Initialize SDFW Service Framework. This will initialize underlying transport and wait for remote domains to establish connection.
int	ssf_client_send_request (const struct ssf_client_srvc *srvc, void *req, void *decoded_rsp, const uint8_t **rsp_pkt)
	Send a request and wait for a response.
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)
	Send a raw byte string request and wait for a response.
void	ssf_client_decode_done (const uint8_t *rsp_pkt)
	Free transport layer response buffer when decoding of response is finished.