kFsDef.h

Go to the documentation of this file.

#ifndef K_FIRESYNC_FIRESYNC_DEF_H
#define K_FIRESYNC_FIRESYNC_DEF_H

#include <kApi/Io/kNetwork.h>

#if defined (K_FS_EMIT)
#   define kFsFx(TYPE)    kExportFx(TYPE)               
#   define kFsDx(TYPE)    kExportDx(TYPE)               
#else
#   define kFsFx(TYPE)    kImportFx(TYPE)    
#   define kFsDx(TYPE)    kImportDx(TYPE)    
#endif

typedef struct kPair32s
{
    k32s first;     
    k32s second;    
} kPair32s;

typedef k32s kEthernetLink; 

#define kETHERNET_LINK_NONE                     (0x0000)        
#define kETHERNET_LINK_10_HALF                  (0x0001)        
#define kETHERNET_LINK_10_FULL                  (0x0002)        
#define kETHERNET_LINK_100_HALF                 (0x0004)        
#define kETHERNET_LINK_100_FULL                 (0x0008)        
#define kETHERNET_LINK_1000_HALF                (0x0010)        
#define kETHERNET_LINK_1000_FULL                (0x0020)        
#define kETHERNET_LINK_AUTO                     (0x8000)        

kFsFx(kStatus) kEthernetLink_Format(kEthernetLink speed, kChar* text, kSize capacity); 

kFsFx(k64u) kEthernetLink_Capacity(kEthernetLink speed); 

typedef k32s kUpgLogLevel; 

#define kFS_UPG_LOG_LEVEL_INFO               (0)           
#define kFS_UPG_LOG_LEVEL_WARN               (1)           
#define kFS_UPG_LOG_LEVEL_ERROR              (2)           


typedef struct kUpgLogMsg
{
    kChar buffer[512];
    kUpgLogLevel logLevel;
} kUpgLogMsg;

typedef k32s kNetworkSpeed;

#define kNETWORK_SPEED_NULL                 (0x0000)        
#define kNETWORK_SPEED_AUTO                 (0x0001)        
#define kNETWORK_SPEED_10                   (0x0002)        
#define kNETWORK_SPEED_100                  (0x0004)        
#define kNETWORK_SPEED_1000                 (0x0008)        

kFsFx(kStatus) kNetworkSpeed_Format(kNetworkSpeed speed, kChar* text, kSize capacity);

typedef k32s kIpNegotiation; 

#define kIP_NEGOTIATION_STATIC                  (0)           
#define kIP_NEGOTIATION_DHCP                    (1)           


kFsFx(kStatus) kIpNegotiation_Format(kIpNegotiation ipNegotiation, kChar* text, kSize capacity);

typedef struct kIpConfig
{
    kIpAddress address;             
    k32u prefixLength;              
    kIpAddress gateway;             
    kIpNegotiation ipNegotiation;   
} kIpConfig; 

kFsFx(k32u) kIpConfig_SubnetPrefixToMask(k32u prefix); 

kFsFx(k32u) kIpConfig_SubnetMaskToPrefix(k32u mask); 

typedef struct kRegisterBits
{
    k16u address;       
    k16u startBit;      
    k16u endBit;        
    k16u data;          
} kRegisterBits;

typedef struct kRegister16u
{
    k16u address;       
    k16u data;          
} kRegister16u; 

typedef struct kRegister32u
{
    k32u address;       
    k32u data;          
} kRegister32u;

typedef k32s kVisualizerType;

#define kVISUALIZER_MESH                (0)     
#define kVISUALIZER_PROPERTY_TABLE      (1)     
#define kVISUALIZER_TEXT                (2)     
#define kVISUALIZER_2D                  (3)     

typedef k32s kAlignment; 

#define kALIGNMENT_CENTRE               (0x00)                                 
#define kALIGNMENT_LEFT                 (0x01)                                 
#define kALIGNMENT_RIGHT                (0x02)                                 
#define kALIGNMENT_TOP                  (0x04)                                 
#define kALIGNMENT_BOTTOM               (0x08)                                 
#define kALIGNMENT_TOP_LEFT             (kALIGNMENT_TOP | kALIGNMENT_LEFT)     
#define kALIGNMENT_TOP_RIGHT            (kALIGNMENT_TOP | kALIGNMENT_RIGHT)    
#define kALIGNMENT_BOTTOM_LEFT          (kALIGNMENT_BOTTOM | kALIGNMENT_LEFT)  
#define kALIGNMENT_BOTTOM_RIGHT         (kALIGNMENT_BOTTOM | kALIGNMENT_RIGHT) 

