List of services

This section contains a list of services that are currently traced in PXROS-HR. You can find the complete list of services in the header file pxservice.h.

Note that object ID is only part of an object handle.

Events to wait for and waiting events mean the same thing.

The logical separator for different arguments and error meanings is "or".

The following tables are written in this format:

Tab. 1. List of services format
Name Group

Fn

Functions where called

A1

Argument 1 meaning (omitted if not used)

A2

Argument 2 meaning (omitted if not used)

Er

Error meaning (omitted if not used)

APPINFO

PXSvSetAppinfo PXVT_APPINFO

Fn

PxSetAppinfo()

A1

Application info to set

PXSvGetAppinfo PXVT_APPINFO

Fn

PxGetAppinfo()

A1

Application info set by PxSetAppinfo()

DELAY

PXSvDelaySched PXVT_DELAY

Fn

PxDelaySched()

A1

ID of the delay job object to schedule

A2

PxTicks_t when the job is executed

Er

PxDelaySched() error codes

PXSvDelayRequest PXVT_DELAY

Fn

PxDelayRequest()

A1

ID of the delay job object if the request was successful or invalid ID on failure

Er

PxDelayRequest() error codes

PXSvDelayRequest_EvWait PXVT_DELAY, PXVT_EVENT

Fn

PXSvDelayRequest_EvWait()

A1

ID of the delay job object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PXSvDelayRequest_EvWait() error codes

PXSvDelayRequest_NoWait PXVT_DELAY

Fn

PXSvDelayRequest_NoWait()

A1

ID of the delay job object if the request was successful or invalid ID on failure

Er

PXSvDelayRequest_NoWait() error codes

PXSvDelayRelease PXVT_DELAY

Fn

PxDelayRelease()

A1

Pointer to an internal PXROS-HR delay job object to release or 0 on failure

Er

PxDelayRelease() error codes

PXSvDelaySched_Hnd PXVT_DELAY, PXVT_HND

Fn

1) PxDelaySched_Hnd()

2) Internal delay sysjob handling (delay service)

A1

ID of the delay job object to schedule

A2

PxTicks_t when the job is executed

Er

1) PxDelaySched_Hnd() error codes

DIE

PXSvDie PXVT_DIE

Fn

PxDie()

Er

PxDie() error codes

ERROR

PXSvSetError PXVT_ERROR

Fn

PxSetError()

A1

Error code to set (remember)

PXSvGetError PXVT_ERROR

Fn

PxGetError()

A1

Remembered error code

EVENT

PXSvMsgReceive_EvWait PXVT_MSG, PXVT_EVENT

Fn

PxMsgReceive_EvWait()

A1

ID of the received message object if the message was received or invalid ID on failure/event abortion

A2

Events, if the receive was aborted by a waiting event

Er

PxMsgReceive_EvWait() error codes

PXSvMsgReceive_EvWait_Waiting PXVT_MSG, PXVT_EVENT

Fn

PxMsgReceive_EvWait()

A1

ID of the mailbox object from which to get a message

A2

Events to wait for

PXSvMsgEnvelop_EvWait PXVT_MSG, PXVT_EVENT

Fn

PxMsgEnvelop_EvWait()

A1

The beginning of the data area to be enveloped

A2

Data area’s size in bytes

Er

PxMsgEnvelop_EvWait() error codes

PXSvMsgAwaitRel_EvWait PXVT_MSG, PXVT_EVENT

Fn

PxMsgAwaitRel_EvWait()

A1

ID of the message object to wait for or invalid ID on failure/event abortion

A2

Events, if the waiting was aborted by a waiting event

Er

PxMsgAwaitRel_EvWait() error codes

PXSvMsgAwaitRel_EvWait_Waiting PXVT_MSG, PXVT_EVENT

Fn

PxMsgAwaitRel_EvWait()

A1

ID of the message object to wait for

A2

Events to wait for

PXSvAwaitEvents PXVT_EVENT

Fn

PxAwaitEvents()

A1

Received events

A2

Events to wait for

PXSvAwaitEvents_Waiting PXVT_EVENT

Fn

PxAwaitEvents()

A1

Events to wait for

PXSvResetEvents PXVT_EVENT

Fn

PxResetEvents()

A1

Events to reset

A2

Events that were successfully reset

PXSvTaskSignalEvents PXVT_EVENT

Fn

PxTaskSignalEvents()

A1

ID of the task object to send events to

A2

Events to send

Er

PxTaskSignalEvents() error codes

PXSvGetSavedEvents PXVT_EVENT

Fn

PxGetSavedEvents()

A1

Saved events of the calling task

PXSvGetAbortingEvents PXVT_EVENT

Fn

PxGetAbortingEvents()

A1

Aborting events of the calling task

PXSvGetAbortFrameSize PXVT_EVENT

