Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

dsp/inc/mpcs.h File Reference

#include <dsplink.h>
#include <mpcsdefs.h>

Include dependency graph for dsp/inc/mpcs.h:

Go to the source code of this file.

Defines

#define MPCS_H

Functions

Int MPCS_create (IN Uint16 procId, IN Char *name, IN MPCS_ShObj *mpcsObj, IN MPCS_Attrs *attrs)
 This function creates and initializes an instance of the MPCS object. The memory for the object may or may not be provided by the user. If provided by the user, the memory for the object must be shared across the processors using the MPCS. It must also already be mapped into user space for OSes supporting user/kernel separation.
Int MPCS_delete (IN Uint16 procId, IN Char *name)
 This function deletes the instance of the MPCS object.
Int MPCS_open (IN Uint16 procId, IN Char *name, OUT MPCS_Handle *mpcsHandle)
 This function opens an MPCS object specified by its name and gets a handle to the object. Every process that needs to use the MPCS object must get a handle to the object by calling this API.
Int MPCS_close (IN Uint16 procId, IN MPCS_Handle mpcsHandle)
 This function closes an MPCS object specified by its handle.
Int MPCS_enter (IN MPCS_Handle mpcsHandle)
 This function enters the critical section specified by the MPCS object.
Int MPCS_leave (IN MPCS_Handle mpcsHandle)
 This function leaves the critical section specified by the MPCS object.


Define Documentation

#define MPCS_H
 

Definition at line 45 of file dsp/inc/mpcs.h.


Function Documentation

Int MPCS_close IN Uint16  procId,
IN MPCS_Handle  mpcsHandle
 

This function closes an MPCS object specified by its handle.

============================================================================

Function:
MPCS_close
Parameters:
procId ID of the processor with which the MPCS is shared.
mpcsHandle Handle to the MPCS object to be closed.
Returns:
SYS_OK Operation successfully completed. SYS_EINVAL Invalid argument. SYS_EFREE Operation failed due to a memory error. SYS_ENOTFOUND Specified MPCS object name does not exist. SYS_EDEAD The MPCS component has not been initialized.
Precondition:
mpcsHandle must be valid.
Postcondition:
None
See also:
MPCS_open () ============================================================================

Int MPCS_create IN Uint16  procId,
IN Char *  name,
IN MPCS_ShObj mpcsObj,
IN MPCS_Attrs attrs
 

This function creates and initializes an instance of the MPCS object. The memory for the object may or may not be provided by the user. If provided by the user, the memory for the object must be shared across the processors using the MPCS. It must also already be mapped into user space for OSes supporting user/kernel separation.

============================================================================

Function:
MPCS_create
Parameters:
procId ID of the processor with which the MPCS object is to be shared.
name System-wide unique name for the MPCS object.
mpcsObj Pointer to the shared MPCS object. If memory for the MPCS object is provided by the user, the MPCS object handle is not NULL. Otherwise, if the memory is to be allocated by the MPCS component, the MPCS object handle can be specified as NULL.
attrs Attributes for creation of the MPCS object.
Returns:
SYS_OK Operation successfully completed. SYS_EINVAL Invalid argument. SYS_EALLOC Operation failed due to a memory error. SYS_EBUSY The specified MPCS name already exists. SYS_ENOTFOUND All MPCS entries are currently in use. SYS_EDEAD The MPCS component has not been initialized.
Precondition:
name must be valid. attrs must be valid.
Postcondition:
None
See also:
MPCS_delete () ============================================================================

Int MPCS_delete IN Uint16  procId,
IN Char *  name
 

This function deletes the instance of the MPCS object.

============================================================================

Function:
MPCS_delete
Parameters:
procId ID of the processor with which the MPCS is shared.
name System-wide unique name for the MPCS object.
Returns:
SYS_OK Operation successfully completed. SYS_EINVAL Invalid argument. SYS_EFREE Operation failed due to a memory error. SYS_ENOTFOUND Specified MPCS object name does not exist. SYS_EDEAD The MPCS component has not been initialized.
Precondition:
name must be valid.
Postcondition:
None
See also:
MPCS_create () ============================================================================

Int MPCS_enter IN MPCS_Handle  mpcsHandle  ) 
 

This function enters the critical section specified by the MPCS object.

============================================================================

Function:
MPCS_enter
Parameters:
mpcsHandle Handle to the MPCS object.
Returns:
SYS_OK Operation successfully completed. SYS_EINVAL Invalid argument.
Precondition:
mpcsHandle must be valid.
Postcondition:
None
See also:
MPCS_leave () ============================================================================

Int MPCS_leave IN MPCS_Handle  mpcsHandle  ) 
 

This function leaves the critical section specified by the MPCS object.

============================================================================

Function:
MPCS_leave
Parameters:
mpcsHandle Handle to the MPCS object.
Returns:
SYS_OK Operation successfully completed. SYS_EINVAL Invalid argument.
Precondition:
mpcsHandle must be valid.
Postcondition:
None
See also:
MPCS_enter () ============================================================================

Int MPCS_open IN Uint16  procId,
IN Char *  name,
OUT MPCS_Handle mpcsHandle
 

This function opens an MPCS object specified by its name and gets a handle to the object. Every process that needs to use the MPCS object must get a handle to the object by calling this API.

============================================================================

Function:
MPCS_open
Parameters:
procId ID of the processor with which the MPCS object is to be shared.
name System-wide unique name for the MPCS object.
mpcsHandle Location to receive the MPCS object handle, which is valid in the process space of the calling process.
Returns:
SYS_OK Operation successfully completed. SYS_EINVAL Invalid argument. SYS_EALLOC Operation failed due to a memory error. SYS_ENOTFOUND Specified MPCS object name does not exist. SYS_EDEAD The MPCS component has not been initialized.
Precondition:
name must be valid. mpcsHandle must be a valid pointer.
Postcondition:
None
See also:
MPCS_close () ============================================================================


Generated on Fri Jul 16 14:34:07 2010 for DSP/BIOSLink by  doxygen 1.4.4