Dual-Ported Memory Manager

The Dual-Ported Memory Manager provides a mechanism for converting addresses between internal and external representations for multiple dual-ported memory areas (DPMA). More...

Files
file	dpmem.h
	This header file defines the Dual-Ported Memory Manager API.

Functions
rtems_status_code	rtems_port_create (rtems_name name, void *internal_start, void *external_start, uint32_t length, rtems_id *id)
	% More...
rtems_status_code	rtems_port_delete (rtems_id id)
	% More...
rtems_status_code	rtems_port_external_to_internal (rtems_id id, void *external, void **internal)
	% More...
rtems_status_code	rtems_port_ident (rtems_name name, rtems_id *id)
	Identifies a port object by the specified object name. More...
rtems_status_code	rtems_port_internal_to_external (rtems_id id, void *internal, void **external)
	% More...

Detailed Description

The Dual-Ported Memory Manager provides a mechanism for converting addresses between internal and external representations for multiple dual-ported memory areas (DPMA).

Function Documentation

rtems_port_create()

rtems_status_code rtems_port_create	(	rtems_name	name,
		void *	internal_start,
		void *	external_start,
		uint32_t	length,
		rtems_id *	id
	)

%

Parameters

name	%
internal_start	%
external_start	%
length	%
id	%

rtems_port_delete()

rtems_status_code rtems_port_delete

(

rtems_id

id

)

%

Parameters

id

%

rtems_port_external_to_internal()

rtems_status_code rtems_port_external_to_internal	(	rtems_id	id,
		void *	external,
		void **	internal
	)

%

Parameters

id	%
external	%
internal	%

rtems_port_ident()

rtems_status_code rtems_port_ident	(	rtems_name	name,
		rtems_id *	id
	)

Identifies a port object by the specified object name.

This directive obtains the port identifier associated with the port name specified in name.

If the port name is not unique, then the port identifier will match the first port with that name in the search order. However, this port identifier is not guaranteed to correspond to the desired port. The port identifier is used with other dual-ported memory related directives to access the port.

The objects are searched from lowest to the highest index. Only the local node is searched.

Parameters

	name	is the object name to look up.
[out]	id	is the pointer to an object identifier variable. The object identifier of an object with the specified name will be stored in this variable, in case of a successful operation.

Return values

RTEMS_SUCCESSFUL	The requested operation was successful.
RTEMS_INVALID_ADDRESS	The id parameter was NULL.
RTEMS_INVALID_NAME	The name parameter was 0.
RTEMS_INVALID_NAME	There was no object with the specified name on the local node.

rtems_port_internal_to_external()

rtems_status_code rtems_port_internal_to_external	(	rtems_id	id,
		void *	internal,
		void **	external
	)

%

Parameters

id	%
internal	%
external	%