19.4. Directives¶

This section details the directives of the Dual-Ported Memory Manager. A subsection is dedicated to each of this manager’s directives and lists the calling sequence, parameters, description, return values, and notes of the directive.

19.4.1. rtems_port_create()¶

Creates a port.

CALLING SEQUENCE:

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

PARAMETERS:

name: This parameter is the object name of the port.
internal_start: This parameter is the internal start address of the memory area.
external_start: This parameter is the external start address of the memory area.
length: This parameter is the length in bytes of the memory area.
id: This parameter is the pointer to an rtems_id object. When the directive call is successful, the identifier of the created port will be stored in this object.

DESCRIPTION:

This directive creates a port which resides on the local node. The port has the user-defined object name specified in name. The assigned object identifier is returned in id. This identifier is used to access the port with other dual-ported memory port related directives.

RETURN VALUES:

RTEMS_SUCCESSFUL: The requested operation was successful.
RTEMS_INVALID_NAME: The name parameter was invalid.
RTEMS_INVALID_ADDRESS: The id parameter was NULL.
RTEMS_INVALID_ADDRESS: The internal_start parameter was not properly aligned.
RTEMS_INVALID_ADDRESS: The external_start parameter was not properly aligned.
RTEMS_TOO_MANY: There was no inactive object available to create a port. The number of port available to the application is configured through the CONFIGURE_MAXIMUM_PORTS application configuration option.

NOTES:

The internal_start and external_start parameters must be on a boundary defined by the target processor architecture.

For control and maintenance of the port, RTEMS allocates a DPCB from the local DPCB free pool and initializes it.

CONSTRAINTS:

The following constraints apply to this directive:

The directive may be called from within device driver initialization context.
The directive may be called from within task context.
The directive may obtain and release the object allocator mutex. This may cause the calling task to be preempted.
The number of ports available to the application is configured through the CONFIGURE_MAXIMUM_PORTS application configuration option.
Where the object class corresponding to the directive is configured to use unlimited objects, the directive may allocate memory from the RTEMS Workspace.

19.4.2. rtems_port_ident()¶

Identifies a port by the object name.

CALLING SEQUENCE:

rtems_status_code rtems_port_ident( rtems_name name, rtems_id *id );

PARAMETERS:

name: This parameter is the object name to look up.
id: This parameter is the pointer to an rtems_id object. When the directive call is successful, the object identifier of an object with the specified name will be stored in this object.

DESCRIPTION:

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

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.

NOTES:

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 objects are searched from lowest to the highest index. Only the local node is searched.

The port identifier is used with other dual-ported memory related directives to access the port.

CONSTRAINTS:

The following constraints apply to this directive:

The directive may be called from within any runtime context.
The directive will not cause the calling task to be preempted.

19.4.3. rtems_port_delete()¶

Deletes the port.

CALLING SEQUENCE:

rtems_status_code rtems_port_delete( rtems_id id );

PARAMETERS:

id: This parameter is the port identifier.

DESCRIPTION:

This directive deletes the port specified by id.

RETURN VALUES:

RTEMS_SUCCESSFUL: The requested operation was successful.
RTEMS_INVALID_ID: There was no port associated with the identifier specified by id.

NOTES:

The DPCB for the deleted port is reclaimed by RTEMS.

CONSTRAINTS:

The following constraints apply to this directive:

The directive may be called from within device driver initialization context.
The directive may be called from within task context.
The directive may obtain and release the object allocator mutex. This may cause the calling task to be preempted.
The calling task does not have to be the task that created the object. Any local task that knows the object identifier can delete the object.
Where the object class corresponding to the directive is configured to use unlimited objects, the directive may free memory to the RTEMS Workspace.

19.4.4. rtems_port_external_to_internal()¶

Converts the external address to the internal address.

CALLING SEQUENCE:

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

PARAMETERS:

id: This parameter is the port identifier.
external: This parameter is the external address to convert.
internal: This parameter is the pointer to a void pointer object. When the directive call is successful, the external address associated with the internal address will be stored in this object.

DESCRIPTION:

This directive converts a dual-ported memory address from external to internal representation for the specified port. If the given external address is invalid for the specified port, then the internal address is set to the given external address.

RETURN VALUES:

RTEMS_SUCCESSFUL: The requested operation was successful.
RTEMS_INVALID_NAME: The id parameter was invalid.
RTEMS_INVALID_ADDRESS: The internal parameter was NULL.

CONSTRAINTS:

The following constraints apply to this directive:

The directive may be called from within interrupt context.
The directive may be called from within device driver initialization context.
The directive may be called from within task context.
The directive will not cause the calling task to be preempted.

19.4.5. rtems_port_internal_to_external()¶

Converts the internal address to the external address.

CALLING SEQUENCE:

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

PARAMETERS:

id: This parameter is the port identifier.
internal: This parameter is the internal address to convert.
external: This parameter is the pointer to a void pointer object. When the directive call is successful, the external address associated with the internal address will be stored in this object.

DESCRIPTION:

This directive converts a dual-ported memory address from internal to external representation so that it can be passed to owner of the DPMA represented by the specified port. If the given internal address is an invalid dual-ported address, then the external address is set to the given internal address.

RETURN VALUES:

RTEMS_SUCCESSFUL: The requested operation was successful.
RTEMS_INVALID_NAME: The id parameter was invalid.
RTEMS_INVALID_ADDRESS: The external parameter was NULL.

CONSTRAINTS:

The following constraints apply to this directive:

The directive may be called from within interrupt context.
The directive may be called from within device driver initialization context.
The directive may be called from within task context.
The directive will not cause the calling task to be preempted.