ssf_client_notif.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef SSF_CLIENT_NOTIF_H__
#define SSF_CLIENT_NOTIF_H__
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include <sdfw/sdfw_services/ssf_errno.h>
 
typedef int (*ssf_notif_decoder)(const uint8_t *payload, size_t payload_len, void *result,
                                 size_t *payload_len_out);
 
struct ssf_notification {
        /* Notification data start */
        const uint8_t *data;
        /* Length of notification data */
        size_t data_len;
        /*
         * Start of received packet. For releasing underlying buffer
         * with ssf_client_transport_decoding_done.
         */
        const uint8_t *pkt;
        /* Notification packet decoder */
        ssf_notif_decoder notif_decode;
};
 
typedef int (*ssf_notif_handler)(struct ssf_notification *notif, void *context);
 
struct ssf_client_notif_listener {
        /* Service ID */
        uint16_t id;
        /* Client's version number for the service */
        uint16_t version;
        /* Packet decoder for notification */
        ssf_notif_decoder notif_decode;
        /* Handler for notification */
        ssf_notif_handler handler;
        /* Optional user context */
        void *context;
        /* Is listener registered */
        bool is_registered;
};
 
#define SSF_CLIENT_NOTIF_LISTENER_DEFINE(_name, _srvc_name, _notif_decode, _handler)               \
        static int _handler(struct ssf_notification *notif, void *context);                        \
        static struct ssf_client_notif_listener _name = {                                          \
                .id = (CONFIG_SSF_##_srvc_name##_SERVICE_ID),                                      \
                .version = (CONFIG_SSF_##_srvc_name##_SERVICE_VERSION),                            \
                .notif_decode = (ssf_notif_decoder)_notif_decode,                                  \
                .handler = _handler,                                                               \
                .is_registered = false                                                             \
        }
 
int ssf_client_notif_decode(const struct ssf_notification *notif, void *decoded_notif);
 
void ssf_client_notif_decode_done(struct ssf_notification *notif);
 
int ssf_client_notif_register(struct ssf_client_notif_listener *listener, void *context);
 
int ssf_client_notif_deregister(struct ssf_client_notif_listener *listener);
 
#endif /* SSF_CLIENT_NOTIF_H__ */