typedef k32s kFontStyle; 

#define kFONT_STYLE_NORMAL              (0x00)     
#define kFONT_STYLE_BOLD                (0x01)     
#define kFONT_STYLE_ITALIC              (0x02)     
#define kFONT_STYLE_UNDERLINE           (0x04)     

typedef k32s kFontFamily;

#define kFONT_FAMILY_SERIF              (0)         
#define kFONT_FAMILY_SANS_SERIF         (1)         
#define kFONT_FAMILY_MONOSPACE          (2)         

typedef k32s kMarkerShape; 

#define kMARKER_SHAPE_CROSS             (0)        
#define kMARKER_SHAPE_PLUS              (1)        
#define kMARKER_SHAPE_CIRCLE            (2)        
#define kMARKER_SHAPE_SQUARE            (3)        
#define kMARKER_SHAPE_TRIANGLE          (4)        
#define kMARKER_SHAPE_DIAMOND           (5)        

typedef k32s kDemosaicStyle;

#define kDEMOSAIC_STYLE_REDUCE        (0)           
#define kDEMOSAIC_STYLE_BILINEAR      (1)           
#define kDEMOSAIC_STYLE_GRADIENT      (2)           


typedef k32s kAxis; 

#define kAXIS_X     (0x1)           
#define kAXIS_Y     (0x2)           
#define kAXIS_Z     (0x4)           


typedef k32s kCompressedPhaseStreamId; 

#define kCOMPRESSED_PHASE_STREAM_ID_PHASE_DELTA          (0)          
#define kCOMPRESSED_PHASE_STREAM_ID_PHASE_FAIL_2         (1)          
#define kCOMPRESSED_PHASE_STREAM_ID_PHASE_NULL           (2)          
#define kCOMPRESSED_PHASE_STREAM_ID_PHASE_FAIL_1         (3)          
#define kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_DELTA      (4)          
#define kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_FAIL_2     (5)          
#define kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_NULL       (6)          
#define kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_FAIL_1     (7)          

kInlineFx(kBool) kCompressedPhaseStreamId_IsDelta(kCompressedPhaseStreamId streamId)
{
    switch (streamId)
    {
        case kCOMPRESSED_PHASE_STREAM_ID_PHASE_DELTA:
        case kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_DELTA:
            return kTRUE; 
        default:
            return kFALSE;
    }
}

kInlineFx(kBool) kCompressedPhaseStreamId_IsFail(kCompressedPhaseStreamId streamId)
{
    switch (streamId)
    {
        case kCOMPRESSED_PHASE_STREAM_ID_PHASE_FAIL_1:
        case kCOMPRESSED_PHASE_STREAM_ID_PHASE_FAIL_2:
        case kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_FAIL_1:
        case kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_FAIL_2:
            return kTRUE; 
        default:
            return kFALSE;
    }
}

kInlineFx(kBool) kCompressedPhaseStreamId_IsNull(kCompressedPhaseStreamId streamId)
{
    switch (streamId)
    {
        case kCOMPRESSED_PHASE_STREAM_ID_PHASE_NULL:
        case kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_NULL:
            return kTRUE; 
        default:
            return kFALSE;
    }
}

kInlineFx(kBool) kCompressedPhaseStreamId_IsPhase(kCompressedPhaseStreamId streamId)
{
    return streamId < kCOMPRESSED_PHASE_STREAM_ID_INTENSITY_DELTA;
}

typedef k32s kCompressedPhaseEncoding; 

#define kCOMPRESSED_PHASE_ENCODING_4B_DELTA              (1)          
#define kCOMPRESSED_PHASE_ENCODING_6B_DELTA              (2)          
#define kCOMPRESSED_PHASE_ENCODING_8B_DELTA              (3)          
#define kCOMPRESSED_PHASE_ENCODING_10B_DELTA             (4)          
#define kCOMPRESSED_PHASE_ENCODING_12B_FAIL_1            (5)          
#define kCOMPRESSED_PHASE_ENCODING_8B_FAIL_2             (6)          
#define kCOMPRESSED_PHASE_ENCODING_24B_FAIL_2            (7)          
#define kCOMPRESSED_PHASE_ENCODING_8B_NULL               (8)          

kFsFx(k32u) kCompressedPhaseEncoding_IndexBitDepth(kCompressedPhaseEncoding encoding); 

kFsFx(k32s) kCompressedPhaseEncoding_IndexMax(kCompressedPhaseEncoding encoding); 

