ZAF_CmdPublisher.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef _CMD_PUBLISHER_H_
#define _CMD_PUBLISHER_H_
 
#include <stdint.h>
#include <stdbool.h>
 
// These following defines must be aligned with the structs in the private implementation
#define ZAF_CP_HEADER_SIZE 4
#define ZAF_CP_ELEMENT_SIZE 16
 
// Calculate size of storage
#define ZAF_CP_STORAGE_SIZE(num_elements) (ZAF_CP_HEADER_SIZE + (num_elements) * ZAF_CP_ELEMENT_SIZE)
 
// Statically allocate storage at a word boundary (or any other boundary if needed)
#define ZAF_CP_STORAGE(name, num_elements) union { void *align; uint8_t storage[ZAF_CP_STORAGE_SIZE(num_elements)]; } name
 
typedef void * CP_Handle_t;
 
typedef void (*zaf_cp_subscriberFunction_t)(void *pSubscriberContext, void* pRxPackage);
 
CP_Handle_t ZAF_CP_Init(void *pStorage, uint8_t numSubscribers);
 
bool ZAF_CP_SubscribeToAll(CP_Handle_t handle,
                           void* pSubscriberContext,
                           zaf_cp_subscriberFunction_t pFunction);
 
bool ZAF_CP_SubscribeToCC(CP_Handle_t handle,
                          void* pSubscriberContext,
                          zaf_cp_subscriberFunction_t pFunction,
                          uint16_t CmdClass);
 
bool ZAF_CP_SubscribeToCmd(CP_Handle_t handle,
                           void* pSubscriberContext,
                           zaf_cp_subscriberFunction_t pFunction,
                           uint16_t CmdClass,
                           uint8_t Cmd);
 
bool ZAF_CP_UnsubscribeToAll(CP_Handle_t handle,
                             void* pSubscriberContext,
                             zaf_cp_subscriberFunction_t pFunction);
 
bool ZAF_CP_UnsubscribeToCC(CP_Handle_t handle,
                            void* pSubscriberContext,
                            zaf_cp_subscriberFunction_t pFunction,
                            uint16_t CmdClass);
bool ZAF_CP_UnsubscribeToCmd(CP_Handle_t handle,
                             void* pSubscriberContext,
                             zaf_cp_subscriberFunction_t pFunction,
                             uint16_t CmdClass,
                             uint8_t Cmd);
 
void ZAF_CP_CommandPublish(CP_Handle_t handle, void* pRxPackage);
 
#endif /* _CMD_PUBLISHER_H_ */