fss_interfaces.h

/*
 * Copyright (c) 2025 Qualcomm Innovation Center, Inc. All Rights Reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _GS_FSS_INTERFACES_
#define _GS_FSS_INTERFACES_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
typedef char fssChar;
typedef int32_t fssInt32;
typedef uint64_t fssUint64;
typedef double fssFloat64;
 
typedef const fssChar* fssString;
typedef fssInt32 fssRetStatus;
typedef fssUint64 fssBusIfItemIndex;
typedef fssUint64 fssBusIfItemSize;
typedef fssFloat64 fssTimeInSec;
 
struct fssBindIf;
struct fssBusIf;
struct fssConfigIf;
struct fssEventsIf;
struct fssTimeSyncIf;
struct fssControlIf;
 
typedef fssBindIf* fssBindIFHandle;
typedef fssBusIf* fssBusIfHandle;
typedef fssConfigIf* fssConfigIfHandle;
typedef fssEventsIf* fssEventsIfHandle;
typedef fssTimeSyncIf* fssTimeSyncIfHandle;
typedef fssControlIf* fssControlIfHanlde;
typedef void* fssBusIfItemData;
 
fssRetStatus fssStatusOk = 0;
fssRetStatus fssStatusError = -1;
 
typedef struct {
    fssTimeInSec from;
    fssTimeInSec to;
} TimeWindow;
 
/******************************
 Declaration of function types
********************************/
 
typedef fssString (*fssGetConfigFnPtr)(fssConfigIfHandle configIfHandle, fssString name);
 
typedef void (*fssEventHandlerFnPtr)(fssEventsIfHandle eventsIfHandle, fssUint64 event);
 
typedef void (*fssUpdateTimeWindowFnPtr)(fssTimeSyncIfHandle timeSyncIfHandle, TimeWindow window);
 
typedef fssString (*fssDoCommandFnPtr)(fssControlIfHanlde controlIfHandle, fssString cmd);
 
typedef fssBusIfItemSize (*fssBusIfGetItemsNumberFnPtr)(fssBusIfHandle busIfHandle);
 
typedef fssString (*fssBusIfGetNameFromIndexFnPtr)(fssBusIfHandle busIfHandle, fssBusIfItemIndex index);
 
typedef fssBusIfItemSize (*fssBusIfGetSizeFnPtr)(fssBusIfHandle busIfHandle, fssBusIfItemIndex index);
 
typedef fssBusIfItemSize (*fssBusIfGetIndexFnPtr)(fssBusIfHandle busIfHandle, fssString name);
 
typedef fssBusIfItemIndex (*fssBusIfAddItemFnPtr)(fssBusIfHandle busIfHandle, fssString name, fssBusIfItemSize size);
 
typedef fssBusIfItemData (*fssBusIfGetItemFnPtr)(fssBusIfHandle busIfHandle, fssBusIfItemIndex index);
 
typedef void (*fssBusIfSetItemFnPtr)(fssBusIfHandle busIfHandle, fssBusIfItemIndex index, fssBusIfItemData data);
 
typedef void (*fssBusIfTransmitFnPtr)(fssBusIfHandle busIfHandle);
 
typedef fssRetStatus (*fssBindEventsIfFnPtr)(fssBindIFHandle bindIfHandle, fssString name,
                                             fssEventsIfHandle eventsIfHandle);
 
typedef fssRetStatus (*fssBindBusIfFnPtr)(fssBindIFHandle bindIfHandle, fssString name, fssBusIfHandle busIfHandle);
 
typedef fssRetStatus (*fssBindTimeSyncIfFnPtr)(fssBindIFHandle bindIfHandle, fssString name,
                                               fssTimeSyncIfHandle timeSyncIfHandle);
 
typedef fssRetStatus (*fssBindControlIfFnPtr)(fssBindIFHandle bindIfHandle, fssString name,
                                              fssControlIfHanlde controlIfHandle);
 
typedef fssEventsIfHandle (*fssGetEventsIfHandleFnPtr)(fssBindIFHandle bindIfHandle, fssString name);
 
typedef fssBusIfHandle (*fssGetBusIfFnPtr)(fssBindIFHandle bindIfHandle, fssString name);
 
typedef fssConfigIfHandle (*fssGetConfigIfFnPtr)(fssBindIFHandle bindIfHandle, fssString name);
 
typedef fssTimeSyncIfHandle (*fssGetTimeSyncIfHandleFnPtr)(fssBindIFHandle bindIfHandle, fssString name);
 
typedef fssControlIfHanlde (*fssGetControlIfHandleFnPtr)(fssBindIFHandle bindIfHandle, fssString name);
 
/******************************
 Declaration of interfaces
********************************/
 
typedef struct fssBusIf {
    fssUint64 version;
    fssBusIfGetItemsNumberFnPtr getNumber;
    fssBusIfGetNameFromIndexFnPtr getName;
    fssBusIfGetSizeFnPtr getSize;
    fssBusIfGetIndexFnPtr getIndex;
    fssBusIfAddItemFnPtr addItem;
    fssBusIfGetItemFnPtr getItem;
    fssBusIfSetItemFnPtr setItem;
    fssBusIfTransmitFnPtr transmit;
} fssBusIf;
 
typedef struct fssConfigIf {
    fssUint64 version;
    fssGetConfigFnPtr getConfigs;
} fssConfigIf;
 
typedef struct fssEventsIf {
    fssUint64 version;
    fssEventHandlerFnPtr handleEvents;
} fssEventsIf;
 
typedef struct fssTimeSyncIf {
    fssUint64 version;
    fssUpdateTimeWindowFnPtr updateTimeWindow;
} fssTimeSyncIf;
 
typedef struct fssControlIf {
    fssUint64 version;
    fssDoCommandFnPtr doCommand;
} fssControlIf;
 
typedef struct fssBindIf {
    fssUint64 version;
    fssBindEventsIfFnPtr bindEventsIf;
    fssBindBusIfFnPtr bindBusIf;
    fssBindTimeSyncIfFnPtr bindTimeSyncIf;
    fssBindControlIfFnPtr bindControlIf;
    fssGetEventsIfHandleFnPtr getEventsIfHandle;
    fssGetBusIfFnPtr getBusIfHandle;
    fssGetTimeSyncIfHandleFnPtr getTimeSyncIfHandle;
    fssGetControlIfHandleFnPtr getControlIfHandle;
} fssBindIf;
 
#if defined _WIN32 || defined __CYGWIN__
#define fssExport __attribute__((dllexport))
#else
#if __GNUC__ >= 4
#define fssExport __attribute__((visibility("default")))
#else
#define fssExport
#endif
#endif
 
fssExport fssBindIFHandle fssCreateNode(fssString nodeName, fssConfigIfHandle configIfHandle);
 
fssExport fssRetStatus fssDestroyNode(fssBindIFHandle bindIfHandle);
 
#ifdef __cplusplus
}
#endif
 
#endif