devlib_types.h File Reference

Devlib API data types. More...

Data Structures
struct	DCValue
	Run time information data type. More...
Defines
#define	TOKEN_INVALID   0xffffffff
	Invalid token value.
#define	TOKEN_CHECK   0xfffffffc
	Special CRC32 property checksum query token.
#define	INVALID_TOKEN   TOKEN_INVALID
	Legacy, see TOKEN_INVALID.
#define	DC_PORT_ROOT   (struct DCDevice *) -1
	Pseudo device handle for port hub structure.
#define	DC_UNSIGNED   0x0080
	Property is unsigned.
#define	F_PRIVATE   0x0001
	Property flags.
#define	F_BIG   0x0002
	Big endian, if Register node.
#define	F_LINK   0x0080
	Node is a link (members are instanced.
#define	F_RW   0x0000
	Readable/Writeable.
#define	F_RO   0x0100
	Readonly.
#define	F_WO   0x0200
	Writeonly.
#define	F_INACTIVE   0x0400
	Property is currently inactive.
#define	F_VOLATILE   0x2000
	Property is volatile.
#define	SET_FLOAT(v, f)   v.type = DC_FLOAT; v.value.f = f
	Initialize float DCValue.
#define	SET_INT(v, i)   v.type = DC_INT; v.value.f = i
	Initialize integer DCValue.
#define	SET_STRING(v, s, l)
	Initialize string DCValue.
Typedefs
typedef int(	PropCallback )(uint32_t t)
	Property callback function for recursive node walker.
typedef int(*	FeedbackFuncP )(int i)
	Feedback function pointer definition.
typedef void(*	LogFuncP )(int log_level, const char *fmt,...)
	Logging function type.
Enumerations
enum	PropertyType { ,   DC_ROOT, DC_INT, DC_FLOAT, DC_BOOL,   DC_MODE , DC_STRING, DC_BUFFER, DC_STRUCT,   DC_ARRAY, DC_COMMAND, DC_EVENT }
	Property data types. More...
enum	{ DCLOG_ERROR, DCLOG_DEBUG, DCLOG_VERBOSE }
	Log levels. More...

---

Detailed Description

These are datatypes that have to be exported to the API.

WARNING: Changes in these data structures may affect API binary compatibility. If this is the case, the major library version number must be increased.

Id

devlib_types.h 292 2010-01-07 19:35:21Z strubi

---

Define Documentation

#define F_PRIVATE   0x0001

These flags are queried via dcProperty_GetFlags().

All other bits are reserved for internal purposes. Property is private ('hidden' attribute)

#define TOKEN_CHECK   0xfffffffc

See property_crc()

Examples:

master.c.

#define TOKEN_INVALID   0xffffffff

When returned from dcProperty_ParseName(), a property of that name was not found.

---

Typedef Documentation

typedef int(* FeedbackFuncP)(int i)

See dcSetFeedback() in devlib.h

---

Enumeration Type Documentation

anonymous enum

Enumerator:

DCLOG_ERROR	Error level.
DCLOG_DEBUG	Debug level.
DCLOG_VERBOSE	Verbose level.

enum PropertyType

Enumerator:

DC_ROOT	ROOT NODE TYPE.
DC_INT	A 32 bit signed integer.
DC_FLOAT	A 4 byte float, single precision.
DC_BOOL	A boolean value (1: true, 0: false).
DC_MODE	A mode value. Only the values in the choice are valid.
DC_STRING	A string value (constant or fixed lengh, 0 terminated).
DC_BUFFER	A buffer value. The length is specified in the len field.
DC_STRUCT	A struct value containing other properties.
DC_ARRAY	An array value, containing a struct or property.
DC_COMMAND	A command.
DC_EVENT	An event node.