private library API

private definitions and functions the client and the server library uses More...

Data Structures
struct	message_t
	defines the message typ for requests send to the server More...
Defines
#define	REGISTER_EVENT   1
#define	UNREGISTER_EVENT   2
#define	UNREGISTER_ALL_EVENTS   3
#define	SEND_EVENT   4
#define	ASYNC_SEND_EVENT   5
#define	ACK_SEND_EVENT   6
#define	ASYNC_ACK_SEND_EVENT   7
#define	RECEIVE_EVENT   8
#define	ACK_RECEIVE_EVENT   9
#define	GET_ACK   10
#define	GIVE_ACK   11
#define	GIVE_ACK_AND_ACK_RECEIVE_EVENT   13
#define	TIMEOUT   14
#define	SERVER_DUMP   15
#define	SHORT_BUFFER_SIZE   4
	this value is valid for l4v2 target-architecture
#define	create_control_word_for_call(cmd, len, event_ch, event_nr)
	assembles the control word from function code, event length, event_ch
#define	create_control_word_for_reply(res, len, event_ch, event_nr)
	assembles the control word from result value, event length, event_ch
#define	get_cmd(word)   ((word >> 28) & 0xf)
	returns the function code
#define	get_res(word)   (((word >> 28) & 0xf) ? ((word >> 28) & 0xf) | 0xf0 : 0)
	returns the result value
#define	get_len(word)   ((word >> 20) & 0xff)
	returns the length of the message buffer
#define	get_event_ch(word)   ((word >> 12) & 0xff)
	returns the event_ch
#define	get_event_nr(word)   (word & 0xfff)
	returns the event_nr of the event

---

Detailed Description

private definitions and functions the client and the server library uses

---

Define Documentation

#define REGISTER_EVENT   1

Definition at line 21 of file lib.h.

#define UNREGISTER_EVENT   2

Definition at line 22 of file lib.h.

#define UNREGISTER_ALL_EVENTS   3

Definition at line 23 of file lib.h.

#define SEND_EVENT   4

Definition at line 24 of file lib.h.

#define ASYNC_SEND_EVENT   5

Definition at line 25 of file lib.h.

#define ACK_SEND_EVENT   6

Definition at line 26 of file lib.h.

#define ASYNC_ACK_SEND_EVENT   7

Definition at line 27 of file lib.h.

#define RECEIVE_EVENT   8

Definition at line 29 of file lib.h.

#define ACK_RECEIVE_EVENT   9

Definition at line 30 of file lib.h.

#define GET_ACK   10

Definition at line 31 of file lib.h.

#define GIVE_ACK   11

Definition at line 32 of file lib.h.

#define GIVE_ACK_AND_ACK_RECEIVE_EVENT   13

Definition at line 36 of file lib.h.

#define TIMEOUT   14

Definition at line 39 of file lib.h.

#define SERVER_DUMP   15

Definition at line 41 of file lib.h.

#define SHORT_BUFFER_SIZE   4

this value is valid for l4v2 target-architecture

Definition at line 45 of file lib.h.

#define create_control_word_for_call	(	cmd,
		len,
		event_ch,
		event_nr		)

Value:

((((((cmd & 0xf) << 8) | \
       (len & 0xff)) << 8) | \
       (event_ch & 0xff)) << 12) | \
       (event_nr & 0xfff)

assembles the control word from function code, event length, event_ch

Definition at line 102 of file lib.h.

#define create_control_word_for_reply	(	res,
		len,
		event_ch,
		event_nr		)

Value:

((((((res & 0xf) << 8) | \
       (len & 0xff)) << 8) | \
             (event_ch & 0xff)) << 12) | \
       (event_nr & 0xfff)

assembles the control word from result value, event length, event_ch

Definition at line 112 of file lib.h.

#define get_cmd

(

word

)

((word >> 28) & 0xf)

returns the function code

Definition at line 120 of file lib.h.

#define get_res

(

word

)

(((word >> 28) & 0xf) ? ((word >> 28) & 0xf) | 0xf0 : 0)

returns the result value

Definition at line 126 of file lib.h.

#define get_len

(

word

)

((word >> 20) & 0xff)

returns the length of the message buffer

Definition at line 131 of file lib.h.

#define get_event_ch

(

word

)

((word >> 12) & 0xff)

returns the event_ch

Definition at line 136 of file lib.h.

#define get_event_nr

(

word

)

(word & 0xfff)

returns the event_nr of the event

Definition at line 141 of file lib.h.