Fn

PxGetAbortFrameSize()

A1

Size of an abort frame in bytes (sizeof(PxAbortframe_T))

PXSvDelayRequest_EvWait PXVT_DELAY, PXVT_EVENT

Fn

PXSvDelayRequest_EvWait()

A1

ID of the delay job object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PXSvDelayRequest_EvWait() error codes

PXSvInterruptRequest_EvWait PXVT_INTERRUPT, PXVT_EVENT

Fn

PxInterruptRequest_EvWait()

A1

ID of the interrupt object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PxInterruptRequest_EvWait() error codes

PXSvMbxRequest_EvWait PXVT_MBX, PXVT_EVENT

Fn

PxMbxRequest_EvWait()

A1

ID of the mailbox object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PxMbxRequest_EvWait() error codes

PXSvMcRequest_EvWait PXVT_MC, PXVT_EVENT

Fn

PxMcRequest_EvWait()

A1

ID of the memory class object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PxMcRequest_EvWait() error codes

PXSvToRequest_EvWait PXVT_TO, PXVT_EVENT

Fn

PxToRequest_EvWait()

A1

ID of the timeout object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PxToRequest_EvWait() error codes

PXSvTaskSignalEvents_Hnd PXVT_EVENT, PXVT_HND

Fn

Internal task service (event service)

A1

ID of the task object to which the event is to be signalled

A2

Events to signal

INTERRUPT

PXSvInterruptRequest PXVT_INTERRUPT

Fn

PxInterruptRequest()

A1

ID of the interrupt object if the request was successful or invalid ID on failure

Er

PxInterruptRequest() error codes

PXSvInterruptRequest_EvWait PXVT_INTERRUPT, PXVT_EVENT

Fn

PxInterruptRequest_EvWait()

A1

ID of the interrupt object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PxInterruptRequest_EvWait() error codes

PXSvInterruptRequest_NoWait PXVT_INTERRUPT

Fn

PxInterruptRequest_NoWait()

A1

ID of the interrupt object if the request was successful or invalid ID on failure

Err

PxInterruptRequest_NoWait() error codes

PXSvInterruptRelease PXVT_INTERRUPT

Fn

PxInterruptRelease()

A1

Invalid ID if the release was successful or ID of the interrupt object to release on failure

Er

PxInterruptRelease() error codes

HND

PXSvTaskSignalEvents_Hnd PXVT_EVENT, PXVT_HND

Fn

Internal task service (event service)

A1

ID of the task object to which the event is to be signalled

A2

Events to signal

PXSvDelaySched_Hnd PXVT_DELAY, PXVT_HND

Fn

1) PxDelaySched_Hnd()

2) internal delay sysjob handling (delay service)

A1

ID of the delay job object to schedule

A2

PxTicks_t when the job is executed

Er

1) PxDelaySched_Hnd() error codes

PXSvMsgGetData_Hnd PXVT_MSG, PXVT_HND

Fn

PxMsgGetData_Hnd()

A1

ID of the message object which message data to get

A2

The beginning of the message data area or 0 on failure

Er

PxMsgGetData_Hnd() error codes

PXSvMsgSend_Hnd PXVT_MSG, PXVT_HND

Fn

1) Internal function for PxMsgSend_Hnd(), PxMsgSend_PrioHnd()

2) Internal postservice for handler send (message send service)

A1

1) Invalid ID if send was successful or ID of the message object to send on failure

2) ID of the message object to send

A2

ID of the mailbox object to send the message to

Er

1) PxMsgSend_Hnd() and PxMsgSend_PrioHnd() error codes

PXSvMsgRelease_Hnd PXVT_MSG, PXVT_HND

Fn

1) PxMsgRelease_Hnd()

2) Internal postservice for handler release (message release service)

A1

1) Invalid ID if the release was successful or ID of the release mailbox object of the message to release if both message and mailbox objects are from cores different than the caller’s and release mailbox is installed and no other task is waiting for the message or ID of the message object to release on failure

2) Invalid ID if error or ID of the message object to release

Er

1) PxMsgRelease_Hnd() error codes

2) PXERR_MSG_ILLMSG, PXERR_GLOBAL_ILLEGAL_CORE, PXERR_REQUEST_ILLEGAL — release to release mailbox is already done in PxMsgRelease_Hnd(), PXERR_MSG_ILLOWNER, PXERR_MC_ILLMC, PXERR_OPOOL_ILLOPOOL

PXSvPeStart_Hnd PXVT_PE, PXVT_HND

Fn

PxPeStart_Hnd()

A1

ID of the periodic event object to start

A2

Signal period of the event in number of PxTicks_t

Er

PxPeStart_Hnd() error codes

PXSvPeStop_Hnd PXVT_PE, PXVT_HND

