enum TransportShm_Reason |
|
Reason for error function being called
typedef enum TransportShm_Reason {
TransportShm_Reason_FAILEDPUT,
TransportShm_Reason_INTERNALERR,
TransportShm_Reason_PHYSICALERR,
TransportShm_Reason_FAILEDALLOC
} TransportShm_Reason;
DETAILS
First field in the
errFxn
enum TransportShm_Status |
|
Transport return values
typedef enum TransportShm_Status {
TransportShm_S_SUCCESS,
TransportShm_E_FAIL,
TransportShm_E_ERROR
} TransportShm_Status;
DETAILS
- S_SUCCESS: Operation was successful
- E_FAIL: Operation resulted in a failure
- E_ERROR: Operation resulted in an error.
typedef TransportShm_ErrFxn |
|
Typedef for transport error callback function
DETAILS
First parameter: Why the error function is being called.
Second parameter: Handle of transport that had the error. NULL denotes
that it is a system error, not a specific transport.
Third parameter: Pointer to the message. This is only valid for
Reason_FAILEDPUT.
Fourth parameter: Transport specific information. Refer to individual
transports for more details.
config TransportShm_errFxn // module-wide |
|
Asynchronous error function for the transport module
config TransportShm_notifyEventId // module-wide |
|
Notify event ID for transport
extern const UInt16 TransportShm_notifyEventId;
TransportShm_close() // module-wide |
|
Close an opened instance
ARGUMENTS
handle
handle that is returned from an openByAddr
DETAILS
Closing an instance will free local memory consumed by the opened
instance. Instances that are opened should be closed before the
instance is deleted.
TransportShm_setErrFxn() // module-wide |
|
Sets the asynchronous error function for the transport module
ARGUMENTS
errFxn
Function that is called when an asynchronous
error occurs.
DETAILS
This API allows the user to set the function that will be called in
case of an asynchronous error by the transport.
Module-Wide Built-Ins |
|
// Get this module's unique id
Bool TransportShm_Module_startupDone();
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool TransportShm_Module_hasMask();
// Test whether this module has a diagnostics mask
Bits16 TransportShm_Module_getMask();
// Returns the diagnostics mask for this module
Void TransportShm_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types |
|
typedef struct TransportShm_Object TransportShm_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct TransportShm_Struct TransportShm_Struct;
// Opaque client structure large enough to hold an instance object
// Convert this instance structure pointer into an instance handle
// Convert this instance handle into an instance structure pointer
Instance Config Parameters |
|
typedef struct TransportShm_Params {
// Instance config-params structure
// Common per-instance configs
// GateMP used for critical region management of the shared memory
UInt priority;
// Which priority messages should this transport manage
Ptr sharedAddr;
// Physical address of the shared memory
} TransportShm_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
config TransportShm_gate // instance |
|
GateMP used for critical region management of the shared memory
config TransportShm_priority // instance |
|
Which priority messages should this transport manage
config TransportShm_sharedAddr // instance |
|
Physical address of the shared memory
DETAILS
The creator must supply the shared memory that is used to maintain
shared state information.
Instance Creation |
|
// Allocate and initialize a new instance object and return its handle
// Initialize a new instance object inside the provided structure
ARGUMENTS
procId
Remote processor id that this instance
will communicate with.
params
per-instance config params, or NULL to select default values (target-domain only)
eb
active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
This function creates a transport instance. The transport is
responsible for registering with MessageQ via the
ti.sdo.ipc.MessageQ.registerTransport API.
Instance Deletion |
|
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
// Finalize the instance object inside the provided structure
TransportShm_control() // instance |
|
Send a control command to the transport instance
ARGUMENTS
handle
handle of a previously-created TransportShm instance object
cmd
Requested command
cmdArgs
Accompanying field for the command. This is
command specific.
RETURNS
TRUE denotes acceptance of the command. FALSE
denotes failure of the command.
DETAILS
This is function allows transport to specify control commands. Refer
to individual transport implementions for more details.
TransportShm_getStatus() // instance |
|
Status of a Transport instance
ARGUMENTS
handle
handle of a previously-created TransportShm instance object
RETURNS
Returns status of Transport instance
DETAILS
This function returns the status of the transport instance.
TransportShm_put() // instance |
|
Put the message to the remote processor
ARGUMENTS
handle
handle of a previously-created TransportShm instance object
msg
Pointer the message to be sent
RETURNS
TRUE denotes acceptance of the message to
be sent. FALSE denotes the message could not be
sent.
DETAILS
If the transport can accept the message, it returns TRUE. Accepting
a message does not mean that it is transmitted. It simply means that
the transport should be able to send the message. If the actual transfer
fails, the transport calls the {@#ErrFxn} (assuming it is set up via the
{@#setErrFxn} API. If the {@#ErrFxn} is not set, the message is dropped.
(also...should an error be raised or just System_printf?).
If the transport cannot send the message, it returns FALSE and a
filled in Error_Block. The caller still owns the message.
Instance Convertors |
|
// unconditionally move one level up the inheritance hierarchy
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins |
|
Int TransportShm_Object_count();
// The number of statically-created instance objects
// The handle of the i-th statically-created instance object (array == NULL)
// The handle of the first dynamically-created instance object, or NULL
// The handle of the next dynamically-created instance object, or NULL
// The heap used to allocate dynamically-created instance objects
// The label associated with this instance object
// The name of this instance object
enum TransportShm.Reason |
|
Reason for error function being called
values of type TransportShm.Reason
const TransportShm.Reason_FAILEDPUT;
const TransportShm.Reason_INTERNALERR;
const TransportShm.Reason_PHYSICALERR;
const TransportShm.Reason_FAILEDALLOC;
DETAILS
First field in the
errFxn
C SYNOPSIS
enum TransportShm.Status |
|
Transport return values
values of type TransportShm.Status
const TransportShm.S_SUCCESS;
const TransportShm.E_FAIL;
const TransportShm.E_ERROR;
DETAILS
- S_SUCCESS: Operation was successful
- E_FAIL: Operation resulted in a failure
- E_ERROR: Operation resulted in an error.
C SYNOPSIS
config TransportShm.errFxn // module-wide |
|
Asynchronous error function for the transport module
C SYNOPSIS
config TransportShm.notifyEventId // module-wide |
|
Notify event ID for transport
TransportShm.notifyEventId = UInt16 2;
C SYNOPSIS
metaonly config TransportShm.common$ // module-wide |
|
Common module configuration parameters
DETAILS
All modules have this configuration parameter. Its name
contains the '$' character to ensure it does not conflict with
configuration parameters declared by the module. This allows
new configuration parameters to be added in the future without
any chance of breaking existing modules.
Instance Config Parameters |
|
var params = new TransportShm.Params;
// Instance config-params object
// GateMP used for critical region management of the shared memory
params.priority = UInt 0;
// Which priority messages should this transport manage
params.sharedAddr = Ptr null;
// Physical address of the shared memory
config TransportShm.gate // instance |
|
GateMP used for critical region management of the shared memory
var params = new TransportShm.Params;
...
C SYNOPSIS
config TransportShm.priority // instance |
|
Which priority messages should this transport manage
var params = new TransportShm.Params;
...
params.priority = UInt 0;
C SYNOPSIS
config TransportShm.sharedAddr // instance |
|
Physical address of the shared memory
var params = new TransportShm.Params;
...
params.sharedAddr = Ptr null;
DETAILS
The creator must supply the shared memory that is used to maintain
shared state information.
C SYNOPSIS
Instance Creation |
|
var params =
new TransportShm.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
var inst = TransportShm.create(UInt16 procId, params);
// Create an instance-object
ARGUMENTS
procId
Remote processor id that this instance
will communicate with.
params
per-instance config params, or NULL to select default values (target-domain only)
eb
active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
This function creates a transport instance. The transport is
responsible for registering with MessageQ via the
ti.sdo.ipc.MessageQ.registerTransport API.