libparanut
A Hardware Abstraction Layer for ParaNut Architectures.

Error codes returned by the functions in this library. More...

Collaboration diagram for Error Codes:
#define PN_SUCCESS   0
 Successful execution. More...
 
#define PN_ERR_PARAM   (-1)
 Parameter error. More...
 
#define PN_ERR_NOIMP   (-2)
 Function not implemented. More...
 
#define PN_ERR_COPU   (-3)
 CoPU error. More...
 
#define PN_ERR_MATCH   (-4)
 Mode begin and end matching error. More...
 
#define PN_ERR_LOCKOCC   (-5)
 Lock occupied error. More...
 
#define PN_ERR_CACHE_LINESIZE   (-6)
 Weird cache line size error. More...
 
#define PN_ERR_EXC   (-8)
 Exception code not implemented error. More...
 
#define PN_SUCCESS   0
 Successful execution. More...
 
#define PN_ERR_PARAM   (-1)
 Parameter error. More...
 
#define PN_ERR_NOIMP   (-2)
 Function not implemented. More...
 
#define PN_ERR_COPU   (-3)
 CoPU error. More...
 
#define PN_ERR_MATCH   (-4)
 Mode begin and end matching error. More...
 
#define PN_ERR_LOCKOCC   (-5)
 Lock occupied error. More...
 
#define PN_ERR_CACHE_LINESIZE   (-6)
 Weird cache line size error. More...
 
#define PN_ERR_EXC   (-8)
 Exception code not implemented error. More...
 

Detailed Description

Error codes returned by the functions in this library.

Macro Definition Documentation

◆ PN_ERR_CACHE_LINESIZE [1/2]

#define PN_ERR_CACHE_LINESIZE   (-6)

Weird cache line size error.

Can occur if libparanut is supposed to run on an architecture that has a cache line size which is not either 32, 64, 128, 256, 512, 1024 or 2048 bit. Should be more of a development error instead of a normal usage error.

In other words, it should not occur if you are just developing middle end stuff while using the libparanut on a deployed ParaNut. Contact the maintainers about this if it still does.

◆ PN_ERR_CACHE_LINESIZE [2/2]

#define PN_ERR_CACHE_LINESIZE   (-6)

Weird cache line size error.

Can occur if libparanut is supposed to run on an architecture that has a cache line size which is not either 32, 64, 128, 256, 512, 1024 or 2048 bit. Should be more of a development error instead of a normal usage error.

In other words, it should not occur if you are just developing middle end stuff while using the libparanut on a deployed ParaNut. Contact the maintainers about this if it still does.

◆ PN_ERR_COPU [1/2]

#define PN_ERR_COPU   (-3)

CoPU error.

Function that isn't allowed on CoPU was being executed on CoPU.

◆ PN_ERR_COPU [2/2]

#define PN_ERR_COPU   (-3)

CoPU error.

Function that isn't allowed on CoPU was being executed on CoPU.

◆ PN_ERR_EXC [1/2]

#define PN_ERR_EXC   (-8)

Exception code not implemented error.

You tried callin pn_exception_set_handler() with an invalid exception code.

◆ PN_ERR_EXC [2/2]

#define PN_ERR_EXC   (-8)

Exception code not implemented error.

You tried callin pn_exception_set_handler() with an invalid exception code.

◆ PN_ERR_LOCKOCC [1/2]

#define PN_ERR_LOCKOCC   (-5)

Lock occupied error.

Can occur if you tried destroying an occupied lock or used the trylock function on an occupied lock.

◆ PN_ERR_LOCKOCC [2/2]

#define PN_ERR_LOCKOCC   (-5)

Lock occupied error.

Can occur if you tried destroying an occupied lock or used the trylock function on an occupied lock.

◆ PN_ERR_MATCH [1/2]

#define PN_ERR_MATCH   (-4)

Mode begin and end matching error.

Functions for beginning and ending linked and threaded mode have to be matched. Linked and threaded mode shall not be mixed.

◆ PN_ERR_MATCH [2/2]

#define PN_ERR_MATCH   (-4)

Mode begin and end matching error.

Functions for beginning and ending linked and threaded mode have to be matched. Linked and threaded mode shall not be mixed.

◆ PN_ERR_NOIMP [1/2]

#define PN_ERR_NOIMP   (-2)

Function not implemented.

The libparanut function is not yet implemented.

◆ PN_ERR_NOIMP [2/2]

#define PN_ERR_NOIMP   (-2)

Function not implemented.

The libparanut function is not yet implemented.

◆ PN_ERR_PARAM [1/2]

#define PN_ERR_PARAM   (-1)

Parameter error.

The parameters given to a function were wrong (i.e. out of range).

◆ PN_ERR_PARAM [2/2]

#define PN_ERR_PARAM   (-1)

Parameter error.

The parameters given to a function were wrong (i.e. out of range).

◆ PN_SUCCESS [1/2]

#define PN_SUCCESS   0

Successful execution.

Implies that a function finished successfully.

◆ PN_SUCCESS [2/2]

#define PN_SUCCESS   0

Successful execution.

Implies that a function finished successfully.