Fn

PxPeStop_Hnd()

A1

ID of the periodic event object to stop

A2

Signal period of the event in number of PxTicks_t

Er

PxPeStop_Hnd() error codes

PXSvToStart_Hnd PXVT_TO, PXVT_HND

Fn

PxToStart_Hnd()

A1

ID of the timeout object to start

A2

Amount of timeout in number of PxTicks_t

Er

PxToStart_Hnd() error codes

PXSvToStop_Hnd PXVT_TO, PXVT_HND

Fn

PxToStop_Hnd()

A1

ID of timeout object to stop

A2

Amount of timeout in number of PxTicks_t

PXSvMsgGetMetadata_Hnd PXVT_MSG, PXVT_HND

Fn

PxMsgGetMetadata_Hnd()

A1

ID of the message object which message metadata to get

A2

Lower 32 bits of the message metadata or 0 on failure

Er

PxMsgGetMetadata_Hnd() error codes

PXSvMsgSetMetadata_Hnd PXVT_MSG, PXVT_HND

Fn

PxMsgSetMetadata_Hnd()

A1

ID of the message object which message metadata to set

A2

Lower 32 bits of the message metadata to set

Er

PxMsgSetMetadata_Hnd() error codes

INTS

PXSvTrapInstallHandler PXVT_INTS

Fn

PxTrapInstallHandler()

A1

Trap number for which to install the handler

A2

Pointer to the trap handler to be installed

Er

PxTrapInstallHandler() error codes

PXSvIntInstallHandler PXVT_INTS

Fn

PxIntInstallHandler()

A1

Interrupt number for which to install the context handler

A2

Pointer to the interrupt handler to be installed

Er

PxIntInstallHandler() error codes

PXSvIntInstallService PXVT_INTS

Fn

PxIntInstallService()

A1

Interrupt number for which to install the PxIntSvEnum_t service

A2

PxIntSvEnum_t service

Er

PxIntInstallService() error codes

PXSvIntInstallFastHandler PXVT_INTS

Fn

PxIntInstallFastHandler()

A1

Interrupt number for which to install the fast handler

A2

Pointer to the interrupt handler to be installed

Er

PxIntInstallFastHandler() error codes

PXSvIntInstallFastContextHandler PXVT_INTS

Fn

PxIntInstallFastContextHandler()

A1

Interrupt number for which to install the fast context handler

A2

Pointer to the interrupt handler to be installed

Fn

PxIntInstallFastContextHandler() error codes

PXSvIntEntry PXVT_INTS

Fn

1) Internal class 1 trap handler

2) Internal general interrupt handler

A1

1) Program Counter when the trap occurred — address, where the fault happened

2) ID of the task object that installed the interrupt handler or 0 if illegal interrupt

A2

1) 0x100 + trap identification number (TIN)

2) Interrupt number to process

PXSvIntExit PXVT_INTS

Fn

1) Internal class 1 trap handler

2) Internal general interrupt handler

3) Internal interrupt service

A1

1) Trap handler solved status: 1 — for solved (internal class 1 trap handler solved the problem, let the task continue), 0 — internal class 1 trap handler couldn’t solve the problem

2) ID of the task object that installed the interrupt handler or 0 if illegal interrupt

A2

1) 0x100 + trap identification number (TIN)

2) Interrupt number to process

3) Interrupt number to process or 0 on failure

Er

3) PXERR_INTERRUPT_ILLINTERRUPT, PXERR_TASK_ILLTASK

MBX

PXSvMbxInstallHnd PXVT_MBX

Fn

PxMbxInstallHnd()

A1

ID of the mailbox object for which to install the mailbox handler

A2

PxMsgType_t — Message types activating the mailbox handler

Er

PxMbxInstallHnd() error codes

PXSvMbxRequest PXVT_MBX

Fn

PxMbxRequest()

A1

ID of the mailbox object if the request was successful or invalid ID on failure

Er

PxMbxRequest() error codes

PXSvMbxRequest_EvWait PXVT_MBX, PXVT_EVENT

Fn

PxMbxRequest_EvWait()

A1

ID of the mailbox object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PxMbxRequest_EvWait() error codes

PXSvMbxRequest_NoWait PXVT_MBX

Fn

PxMbxRequest_NoWait()

A1

ID of the mailbox object if the request was successful or invalid ID on failure

Er

PxMbxRequest_NoWait() error codes

PXSvMbxRelease PXVT_MBX

Fn

PxMbxRelease()

A1

Invalid ID if the release was successful or ID of the mailbox object to release on failure

Er

PxMbxRelease() error codes

MC

PXSvMcTakeBlk PXVT_MC

Fn

1) PxMcTakeBlk()

2) Internal message request function

A1

ID of the memory class from which the block is taken

A2

