Generals

The netX driver packages general definitions and functionalities. More...

Collaboration diagram for Generals:

Modules
	MUTEX
	Precompiler Loop
	Precompiler defines to generate a loop.
	TRACE

Macros
#define	UNUSED(x)   ((void)(x))
	If there is the need to outsmart the compiler or linter. More...

Typedefs
typedef void(*	DRV_CALLBACK_F) (void *pvDriverHandle, void *pvUserHandle)
	The definition of callbacks used in the driver. More...
typedef enum DRV_STATUS_Etag *	DRV_STATUS_EP

Enumerations
enum	DRV_STATUS_E {   DRV_OK = 0U,   DRV_ERROR = -1,   DRV_BUSY = -2,   DRV_TOUT = -3,   DRV_NSUPP = -4,   DRV_NIMPL = -5,   DRV_ERROR_PARAM = -6,   DRV_LOCKED = -7,   DRV_ERROR_BUFFER = -8 }
	DRV Status structures definition. More...
enum	DRV_OPERATION_MODE_E {   DRV_OPERATION_MODE_POLL = 0x0u,   DRV_OPERATION_MODE_IRQ = 0x1u,   DRV_OPERATION_MODE_DMA = 0x2u,   DRV_OPERATION_MODE_MIN = DRV_OPERATION_MODE_POLL,   DRV_OPERATION_MODE_MAX = DRV_OPERATION_MODE_DMA }
	Enumeration of the operation mode. More...

Detailed Description

The netX driver packages general definitions and functionalities.

Those are general definitions and functionalities around the driver.

Macro Definition Documentation

#define UNUSED

(

x

)

((void)(x))

If there is the need to outsmart the compiler or linter.

Definition at line 40 of file netx_drv_def.h.

Typedef Documentation

typedef void(* DRV_CALLBACK_F) (void *pvDriverHandle, void *pvUserHandle)

The definition of callbacks used in the driver.

In the dio, the ptDriverHandle is a DRV_DIO_ID_T so one should cast as following: (DRV_DIO_ID_T) ptDriverHandle; to get an integer of the given pointer

Definition at line 48 of file netx_drv_def.h.

typedef enum DRV_STATUS_Etag * DRV_STATUS_EP

Enumeration Type Documentation

enum DRV_OPERATION_MODE_E

Enumeration of the operation mode.

Enumerator
DRV_OPERATION_MODE_POLL	Default. The state signaling an event is read greedy.
DRV_OPERATION_MODE_IRQ	This mode uses interrupts to signal events.
DRV_OPERATION_MODE_DMA	This mode uses DMA to copy data and interrupts to signal events.
DRV_OPERATION_MODE_MIN	The minimum enumeration value for boundary check.
DRV_OPERATION_MODE_MAX	The maximum enumeration value for boundary check.

Definition at line 69 of file netx_drv_def.h.

enum DRV_STATUS_E

DRV Status structures definition.

Enumerator
DRV_OK	Everything is ok and works as intended.
DRV_ERROR	A general error occurred.
DRV_BUSY	The driver or device is busy.
DRV_TOUT	The driver or device timed out.
DRV_NSUPP	The requested function is not supported for the given parameters.
DRV_NIMPL	The requested function is not implemented for the given parameters.
DRV_ERROR_PARAM	The given parameters are incorrect.
DRV_LOCKED	The drivers api is locked by an other execution context.
DRV_ERROR_BUFFER	The buffer is corrupted.

Definition at line 53 of file netx_drv_def.h.