msg.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later
   SPDX-FileCopyrightText: Copyright © 2021 Erez Geva <ErezGeva2@gmail.com> */
 
#ifndef __PTPMGMT_C_MSG_H
#define __PTPMGMT_C_MSG_H
 
#include "c/cfg.h"
#include "c/proc.h"
#include "c/sig.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ptpmgmt_msg_t *ptpmgmt_msg;
 
typedef const struct ptpmgmt_msg_t *const_ptpmgmt_msg;
 
typedef bool (*ptpmgmt_msg_sig_callback)(void *cookie, const_ptpmgmt_msg msg,
    enum ptpmgmt_tlvType_e tlvType, const void *tlv);
 
struct ptpmgmt_msg_t {
    void *_this; 
    struct ptpmgmt_PortIdentity_t _peer;
    struct ptpmgmt_PortIdentity_t _target;
    struct ptpmgmt_MsgParams _prms;
    ptpmgmt_safile _sa;
    const void *dataSend;
    void *sendTlv; 
    void *data; 
    void *dataTbl; 
    void *dataSig1; 
    void *dataSig2; 
    void *dataSig3; 
    void (*free)(ptpmgmt_msg msg);
    ptpmgmt_pMsgParams(*getParams)(ptpmgmt_msg msg);
    bool (*updateParams)(ptpmgmt_msg msg, ptpmgmt_cpMsgParams prms);
    bool (*useAuth_cfg)(ptpmgmt_msg msg, const_ptpmgmt_cfg cfg,
        const char *section);
    bool (*useAuth)(ptpmgmt_msg msg, const_ptpmgmt_safile sa, uint8_t spp,
        uint32_t key);
    bool (*changeAuth)(ptpmgmt_msg msg, uint8_t spp, uint32_t key);
    bool (*changeAuthKey)(ptpmgmt_msg msg, uint32_t key);
    bool (*disableAuth)(ptpmgmt_msg msg);
    int (*usedAuthSppID)(const_ptpmgmt_msg msg);
    uint32_t (*usedAuthKeyID)(const_ptpmgmt_msg msg);
    const_ptpmgmt_safile(*getSa)(ptpmgmt_msg msg);
    bool (*haveAuth)(const_ptpmgmt_msg msg);
    enum ptpmgmt_mng_vals_e(*getTlvId)(const_ptpmgmt_msg msg);
    enum ptpmgmt_mng_vals_e(*getBuildTlvId)(const_ptpmgmt_msg msg);
    void (*setAllClocks)(const_ptpmgmt_msg msg);
    bool (*isAllClocks)(const_ptpmgmt_msg msg);
    bool (*useConfig)(ptpmgmt_msg msg, const_ptpmgmt_cfg cfg, const char *section);
    const char *(*err2str)(enum ptpmgmt_MNG_PARSE_ERROR_e err);
    const char *(*type2str)(enum ptpmgmt_msgType_e type);
    const char *(*tlv2str)(enum ptpmgmt_tlvType_e type);
    const char *(*act2str)(enum ptpmgmt_actionField_e action);
    const char *(*mng2str)(enum ptpmgmt_mng_vals_e id);
    bool (*findMngID)(const char *str, enum ptpmgmt_mng_vals_e *id, bool exact);
    const char *(*errId2str)(enum ptpmgmt_managementErrorId_e err);
    const char *(*clkType2str)(enum ptpmgmt_clockType_e type);
    const char *(*netProt2str)(enum ptpmgmt_networkProtocol_e protocol);
    const char *(*clockAcc2str)(enum ptpmgmt_clockAccuracy_e value);
    const char *(*faultRec2str)(enum ptpmgmt_faultRecord_e code);
    const char *(*timeSrc2str)(enum ptpmgmt_timeSource_e type);
    bool (*findTimeSrc)(const char *str, enum ptpmgmt_timeSource_e *type,
        bool exact);
    const char *(*portState2str)(enum ptpmgmt_portState_e state);
    bool (*findPortState)(const char *str, enum ptpmgmt_portState_e *state,
        bool caseSens);
    const char *(*delayMech2str)(enum ptpmgmt_delayMechanism_e type);
    bool (*findDelayMech)(const char *str, enum ptpmgmt_delayMechanism_e *type,
        bool exact);
    const char *(*smpteLck2str)(enum ptpmgmt_SMPTEmasterLockingStatus_e state);
    const char *(*ts2str)(enum ptpmgmt_linuxptpTimeStamp_e type);
    const char *(*pwr2str)(enum ptpmgmt_linuxptpPowerProfileVersion_e ver);
    const char *(*us2str)(enum ptpmgmt_linuxptpUnicastState_e state);
    bool (*is_LI_61)(uint8_t flags);
    bool (*is_LI_59)(uint8_t flags);
    bool (*is_UTCV)(uint8_t flags);
    bool (*is_PTP)(uint8_t flags);
    bool (*is_TTRA)(uint8_t flags);
    bool (*is_FTRA)(uint8_t flags);
    bool (*isEmpty)(enum ptpmgmt_mng_vals_e id);
    bool (*isValidId)(const_ptpmgmt_msg msg, enum ptpmgmt_mng_vals_e id);
    bool (*setAction)(ptpmgmt_msg msg, enum ptpmgmt_actionField_e actionField,
        enum ptpmgmt_mng_vals_e tlv_id, const void *dataSend);
    void (*clearData)(const_ptpmgmt_msg msg);
    enum ptpmgmt_MNG_PARSE_ERROR_e(*build)(const_ptpmgmt_msg msg, void *buf,
        size_t bufSize, uint16_t sequence);
    enum ptpmgmt_actionField_e(*getSendAction)(const_ptpmgmt_msg msg);
    size_t (*getMsgLen)(const_ptpmgmt_msg msg);
    ssize_t (*getMsgPlanedLen)(const_ptpmgmt_msg msg);
    /* Parsed message functions */
    enum ptpmgmt_MNG_PARSE_ERROR_e(*parse)(const_ptpmgmt_msg msg, const void *buf,
        ssize_t msgSize);
    enum ptpmgmt_actionField_e(*getReplyAction)(const_ptpmgmt_msg msg);
    bool (*isUnicast)(const_ptpmgmt_msg msg);
    uint8_t (*getPTPProfileSpecific)(const_ptpmgmt_msg msg);
    uint16_t (*getSequence)(const_ptpmgmt_msg msg);
    const struct ptpmgmt_PortIdentity_t *(*getPeer)(ptpmgmt_msg msg);
    const struct ptpmgmt_PortIdentity_t *(*getTarget)(ptpmgmt_msg msg);
    uint32_t (*getSdoId)(const_ptpmgmt_msg msg);
    uint8_t (*getDomainNumber)(const_ptpmgmt_msg msg);
    uint8_t (*getVersionPTP)(const_ptpmgmt_msg msg);
    uint8_t (*getMinorVersionPTP)(const_ptpmgmt_msg msg);
    const void *(*getData)(ptpmgmt_msg msg);
    const void *(*getSendData)(const_ptpmgmt_msg msg);
    enum ptpmgmt_managementErrorId_e(*getErrId)(const_ptpmgmt_msg msg);
    const char *(*getErrDisplay)(const_ptpmgmt_msg msg);
    bool (*isLastMsgSig)(const_ptpmgmt_msg msg);
    bool (*isLastMsgSMPTE)(const_ptpmgmt_msg msg);
    enum ptpmgmt_msgType_e(*getType)(const_ptpmgmt_msg msg);
    enum ptpmgmt_tlvType_e(*getMngType)(const_ptpmgmt_msg msg);
    bool (*traversSigTlvs)(ptpmgmt_msg msg, void *cookie,
        ptpmgmt_msg_sig_callback callback);
    size_t (*getSigTlvsCount)(const_ptpmgmt_msg msg);
    const void *(*getSigTlv)(ptpmgmt_msg msg, size_t position);
    enum ptpmgmt_tlvType_e(*getSigTlvType)(const_ptpmgmt_msg msg, size_t position);
    enum ptpmgmt_mng_vals_e(*getSigMngTlvType)(const_ptpmgmt_msg msg,
        size_t position);
    const void *(*getSigMngTlv)(ptpmgmt_msg msg, size_t position);
};
 