Start address of a block on success or 0 on failure

Er

1) PxMcTakeBlk() error codes

2) PXERR_MC_ILLMC, PXERR_MC_NOMEM

PXSvMcReturnBlk PXVT_MC

Fn

1) PxMcReturnBlk()

2) Internal release message function

A1

1) ID of the memory class object the block is returned to

2) ID of the memory class object where to return the block used for message data if no error occurred during the internal message release function and the memory class is at the same core as the function is being executed or 0 otherwise

A2

1) Start address of the block to return

2) Start address of the message data of the message that is being released if no error occurred during the internal message release function or 0 otherwise

Er

1) PxMcReturnBlk() error codes

2) PXERR_MSG_ILLMSG, PXERR_MSG_ILLOWNER, PXERR_MC_ILLMC, PXERR_MC_DAMAGED_BLOCK

PXSvMcInsertBlk PXVT_MC

Fn

PxMcInsertBlk()

A1

ID of the memory class object where to insert the block

A2

Start address of the memory block to insert if PXERR_ACCESS_RIGHT is not in error argument, 0 if PXERR_ACCESS_RIGHT is in error argument

Er

PxMcInsertBlk() error codes

PXSvMcGetSize PXVT_MC

Fn

PxMcGetSize()

A1

ID of the memory class object which size to get

A2

Block size of the memory class in bytes if the request is successful and the memory class type is PXMcFixsized or 0 otherwise

Er

PxMcGetSize() error codes

PXSvMcGetType PXVT_MC

Fn

PxMcGetType()

A1

ID of the memory class object which type to get

A2

PxMcType_t memory class type or PXMcTypeLast on failure

Er

PxMcGetType() error codes

PXSvMcResolveDefault PXVT_MC

Fn

PxMcResolveDefault()

A1

ID of the memory class object which was resolved or invalid ID on failure

Er

PxMcResolveDefault() error codes

PXSvMcGetVarsizedOverhead PXVT_MC

Fn

PxMcGetVarsizedOverhead()

A1

Size of overhead per block of a varsized memory class in bytes, PXMAXUINT on failure

A2

ID of the memory class object which overhead of a varsized memory class to get

Er

PxMcGetVarsizedOverhead() error codes

PXSvMcRequest PXVT_MC

Fn

PxMcRequest()

A1

ID of the memory class object if the request was successful or invalid ID on failure

Er

PxMcRequest() error codes

PXSvMcRequest_EvWait PXVT_MC, PXVT_EVENT

Fn

PxMcRequest_EvWait()

A1

ID of the memory class object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PxMcRequest_EvWait() error codes

PXSvMcRequest_NoWait PXVT_MC

Fn

PxMcRequest_NoWait()

A1

ID of the memory class object if the request was successful or invalid ID on failure

Er

PxMcRequest_NoWait() error codes

PXSvMcRelease PXVT_MC

Fn

PxMcRelease()

A1

Pointer to an internal PXROS-HR memory class object or 0 on failure

Er

PxMcRelease() error codes

MODE

PXSvRemoveAccessRights PXVT_MODE

Fn

PxRemoveAccessRights()

A1

The access rights to remove

A2

The access rights after removal (new access rights)

PXSvRestoreAccessRights PXVT_MODE

Fn

PxRestoreAccessRights()

A1

The access rights to restore

A2

The access rights after restoration (new access rights)

Er

PxRestoreAccessRights() error codes

MSG

PXSvMsgReceive PXVT_MSG

Fn

PxMsgReceive()

A1

ID of the received message object or invalid ID on failure

A2

ID of the mailbox object from which to get a message

Fn

PxMsgReceive() error codes

PXSvMsgReceive_Waiting PXVT_MSG

Fn

PxMsgReceive()

A2

ID of the mailbox object from which to get a message

PXSvMsgReceive_EvWait PXVT_MSG, PXVT_EVENT

Fn

PxMsgReceive_EvWait()

A1

ID of the received message object if the message was received or invalid ID on failure/event abortion

A2

Events, if the receive was aborted by a waiting event

Er

PxMsgReceive_EvWait() error codes

PXSvMsgReceive_EvWait_Waiting PXVT_MSG, PXVT_EVENT

Fn

PxMsgReceive_EvWait()

A1

ID of the mailbox object from which to get a message

A2

Events to wait for

PXSvMsgReceive_NoWait PXVT_MSG

Fn

PxMsgReceive_NoWait()

A1

ID of the received message object or invalid ID on failure

A2

ID of the mailbox object from which to get a message

Er

PxMsgReceive_NoWait() error codes

PXSvMsgSend PXVT_MSG

Fn

Internal function to send a message

A1

Invalid ID if the send was successful or ID of the message object to send

A2

ID of the mailbox object where to send the message

Er

