Return Codes of the API Functions

Enumerations

enum  tte_retval_t {
  ETT_NULLPTR = -9999, ETT_NOMEM = -9998, ETT_INVCTRL = -9997, ETT_IO = -9996,
  ETT_INVCHAN = -9995, ETT_INVMSGID = -9994, ETT_FAILED = -9992, ETT_CONFIG = -9991,
  ETT_INVSIZE = -9989, ETT_NOMSG = -9988, ETT_LINKLOST = -9987, ETT_SYNC = -9984,
  ETT_NOINIT = -9979, ETT_NOTSUPPORTED = -9978, ETT_DEADLINE = -9977, ETT_TIMEOUT = -9976,
  ETT_NOSPC = -9975, ETT_AGAIN = -9974, ETT_INITIALIZED = -9973, ETT_DMA_NOT_DONE = -9972,
  ETT_NO_DMA_MEM = -9971, ETT_DMA_BUF_BUSY = -9970, ETT_DMA_BUSY = -9969, ETT_SUCCESS = 0
}

Enumeration Type Documentation

All functions in the API have the same return value type - a 32-bit signed integer. If a function call completes correctly, the return value is always 0 (also defined as ETT_SUCCESS). The error codes reserved by the API are negative numbers in the range from -9999 to -9000.

Enumerator:
ETT_NULLPTR 

A pointer argument is NULL.

ETT_NOMEM 

Not enough memory to complete the operation.

ETT_INVCTRL 

The controller ID argument is invalid.

ETT_IO 

Internal device I/O error.

ETT_INVCHAN 

The Ethernet channel/port number is invalid.

ETT_INVMSGID 

The CT ID is invalid (out of range).

ETT_FAILED 

The operation failed due to an internal error.

ETT_CONFIG 

The provided configuration is invalid.

ETT_INVSIZE 

The message length is invalid.

ETT_NOMSG 

There is no message.

ETT_LINKLOST 

The controller has no physical link on a port.

ETT_SYNC 

The controller is not synchronized.

ETT_NOINIT 

The controller is not initialized.

ETT_NOTSUPPORTED 

Function not supported.

ETT_DEADLINE 

Deadline violation.

ETT_TIMEOUT 

A timeout expired while waiting for the operation to complete.

ETT_NOSPC 

There is not enough space to finish the operation.

ETT_AGAIN 

The controller or the driver are currently busy (try again later).

ETT_INITIALIZED 

The controller is already initialized.

ETT_DMA_NOT_DONE 

DMA transfer is not finished yet.

ETT_NO_DMA_MEM 

Not enough free DMA memory to complete the operation.

ETT_DMA_BUF_BUSY 

A DMA transfer is already scheduled or active for this buffer.

ETT_DMA_BUSY 

The DMA controller is active and the operation cannot be finished.

ETT_SUCCESS 

No error occured, operation finished correctly.

Definition at line 445 of file tte_api.h.

00445              {
00447     ETT_NULLPTR      = -9999,
00449     ETT_NOMEM        = -9998,
00451     ETT_INVCTRL      = -9997,
00453     ETT_IO           = -9996,
00455     ETT_INVCHAN      = -9995,
00457     ETT_INVMSGID     = -9994,
00459     ETT_FAILED       = -9992,
00461     ETT_CONFIG       = -9991,
00463     ETT_INVSIZE      = -9989,
00465     ETT_NOMSG        = -9988,
00467     ETT_LINKLOST     = -9987,
00469     ETT_SYNC         = -9984,
00471     ETT_NOINIT       = -9979,
00473     ETT_NOTSUPPORTED = -9978,
00475     ETT_DEADLINE     = -9977,
00477     ETT_TIMEOUT      = -9976,
00479     ETT_NOSPC        = -9975,
00481     ETT_AGAIN        = -9974,
00483     ETT_INITIALIZED  = -9973,
00485     ETT_DMA_NOT_DONE = -9972,
00487     ETT_NO_DMA_MEM   = -9971,
00489     ETT_DMA_BUF_BUSY = -9970,
00491     ETT_DMA_BUSY     = -9969,
00493     ETT_SUCCESS      = 0
00494 } tte_retval_t;

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