kFsFx(k32u) kCompressedPhaseEncoding_ValueBitDepth(kCompressedPhaseEncoding encoding); 

kFsFx(k32s) kCompressedPhaseEncoding_ValueSigned(kCompressedPhaseEncoding encoding); 

kFsFx(k32s) kCompressedPhaseEncoding_ValueMin(kCompressedPhaseEncoding encoding); 

kFsFx(k32s) kCompressedPhaseEncoding_ValueMax(kCompressedPhaseEncoding encoding); 

kFsFx(kStatus) kCompressedPhaseEncoding_FindDeltaEncoding(kCompressedPhaseEncoding* encoding, k32u bitDepth); 

#define kField_ToMask_(MSB, LSB)      \
  (((((MSB) - (MSB) + 1) << ((MSB) - (LSB) + 1)) - 1) << (LSB))

#define kField_Create_(MASK, SHIFT, FLD_VAL)                        \
    (((FLD_VAL) << SHIFT) & (MASK))

#define kField_CreateNamed_(FIELD_NAME, FLD_VAL)                        \
    kField_Create_(FIELD_NAME##_MASK, FIELD_NAME##_SHIFT, FLD_VAL)

#define kField_CreateRange_(MSB, LSB, FLD_VAL)                \
    kField_Create_(kField_ToMask_(MSB, LSB), LSB, FLD_VAL)

#define kField_CreateNamedRange_(FIELD_NAME, FLD_VAL)                \
    kField_CreateRange_(FIELD_NAME##_MSB, FIELD_NAME##_LSB, FLD_VAL)

#define kField_Extract_(REG_VAL, MASK, SHIFT)               \
    (((REG_VAL) & (MASK)) >> (SHIFT))

#define kField_ExtractNamed_(REG_VAL, FIELD_NAME)               \
    (((REG_VAL) & (FIELD_NAME##_MASK)) >> (FIELD_NAME##_SHIFT))

#define kField_ExtractRange_(REG_VAL, MSB, LSB)               \
    kField_Extract_(REG_VAL, kField_ToMask_(MSB, LSB), LSB)

#define kField_ExtractNamedRange_(REG_VAL, FIELD_NAME)               \
    kField_ExtractRange_(REG_VAL, FIELD_NAME##_MSB, FIELD_NAME##_LSB)

#define kField_Insert_(REG_REF, MASK, SHIFT, FLD_VAL)       \
    (*(REG_REF) = (*(REG_REF) & ~(MASK)) | kField_Create_(MASK, SHIFT, FLD_VAL))

#define kField_InsertNamed_(REG_REF, FIELD_NAME, FLD_VAL)       \
    kField_Insert_(REG_REF, FIELD_NAME##_MASK, FIELD_NAME##_SHIFT, FLD_VAL)

#define kField_InsertRange_(REG_REF, MSB, LSB, FLD_VAL)       \
    kField_Insert_(REG_REF, kField_ToMask_(MSB, LSB), LSB, FLD_VAL)

#define kField_InsertNamedRange_(REG_REF, FIELD_NAME, FLD_VAL)       \
    kField_InsertRange_(REG_REF, FIELD_NAME##_MSB, FIELD_NAME##_LSB, FLD_VAL)

#define kField_Diff_(REG_VAL_A, REG_VAL_B, MASK, SHIFT)                                        \
        ((kField_Extract_(REG_VAL_A, MASK, SHIFT) - kField_Extract_(REG_VAL_B, MASK, SHIFT))   \
            & ((MASK) >> (SHIFT)))

#define kField_DiffNamed_(REG_VAL_A, REG_VAL_B, FIELD_NAME)             \
        kField_Diff_(REG_VAL_A, REG_VAL_B, FIELD_NAME##_MASK, FIELD_NAME##_SHIFT)

#define kField_DiffRange_(REG_VAL_A, REG_VAL_B, MSB, LSB)            \
    kField_Diff_(REG_VAL_A, REG_VAL_B, kField_ToMask_(MSB, LSB), LSB)

#define kField_DiffNamedRange_(REG_VAL_A, REG_VAL_B, FIELD_NAME)        \
    kField_DiffRange_(REG_VAL_A, REG_VAL_B, FIELD_NAME##_MSB, FIELD_NAME##_LSB)

#define kNanoToMicro_(V)                ((V) / 1000)

#define kMicroToNano_(V)                ((V) * 1000)


#define kIO_TEST_IO_I2C_ID_EXT_AD7415           (0x49)
#define kIO_TEST_AD7415_SCALE_FACTOR            (250);

#include <kFireSync/kFsDef.x.h>

#endif