PXERR_MSG_ILLMSG, PXERR_MBX_ILLMBX, PXERR_MSG_ILLUSER

PXSvMsgRequest PXVT_MSG

Fn

1) PxMsgRequest()

2) PxMsgRequest_EvWait()

3) PxMsgRequest_NoWait()

A1

1) ID of the requested message object

2) ID of the requested message object or invalid ID if the request was aborted by a waiting event

3) ID of the requested message object if the request was successful or invalid ID on failure

A2

ID of the memory class from which the block is taken

Er

1) PxMsgRequest() error codes

2) PxMsgRequest_EvWait() error codes

3) PxMsgRequest_NoWait() error codes

PXSvMsgEnvelop PXVT_MSG

Fn

PxMsgEnvelop()

A1

The beginning of the data area to be enveloped

A2

Data area’s size in bytes

Er

PxMsgEnvelop() error codes

PXSvMsgEnvelop_EvWait PXVT_MSG, PXVT_EVENT

Fn

PxMsgEnvelop_EvWait()

A1

The beginning of the data area to be enveloped

A2

Data area’s size in bytes

Er

PxMsgEnvelop_EvWait() error codes

PXSvMsgEnvelop_NoWait PXVT_MSG

Fn

PxMsgEnvelop_NoWait()

A1

The beginning of the data area to be enveloped

A2

Data area’s size in bytes

Er

PxMsgEnvelop_NoWait() error codes

PXSvMsgRelease PXVT_MSG

Fn

PxMsgRelease()

A1

ID of the message object to release

Er

PxMsgRelease() error codes

PXSvMsgSetSize PXVT_MSG

Fn

PxMsgSetSize()

A1

ID of the message object which size to set

A2

Size of the message to set in bytes

Er

PxMsgSetSize() error codes

PXSvMsgInstallRelmbx PXVT_MSG

Fn

PxMsgInstallRelmbx()

A1

ID of the message object for which to install the release mailbox

A2

ID of the mailbox object to be used as release mailbox

Er

PxMsgInstallRelmbx() error codes

PXSvMsgAwaitRel PXVT_MSG

Fn

PxMsgAwaitRel()

A1

ID of the message object that was waited for

A2

Message type or it may/may not be 0 if the message released/aborted by an event

Message types for this tracing service:

1) PXMsgEnveloped: (1<<0)

2) PXMsgRequested: (1<<1)

3) PXMsgAwaitRelease: (1<<5)

4) PXMsgReleased: (1<<6)

5) PXMsgRelMbx: (1<<7)

Er

PxMsgAwaitRel() error codes

PXSvMsgAwaitRel_Waiting PXVT_MSG

Fn

PxMsgAwaitRel()

A1

ID of the message object that is waited for

PXSvMsgAwaitRel_EvWait PXVT_MSG, PXVT_EVENT

Fn

PxMsgAwaitRel_EvWait()

A1

ID of the message object to wait for or invalid ID on failure/event abortion

A2

Events, if the waiting was aborted by a waiting event

Er

PxMsgAwaitRel_EvWait() error codes

PXSvMsgAwaitRel_EvWait_Waiting PXVT_MSG, PXVT_EVENT

Fn

PxMsgAwaitRel_EvWait()

A1

ID of the message object to wait for

A2

Events to wait for

PXSvMsgAwaitRel_NoWait PXVT_MSG

Fn

PxMsgAwaitRel_NoWait()

A1

ID of the message object which release is checked or invalid ID if the function is called with an invalid ID

Er

PxMsgAwaitRel_NoWait() error codes

PXSvMsgSetToAwaitRel PXVT_MSG

Fn

PxMsgSetToAwaitRel()

A1

ID of the message object to mark for await release

Er

PxMsgSetToAwaitRel() error codes

PXSvMsgReleaseAllMsg PXVT_MSG

Fn

PxMsgReleaseAllMsg()

Er

PxMsgReleaseAllMsg() error codes

PXSvMsgGetData PXVT_MSG

Fn

PxMsgGetData()

A1

ID of the message object which data to get

A2

The beginning of the message data area or 0 on failure

Er

PxMsgGetData() error codes

PXSvMsgRelDataAccess PXVT_MSG

Fn

PxMsgRelDataAccess()

A1

ID of the message object which access to the message data area to release

Er

PxMsgRelDataAccess() error codes

PXSvMsgGetSize PXVT_MSG

Fn

PxMsgGetSize()

A1

ID of the message object which size to get

A2

Size of the message in bytes or 0 on failure

Er

PxMsgGetSize() error codes

PXSvMsgGetBuffersize PXVT_MSG

Fn

PxMsgGetBuffersize()

A1

ID of the message object which buffer size to get

A2

Size of the message data area in bytes or 0 on failure

Er

PxMsgGetBuffersize() error codes

