General Functions for DSI users

General things to be used by libdsi-users. More...

Classes
struct	dsi_jcp_stream
	jitter constrained periodic stream More...
struct	dsi_stream_cfg
	low level stream configuration for now it is specified explicitly, at some stage it should be calculated from jitter constrained periodic stream definition More...
Typedefs
typedef struct dsi_jcp_stream	dsi_jcp_stream_t
	jitter constrained periodic stream
typedef struct dsi_stream_cfg	dsi_stream_cfg_t
	low level stream configuration for now it is specified explicitly, at some stage it should be calculated from jitter constrained periodic stream definition
Functions
int	dsi_init (void)
	Library initialization.
void	dsi_ds_set_dataspace_manager (l4_threadid_t id)
	Set new dataspace manager.
int	dsi_ds_setup_ctrl_dataspace (l4dm_dataspace_t *ds, dsi_stream_cfg_t cfg)
	Setup control dataspace.
int	dsi_ds_create_ctrl_dataspace (dsi_stream_cfg_t cfg, l4dm_dataspace_t *ds)
	Create control dataspace.
void	dsi_jcp_2_config (dsi_jcp_stream_t *jcp, dsi_stream_cfg_t *s_cfg)
	Convert jcp to stream-config.
int	dsi_set_sync_thread_prio (int new_prio)
	Set priority of syncronisation threads created in the future.
int	dsi_set_select_thread_prio (int new_prio)
	Set priority of the select threads created in the future.
int	dsi_set_event_thread_prio (int new_prio)
	Set priority of event thread created in the future.

---

Detailed Description

General things to be used by libdsi-users.

---

Function Documentation

int dsi_ds_create_ctrl_dataspace	(	dsi_stream_cfg_t	cfg,
		l4dm_dataspace_t *	ds
	)

Create control dataspace.

Parameters:

cfg

Stream configuration

Return values:

ds

Control dataspace id

Returns:

0 on success, error code otherwise:

• -L4_ENOMEM dataspace allocation failed

Definition at line 772 of file dataspace.c.

References __get_ctrl_ds_size(), and __init_ctrl_ds().

void dsi_ds_set_dataspace_manager

(

l4_threadid_t

id

)

Set new dataspace manager.

Parameters:

id

dataspace manager id

Definition at line 701 of file dataspace.c.

References dsi_dm_id.

int dsi_ds_setup_ctrl_dataspace	(	l4dm_dataspace_t *	ds,
		dsi_stream_cfg_t	cfg
	)

Setup control dataspace.

Parameters:

	ds	Dataspace id
	cfg	Stream configuration

Returns:

0 on success, error code otherwise:

• -L4_EINVAL invalid dataspace

Setup control dataspace without a socket, it can be used by an application to create a control dataspace which the application passed to both the send and receive component

Definition at line 724 of file dataspace.c.

References __get_ctrl_ds_size(), and __init_ctrl_ds().

void dsi_jcp_2_config	(	dsi_jcp_stream_t *	jcp,
		dsi_stream_cfg_t *	s_cfg
	)

Convert jcp to stream-config.

Parameters:

jcp

JCP-params bw, tau, packetsize

Return values:

s_cfg

contains number of packets and max_sg=1

Definition at line 22 of file jcp.c.

References dsi_jcp_stream::bw, dsi_stream_cfg::max_sg, dsi_stream_cfg::num_packets, dsi_jcp_stream::size, and dsi_jcp_stream::tau.

int dsi_set_event_thread_prio

(

int

new_prio

)

Set priority of event thread created in the future.

Parameters:

new_prio

The new L4 priority. Use L4THREAD_DEFAULT_PRIO to use the default priority of the l4 thread lib. The actual priority depends on the implementation of the l4 thread lib.

Returns:

old event-thread priority.

This function sets the priority used to create the event thread. It should be called prior to dsi_init(), otherwise it has no effect.

If this function is not called, L4THREAD_DEFAULT_PRIO will be used to create the event thread.

Definition at line 109 of file thread.c.

int dsi_set_select_thread_prio

(

int

new_prio

)

Set priority of the select threads created in the future.

Parameters:

new_prio

The new L4 priority. Use L4THREAD_DEFAULT_PRIO to use the default priority of the l4 thread lib. The actual priority depends on the implementation of the l4 thread lib.

Returns:

old select-thread priority.

This function sets the priority used to create the select threads. This function does not effect existing threads.

Prior to the first call, L4THREAD_DEFAULT_PRIO will be used to create the select threads.

Definition at line 80 of file thread.c.

int dsi_set_sync_thread_prio

(

int

new_prio

)

Set priority of syncronisation threads created in the future.

Parameters:

new_prio

The new L4 priority. Use L4THREAD_DEFAULT_PRIO to use the default priority of the l4 thread lib. The actual priority depends on the implementation of the l4 thread lib.

Returns:

old sync-thread priority.

This function sets the priority used to create the synchronisation threads. This function does not effect existing threads.

Prior to the first call, L4THREAD_DEFAULT_PRIO will be used to create the synchronisation threads.

Definition at line 51 of file thread.c.