const char *ptpmgmt_msg_err2str(enum ptpmgmt_MNG_PARSE_ERROR_e err);
const char *ptpmgmt_msg_type2str(enum ptpmgmt_msgType_e type);
const char *ptpmgmt_msg_tlv2str(enum ptpmgmt_tlvType_e type);
const char *ptpmgmt_msg_act2str(enum ptpmgmt_actionField_e action);
const char *ptpmgmt_msg_mng2str(enum ptpmgmt_mng_vals_e id);
bool ptpmgmt_msg_findMngID(const char *str, enum ptpmgmt_mng_vals_e *id,
    bool exact);
const char *ptpmgmt_msg_errId2str(enum ptpmgmt_managementErrorId_e err);
const char *ptpmgmt_msg_clkType2str(enum ptpmgmt_clockType_e type);
const char *ptpmgmt_msg_netProt2str(enum ptpmgmt_networkProtocol_e protocol);
const char *ptpmgmt_msg_clockAcc2str(enum ptpmgmt_clockAccuracy_e value);
const char *ptpmgmt_msg_faultRec2str(enum ptpmgmt_faultRecord_e code);
const char *ptpmgmt_msg_timeSrc2str(enum ptpmgmt_timeSource_e type);
bool ptpmgmt_msg_findTimeSrc(const char *str, enum ptpmgmt_timeSource_e *type,
    bool exact);
const char *ptpmgmt_msg_portState2str(enum ptpmgmt_portState_e state);
bool ptpmgmt_msg_findPortState(const char *str, enum ptpmgmt_portState_e *state,
    bool caseSens);
const char *ptpmgmt_msg_delayMech2str(enum ptpmgmt_delayMechanism_e type);
bool ptpmgmt_msg_findDelayMech(const char *str,
    enum ptpmgmt_delayMechanism_e *type, bool exact);
const char *ptpmgmt_msg_smpteLck2str(enum ptpmgmt_SMPTEmasterLockingStatus_e
    state);
const char *ptpmgmt_msg_ts2str(enum ptpmgmt_linuxptpTimeStamp_e type);
const char *ptpmgmt_msg_pwr2str(enum ptpmgmt_linuxptpPowerProfileVersion_e ver);
const char *ptpmgmt_msg_us2str(enum ptpmgmt_linuxptpUnicastState_e state);
bool ptpmgmt_msg_is_LI_61(uint8_t flags);
bool ptpmgmt_msg_is_LI_59(uint8_t flags);
bool ptpmgmt_msg_is_UTCV(uint8_t flags);
bool ptpmgmt_msg_is_PTP(uint8_t flags);
bool ptpmgmt_msg_is_TTRA(uint8_t flags);
bool ptpmgmt_msg_is_FTRA(uint8_t flags);
bool ptpmgmt_msg_isEmpty(enum ptpmgmt_mng_vals_e id);
 
ptpmgmt_msg ptpmgmt_msg_alloc();
 
ptpmgmt_msg ptpmgmt_msg_alloc_prms(ptpmgmt_cpMsgParams prms);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PTPMGMT_C_MSG_H */