PXSvMsgGetOwner PXVT_MSG

Fn

PxMsgGetOwner()

A1

ID of the message object which owner to get

A2

ID of the task object being the owner of the message or invalid ID on failure

Er

PxMsgGetOwner() error codes

PXSvMsgGetProtection PXVT_MSG

Fn

PxMsgGetProtection()

A1

ID of the message object which protection mode to get

A2

PxProtectType_t protection mode or NoAccessProtection on failure

Er

PxMsgGetProtection() error codes

PXSvMsgSetProtection PXVT_MSG

Fn

PxMsgSetProtection()

A1

ID of the message object which protection mode to set

A2

PxProtectType_t protection mode to set

Er

PxMsgSetProtection() error codes

PXSvMsgForceRelease PXVT_MSG

Fn

PxMsgForceRelease()

Er

PxMsgForceRelease() error codes

PXSvMsgSetData PXVT_MSG

Fn

PxMsgSetData()

A1

ID of the message object which message data to set

A2

The beginning of the data area to set

Er

PxMsgSetData() error codes

PXSvMsgGetSender PXVT_MSG

Fn

PxMsgGetSender()

A1

ID of the message object which sender to get

A2

ID of the task object being the sender of the message or invalid ID on failure

Er

PxMsgGetSender() error codes

PXSvMsgGetMetadata PXVT_MSG

Fn

PxMsgGetMetadata()

A1

ID of the message object which message metadata to get

A2

Lower 32 bits of the message metadata or 0 on failure

Fn

PxMsgGetMetadata() error codes

PXSvMsgSetMetadata PXVT_MSG

Fn

PxMsgSetMetadata()

A1

ID of the message object which message metadata to set

A2

Lower 32 bits of the message metadata

Er

PxMsgSetMetadata() error codes

PXSvMsgGetData_Hnd PXVT_MSG, PXVT_HND

Fn

PxMsgGetData_Hnd()

A1

ID of the message object which message data to get

A2

The beginning of the message data area or 0 on failure

Er

PxMsgGetData_Hnd() error codes

PXSvMsgSend_Hnd PXVT_MSG, PXVT_HND

Fn

1) Internal function for PxMsgSend_Hnd(), PxMsgSend_PrioHnd()

2) Internal postservice for handler send (message send service)

A1

1) Invalid ID if send was successful or ID of the message object to send on failure

2) ID of the message object to send

A2

ID of the mailbox object to send the message to

Er

1) PxMsgSend_Hnd() and PxMsgSend_PrioHnd() error codes

PXSvMsgRelease_Hnd PXVT_MSG, PXVT_HND

Fn

1) PxMsgRelease_Hnd()

2) Internal postservice for handler release (message release service)

A1

1) Invalid ID if the release was successful or ID of the release mailbox object of the message to release if both message and mailbox objects are from cores different than the caller’s and release mailbox is installed and no other task is waiting for the message or ID of the message object to release on failure

2) Invalid ID if error or ID of the message object to release

Er

1) PxMsgRelease_Hnd() error codes

2) PXERR_MSG_ILLMSG, PXERR_GLOBAL_ILLEGAL_CORE, PXERR_REQUEST_ILLEGAL — release to release mailbox is already done in PxMsgRelease_Hnd(), PXERR_MSG_ILLOWNER, PXERR_MC_ILLMC, PXERR_OPOOL_ILLOPOOL

PXSvMsgGetMetadata_Hnd PXVT_MSG, PXVT_HND

Fn

PxMsgGetMetadata_Hnd()

A1

ID of the message object which message metadata to get

A2

Lower 32 bits of the message metadata or 0 on failure

Er

PxMsgGetMetadata_Hnd() error codes

PXSvMsgSetMetadata_Hnd PXVT_MSG, PXVT_HND

Fn

PxMsgSetMetadata_Hnd()

A1

ID of the message object which message metadata to set

A2

Lower 32 bits of the message metadata to set

Er

PxMsgSetMetadata_Hnd() error codes

OBJ

PXSvObjSetName PXVT_OBJ

Fn

PxObjSetName()

A1

ID of the object which name to set

Er

PxObjSetName() error codes

PXSvGetObjsize PXVT_OBJ

Fn

PxGetObjsize()

A1

Size of a generic PXROS-HR object in bytes

PXSvObjGetName PXVT_OBJ

Fn

PxObjGetName()

A1

ID of the object which name to set

A2

Pointer to a buffer provided by the user (contains the object name if the request was successful)

Er

PxObjGetName() error codes

PXSvObjRequest_Waiting PXVT_OBJ

Fn

Internal function for object requests

A1

Events to wait for

A2

ID of object pool object from which the requested object is taken

OPOOL

PXSvOpoolGetCurrentCapacity PXVT_OPOOL

