Control Flow
[TTEthernet API Common Functions]

Functions

int32_t tte_init (void)
int32_t tte_start (const uint8_t ctrl_id)
int32_t tte_stop (const uint8_t ctrl_id)
int32_t tte_exit (void)
int32_t tte_configure (const uint8_t ctrl_id, const tte_conf_t *const conf)
int32_t tte_set_var (const uint8_t ctrl_id, const tte_var_id_t var_id, const uint32_t var_size, const void *const value)

Detailed Description

In this section, function calls for configuring and managing of the TTEthernet communication system are explained.


Function Documentation

int32_t tte_configure ( const uint8_t  ctrl_id,
const tte_conf_t *const   conf 
)

Stops the controller and loads a new configuration.

The controller will be restarted during the configuration loading. It will not resume operation until tte_start() is executed.

Parameters:
[in] ctrl_id Controller number (0-based).
[in] conf Implementation specific configuration block. If the argument is NULL and bootstrap configuration is supported, the function will try to force the boostrap operation mode.
Returns:
See tte_retval_t.

Definition at line 506 of file TTEAPIApplicationBase.cc.

00506                                                    {
00507     return ETT_NOTSUPPORTED;
00508 }
00509 

int32_t tte_exit ( void   ) 

Releases all resources allocated by the TTEthernet API implementation.

After you have called this function, you may not call any other API function but tte_init().

Returns:
See tte_retval_t.

Definition at line 502 of file TTEAPIApplicationBase.cc.

00506                                                    {

int32_t tte_init ( void   ) 

Initializes the TTEthernet API implementation.

This function must be called by the application before any other API function may be used. The API remains initialized and available until a call to tte_exit() is made.

Returns:
See tte_retval_t.

Definition at line 488 of file TTEAPIApplicationBase.cc.

00489                 {
00490                 void * arg=cb->getFunctionArg();

int32_t tte_set_var ( const uint8_t  ctrl_id,
const tte_var_id_t  var_id,
const uint32_t  var_size,
const void *const   value 
)

Sets the value of a TTEthernet API variable.

Writable TTEthernet API variables allow the application to configure the API at runtime. Every writable variable is also readable, but the reverse is not necessarily true.

Each variable is identified by a single unique number; the list of the supported numbers and the explanations are described in the text on tte_var_id_t. Access to a variable that is not supported will return the value ETT_NOTSUPPORTED.

Parameters:
[in] ctrl_id Controller number (0-based).
[in] var_id TTE variable identification number.
[in] var_size Size of the new value in bytes.
[in] value Address of the new value of the variable.
Returns:
See tte_retval_t.

Definition at line 511 of file TTEAPIApplicationBase.cc.

00515                                  {
00516     return ETT_NOTSUPPORTED;

int32_t tte_start ( const uint8_t  ctrl_id  ) 

Starts the TTEthernet controller.

Enables the the execution of the time-triggered schedule and the transmission and reception of messages.

Note:
Some TTEthernet system may start up in an operation state, depending on the configuration.
Parameters:
[in] ctrl_id Controller number (0-based).
Returns:
See tte_retval_t.

Definition at line 493 of file TTEAPIApplicationBase.cc.

00496                :
            return ETT_NOTSUPPORTED;

int32_t tte_stop ( const uint8_t  ctrl_id  ) 

Stops the TTEthernet controller.

Disables the the execution of the time-triggered schedule and the transmission and reception of messages.

Parameters:
[in] ctrl_id Controller number (0-based).
Returns:
See tte_retval_t.

Definition at line 497 of file TTEAPIApplicationBase.cc.

00501                                  {

Generated on Tue Nov 29 14:09:19 2011 for TTEthernet Model for INET Framework by  doxygen 1.6.3