Support Services

Items of this group should move to other groups. More...

Files
file	support.h
	This header file defines support services of the API.

Macros
#define	RTEMS_MILLISECONDS_TO_MICROSECONDS(_ms)   ( ( _ms ) * 1000UL )
	Returns the number of microseconds for the specified milliseconds value. More...
#define	RTEMS_MICROSECONDS_TO_TICKS(_us)   ( ( _us ) / rtems_configuration_get_microseconds_per_tick() )
	Returns the number of clock ticks for the specified microseconds value. More...
#define	RTEMS_MILLISECONDS_TO_TICKS(_ms)   RTEMS_MICROSECONDS_TO_TICKS( RTEMS_MILLISECONDS_TO_MICROSECONDS( _ms ) )
	Returns the number of clock ticks for the specified milliseconds value. More...

Functions
static bool	rtems_is_name_valid (rtems_status_code name)
	Returns true, if the specified object name is valid, otherwise returns false. More...
static void	rtems_name_to_characters (rtems_name name, char *c1, char *c2, char *c3, char *c4)
	Breaks the object name into the four component characters. More...
bool	rtems_workspace_allocate (size_t bytes, void **pointer)
	% More...
bool	rtems_workspace_free (void *pointer)
	% More...
bool	rtems_workspace_get_information (Heap_Information_block *the_info)
	% More...
void *	rtems_workspace_greedy_allocate (const uintptr_t *block_sizes, size_t block_count)
	% More...
void *	rtems_workspace_greedy_allocate_all_except_largest (uintptr_t *allocatable_size)
	% More...
void	rtems_workspace_greedy_free (void *opaque)
	% More...

Detailed Description

Items of this group should move to other groups.

Macro Definition Documentation

RTEMS_MICROSECONDS_TO_TICKS

#define RTEMS_MICROSECONDS_TO_TICKS

(

_us

)

( ( _us ) / rtems_configuration_get_microseconds_per_tick() )

Returns the number of clock ticks for the specified microseconds value.

The number of clock ticks per second is defined by the CONFIGURE_MICROSECONDS_PER_TICK application configuration option.

Parameters

_us	is the microseconds value to convert to clock ticks.

Returns

The number of clock ticks for the specified microseconds value is returned.

Definition at line 109 of file support.h.

RTEMS_MILLISECONDS_TO_MICROSECONDS

#define RTEMS_MILLISECONDS_TO_MICROSECONDS

(

_ms

)

( ( _ms ) * 1000UL )

Returns the number of microseconds for the specified milliseconds value.

Parameters

_ms	is the milliseconds value to convert to microseconds.

Returns

The number of microseconds for the specified milliseconds value is returned.

Definition at line 91 of file support.h.

RTEMS_MILLISECONDS_TO_TICKS

#define RTEMS_MILLISECONDS_TO_TICKS

(

_ms

)

RTEMS_MICROSECONDS_TO_TICKS( RTEMS_MILLISECONDS_TO_MICROSECONDS( _ms ) )

Returns the number of clock ticks for the specified milliseconds value.

The number of clock ticks per second is defined by the CONFIGURE_MICROSECONDS_PER_TICK application configuration option.

Parameters

_ms	is the milliseconds value to convert to clock ticks.

Returns

The number of clock ticks for the specified milliseconds value is returned.

Definition at line 147 of file support.h.

Function Documentation

rtems_is_name_valid()

static bool rtems_is_name_valid ( rtems_status_code  name )

inlinestatic

Returns true, if the specified object name is valid, otherwise returns false.

Parameters

name	is the object name to check.

Return values

true	The specified object name is valid.
false	Otherwise.

Definition at line 126 of file support.h.

rtems_name_to_characters()

static void rtems_name_to_characters ( rtems_name  name, char *  c1, char *  c2, char *  c3, char *  c4  )

inlinestatic

Breaks the object name into the four component characters.

Parameters

	name	is the object name to break into four component characters.
[out]	c1	is the first character of the object name.
[out]	c2	is the second character of the object name.
[out]	c3	is the third character of the object name.
[out]	c4	is the fourth character of the object name.

Definition at line 167 of file support.h.

rtems_workspace_allocate()

bool rtems_workspace_allocate	(	size_t	bytes,
		void **	pointer
	)

%

Parameters

bytes	%
pointer	%

rtems_workspace_free()

bool rtems_workspace_free

(

void *

pointer

)

%

Parameters

pointer

%

rtems_workspace_get_information()

bool rtems_workspace_get_information

(

Heap_Information_block *

the_info

)

%

Parameters

the_info

%

rtems_workspace_greedy_allocate()

void* rtems_workspace_greedy_allocate	(	const uintptr_t *	block_sizes,
		size_t	block_count
	)

%

Parameters

block_sizes	%
block_count	%

rtems_workspace_greedy_allocate_all_except_largest()

void* rtems_workspace_greedy_allocate_all_except_largest

(

uintptr_t *

allocatable_size

)

%

Parameters

allocatable_size

%

rtems_workspace_greedy_free()

void rtems_workspace_greedy_free

(

void *

opaque

)

%

Parameters

opaque

%