Fn

PxOpoolGetCurrentCapacity()

A1

ID of the object pool object which current capacity to get

A2

Current capacity of the object pool or 0 on failure

Er

PxOpoolGetCurrentCapacity() error codes

PXSvOpoolGetType PXVT_OPOOL

Fn

PxOpoolGetType()

A1

ID of the object pool object which type to get

A2

PxOpoolType_t object pool type or PXOpoolIllegalType on failure

Er

PxOpoolGetType() error codes

PXSvOpoolResolveDefault PXVT_OPOOL

Fn

PxOpoolResolveDefault()

A1

ID of the object pool object which was resolved or invalid ID on failure

Er

PxOpoolResolveDefault() error codes

PXSvOpoolRequest PXVT_OPOOL

Fn

PxOpoolRequest()

A1

ID of the object pool object if the request was successful or invalid ID on failure

Er

PxOpoolRequest() error codes

PXSvOpoolRequest_NoWait PXVT_OPOOL

Fn

PxOpoolRequest_NoWait()

A1

ID of the object pool object if the request was successful or invalid ID on failure

Er

PxOpoolRequest_NoWait() error codes

PXSvOpoolRelease PXVT_OPOOL

Fn

PxOpoolRelease()

A1

Pointer to an internal PXROS-HR object pool object to release or 0 on failure

Er

PxOpoolRelease() error codes

PE

PXSvPeRequest PXVT_PE

Fn

PxPeRequest()

A1

ID of the periodic event object if the request was successful or invalid ID on failure

A2

Period in number of PxTicks_t that is requested

Er

PxPeRequest() error codes

PXSvPeStart PXVT_PE

Fn

PxPeStart()

A1

ID of the periodic event object to start

A2

Period in number of PxTicks_t or 0 on failure

Er

PxPeStart() error codes

PXSvPeStop PXVT_PE

Fn

PxPeStop()

A1

ID of the periodic event object to stop

A2

Period in number of PxTicks_t or 0 on failure

Er

PxPeStop() error codes

PXSvPeRelease PXVT_PE

Fn

PxPeRelease()

A1

Invalid ID if the release was successful or ID of the periodic event object to release

Fn

PxPeRelease() error codes

PXSvPeChange PXVT_PE

Fn

PxPeChange()

A1

ID of the periodic event object which period to change

A2

Period in number of PxTicks_t to set

Er

PxPeChange() error codes

PXSvPeRequest_NoWait PXVT_PE

Fn

PxPeRequest_NoWait()

A1

ID of the periodic event object if the request was successful or invalid ID on failure

Er

PxPeRequest_NoWait() error codes

PXSvPeRequest_EvWait PXVT_PE

Fn

PXSvPeRequest_EvWait()

A1

ID of the periodic event object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PXSvPeRequest_EvWait() error codes

PXSvPeStart_Hnd PXVT_PE, PXVT_HND

Fn

PxPeStart_Hnd()

A1

ID of the periodic event object to start

A2

Signal period of the event in number of PxTicks_t

Er

PxPeStart_Hnd() error codes

PXSvPeStop_Hnd PXVT_PE, PXVT_HND

Fn

PxPeStop_Hnd()

A1

ID of the periodic event object to stop

A2

Signal period of the event in number of PxTicks_t

Er

PxPeStop_Hnd() error codes

SCHEDULING

PXSvTraceEnterScheduling PXVT_SCHEDULING

Fn

Internal service exit function

A1

ID of the task object that was running previously or 0 if there was no running task (the processor was idle)

A2

PxSchedCause_t cause of the scheduling

Er

ID of the task object that will be running or 0 if there is not any task to run

PXSvRdyFromWait PXVT_SCHEDULING

Fn

Internal static task function to make the task ready from the event waiting state

A1

ID of the task object to make ready

TASK

PXSvTaskGetModebits PXVT_TASK

Fn

PxTaskGetModebits()

A1

ID of the task object which mode bits to get

A2

Task mode bits of given task or 0 on failure

Er

PxTaskGetModebits() error codes

PXSvSetModebits PXVT_TASK

Fn

PxSetModebits()

A1

Task mode bits to set

A2

Task mode bits after setting

Er

PxSetModebits() error codes

PXSvClearModebits PXVT_TASK

Fn

PxClearModebits()

A1

Task mode bits to clear

A2

Task mode bits after clearing

PXSvTaskCreate PXVT_TASK

Fn

PxTaskCreate()

A1

ID of the task object that was created if there is no error in the error argument or 0 otherwise

A2

Pointer to the task specification structure

Er

PxTaskCreate() error codes

PXSvTaskSuspend PXVT_TASK

Fn

PxTaskSuspend(), PxTaskSuspend_Hnd

A1

ID of the task object to suspend

