vftr_dump_define.h File Reference

The definitions of message content. More...

#include <unistd.h>
#include <time.h>
#include "mpi_base_types.h"

Data Structures
union	VFTR_DUMP_FLAG_V1_U
	This is the field definition of the UINT32 flag. More...
struct	VFTR_DUMP_HEADER_V1_S
	Byte stream header for trasmitting dat through a FIFO. More...

Macros
#define	VFTR_DUMP_ENABLE_PATH   "/tmp/augentix/vftr_dump"
#define	FLAG_TYPE_INPUT   0x1
#define	FLAG_TYPE_OUTPUT   0x2
#define	FLAG_TYPE_CTRL   0x4
#define	FLAG_TYPE_DEBUG   0x8
#define	FLAG_TYPE_IMG   0x10
#define	FLAG_TYPE_CUSTOM   0x20
#define	FLAG_CAT_VFTR   0x0
#define	FLAG_PARENT_ID_NONE   0x3ff
#define	FLAG_VER_1   0x0
#define	FLAG_MASK_ID   0x3ff
#define	FLAG_MASK_TYPE   0xfc00
#define	FLAG_MASK_CAT   0x70000
#define	FLAG_MASK_GROUP   0x1ff80000
#define	FLAG_MASK_VER   0xc0000000
#define	FLAG_LENGTH_ID   10
#define	FLAG_LENGTH_TYPE   6
#define	FLAG_LENGTH_GROUP   10
#define	FLAG_LENGTH_CAT   3
#define	FLAG_MAX_ID_VALUE   (1 << FLAG_LENGTH_ID)
#define	FLAG_MAX_TYPE_VALUE   (1 << FLAG_LENGTH_TYPE)
#define	FLAG_MAX_GROUP_VALUE   (1 << FLAG_LENGTH_GROUP)
#define	FLAG_MAX_CAT_VALUE   (1 << FLAG_LENGTH_CAT)
#define	EXPORT_VFTR_DUMP_ARRAY
	An array macro to collect all data structures for debugging. More...
#define	EXPORT_DUMP(name, type)   VFTR_ID_##name,
#define	DECLARE_ENUM_ID(name, array)   enum name { array MAX_VFTR_DUMP_ID_NUM };
	The following code generates structure ids. More...
#define	EXPORT_DUMP(name, type)   VFTR_TYPE_##name = (type),
#define	DECLARE_ENUM_TYPE(name, array)   enum name { array MAX_VFTR_DUMP_TYPE_NUM };
	The following code generates structure types. More...
#define	VFTR_HEADER_INITCODE   0x4741
#define	VFTR_HEADER_VER_1   0x0

Typedefs
typedef struct timespec	TIMESPEC_S
typedef pid_t	PID_T

Functions
	DECLARE_ENUM_ID (vftr_dump_id, EXPORT_VFTR_DUMP_ARRAY)
	DECLARE_ENUM_TYPE (vftr_dump_type, EXPORT_VFTR_DUMP_ARRAY)

Detailed Description

The definitions of message content.

Macro Definition Documentation

#define DECLARE_ENUM_ID	(		name,
			array
	)		enum name { array MAX_VFTR_DUMP_ID_NUM };

The following code generates structure ids.

Produce the code like: enum vftr_dump_id { ID_MPI_IVA_OBJ_LIST_S, ID_VFTR_MD_INSTANCE_S, ID_VFTR_MD_PARAM_S, ID_VFTR_MD_STATUS_S, ... MAX_VFTR_DUMP_ID_NUM };

#define DECLARE_ENUM_TYPE	(		name,
			array
	)		enum name { array MAX_VFTR_DUMP_TYPE_NUM };

The following code generates structure types.

Produce the code like: enum vfre_dump_type { TYPE_MPI_IVA_OBJ_LIST_S = type, TYPE_VFTR_MD_INSTANCE_S = type, TYPE_VFTR_MD_PARAM_S = type, TYPE_VFTR_MD_STATUS_S = type, ... MAX_VFTR_DUMP_TYPE_NUM };

#define EXPORT_VFTR_DUMP_ARRAY

An array macro to collect all data structures for debugging.

Note

Maintain the following array if new VFTR structure added PLEASE ADD NEW ELEMENT AT LAST

#define FLAG_CAT_VFTR   0x0

VFTR category

#define FLAG_LENGTH_CAT   3

Bit length of category field

#define FLAG_LENGTH_GROUP   10

Bit length of category field

#define FLAG_LENGTH_ID   10

Bit length of id field

#define FLAG_LENGTH_TYPE   6

Bit length of type field

#define FLAG_MASK_CAT   0x70000

Mask of catgory field

#define FLAG_MASK_GROUP   0x1ff80000

Mask of catgory field

#define FLAG_MASK_ID   0x3ff

Mask of id field

#define FLAG_MASK_TYPE   0xfc00

Mask of type field

#define FLAG_MAX_CAT_VALUE   (1 << FLAG_LENGTH_CAT)

Maximum category value

#define FLAG_MAX_GROUP_VALUE   (1 << FLAG_LENGTH_GROUP)

Maximum category value

#define FLAG_MAX_ID_VALUE   (1 << FLAG_LENGTH_ID)

Maximum id value

#define FLAG_MAX_TYPE_VALUE   (1 << FLAG_LENGTH_TYPE)

Maximum type value

#define FLAG_TYPE_CTRL   0x4

Control data including module parameters

#define FLAG_TYPE_CUSTOM   0x20

User specific data

#define FLAG_TYPE_DEBUG   0x8

Debugging data including module instance

#define FLAG_TYPE_IMG   0x10

Image data, often very large

#define FLAG_TYPE_INPUT   0x1

Input data

#define FLAG_TYPE_OUTPUT   0x2

Output data

#define FLAG_VER_1   0x0

Constant value for version 1 flag

#define VFTR_HEADER_INITCODE   0x4741

0x4741 = "AG"