Er

PxTaskSuspend() and PxTaskSuspend_Hnd error codes

PXSvTaskResume PXVT_TASK

Fn

PxTaskResume()

A1

ID of the task object to resume

Er

PxTaskResume() error codes

PXSvTaskSetPrio PXVT_TASK

Fn

PxTaskSetPrio()

A1

ID of the task object which priority to set

A2

The task priority to set

Er

PxTaskSetPrio() error codes

PXSvGetId PXVT_TASK

Fn

PxGetId()

A1

ID of the task object which is requested

PXSvTaskGetPrio PXVT_TASK

Fn

PxTaskGetPrio()

A1

ID of the task object which priority to get

A2

The task priority or 0 on failure

Er

PxTaskGetPrio()

PXSvTaskGetMbx PXVT_TASK

Fn

PxTaskGetMbx()

A1

ID of the task object which mailbox to get

A2

ID of the requested mailbox object or invalid ID on failure

PXSvTaskGetSize PXVT_TASK

Fn

PxTaskGetSize()

A1

Size of a task control block in bytes

PXSvTaskForceTermination PXVT_TASK

Fn

PxTaskForceTermination()

A1

ID of the task object to terminate

Er

PxTaskForceTermination() error codes

PXSvTaskGetAccessRights PXVT_TASK

Fn

PxTaskGetAccessRights()

A1

ID of the task object which access rights are requested

A2

Access rights of given task or 0 on failure

Er

PxTaskGetAccessRights() error codes

TICKS

PXSvTickSetTicksPerSecond PXVT_TICKS

Fn

PxTickSetTicksPerSecond()

A1

Number of calls to PxTickDefine_Hnd() in one second

Er

PxTickSetTicksPerSecond() error codes

PXSvTickGetTimeInMilliSeconds PXVT_TICKS

Fn

PxTickGetTimeInMilliSeconds()

A1

Actual time since the first call to PxTickDefine_Hnd() in milliseconds or 0 if the ticks per second are not (yet) set

PXSvTickGetTicksFromMilliSeconds PXVT_TICKS

Fn

PxTickGetTicksFromMilliSeconds()

A1

Milliseconds to convert

A2

Number of PxTicks_t converted from milliseconds

TIMESLICE

PXSvSetTimeslices PXVT_TIMESLICE

Fn

PxSetTimeslices()

A1

Number of time slices in PxTicks_t to be set — reload value for calling task’s timeslice mechanism

PXSvGetTimeslices PXVT_TIMESLICE

Fn

PxGetTimeslices()

A1

Number of time slices in PxTicks_t — reload value for calling task’s timeslice mechanism

TO

PXSvToRequest PXVT_TO

Fn

PxToRequest()

A1

ID of the timeout object if the request was successful or invalid ID on failure

A2

Events to signal after the timeout is reached

Er

PxToRequest() error codes

PXSvToStart PXVT_TO

Fn

PxToStart()

A1

ID of the timeout object to start

A2

Amount of timeout in number of PxTicks_t if the request was successful or 0 on failure

Er

PxToStart() error codes

PXSvToStop PXVT_TO

Fn

PxToStop()

A1

ID of the timeout object to stop

A2

Amount of timeout in number of PxTicks_t if the request was successful or 0 on failure

Er

PxToStop() error codes

PXSvToRelease PXVT_TO

Fn

PxToRelease()

A1

Invalid ID if the release was successful or ID of the timeout object to release

Er

PxToRelease() error codes

PXSvToChange PXVT_TO

Fn

PxToChange()

A1

ID of the timeout object which timeout to change

A2

Amount of timeout in number of PxTicks_t to set

Er

PxToChange() error codes

PXSvToRequest_NoWait PXVT_TO

Fn

PxToRequest_NoWait()

A1

ID of the timeout object if the request was successful or invalid ID on failure

A2

Events to signal after the timeout is reached

Er

PxToRequest_NoWait() error codes

PXSvToRequest_EvWait PXVT_TO, PXVT_EVENT

Fn

PxToRequest_EvWait()

A1

ID of the timeout object if the request was successful or invalid ID on failure/event abortion

A2

Events, if the request was aborted by a waiting event

Er

PxToRequest_EvWait() error codes

PXSvToStart_Hnd PXVT_TO, PXVT_HND

Fn

PxToStart_Hnd()

A1

ID of the timeout object to start

A2

Amount of timeout in number of PxTicks_t

Er

PxToStart_Hnd() error codes

PXSvToStop_Hnd PXVT_TO, PXVT_HND

Fn

PxToStop_Hnd()

A1

ID of timeout object to stop

A2

Amount of timeout in number of PxTicks_t

USER

PXUSER PXVT_USER

Fn

User-defined

A1

User-defined

A2

User-defined

Er

User-defined