EMACTiva.h File Reference

Detailed Description

EMACTiva Driver.

============================================================================

The EMACTiva header file should be included in an application as follows:

#include <ti/drivers/EMAC.h>
#include <ti/drivers/emac/EMACTiva.h>

Refer to EMAC.h for a complete description of APIs.

The EMACTiva driver produces log statements using the instrumented library. The following masks are used:

• Diags_USER1 mask logs basic information (started, stopped, dropped packet, etc.)
• Diags_USER2 mask logs more detailed information (received/sent packet, etc.)

  ---

#include <stdint.h>
#include <ti/sysbios/knl/Swi.h>
#include <ti/ndk/inc/stkmain.h>

Include dependency graph for EMACTiva.h:

Go to the source code of this file.

Data Structures
struct	EMACTiva_HWAttrs
	EMACTiva Hardware attributes. More...
struct	EMACTiva_Object
	EMACTiva Object. More...

Macros
#define	_INCLUDE_NIMU_CODE

Typedefs
typedef struct EMACTiva_HWAttrs	EMACTiva_HWAttrs
	EMACTiva Hardware attributes. More...
typedef struct EMACTiva_Object	EMACTiva_Object
	EMACTiva Object. More...

Functions
void	EMACTiva_init (uint32_t index)
	This function sets the EMACTiva driver. More...
bool	EMACTiva_isLinkUp (uint32_t index)
	This function returns if the link is up. More...
int	EMACTiva_NIMUInit (STKEVENT_Handle hEvent)
	This function is needed in the NIMUDeviceTable that is required by the NDK. More...

Variables
const EMAC_FxnTable	EMACTiva_fxnTable
	EMACTiva function table. More...

Macro Definition Documentation

#define _INCLUDE_NIMU_CODE

Typedef Documentation

typedef struct EMACTiva_HWAttrs EMACTiva_HWAttrs

EMACTiva Hardware attributes.

intPriority is the EMAC peripheral's interrupt priority, as defined by the underlying OS. It is passed unmodified to the underlying OS's interrupt handler creation code, so you need to refer to the OS documentation for usage. For example, for SYS/BIOS applications, refer to the ti.sysbios.family.arm.m3.Hwi documentation for SYS/BIOS usage of interrupt priorities. If the driver uses the ti.drivers.ports interface instead of making OS calls directly, then the HwiP port handles the interrupt priority in an OS specific way. In the case of the SYS/BIOS port, intPriority is passed unmodified to Hwi_create().

typedef struct EMACTiva_Object EMACTiva_Object

EMACTiva Object.

This structure should not be directly accessed. It is specified here to allow the application to supply the needed memory to the EMACTiva module.

Function Documentation

void EMACTiva_init

(

uint32_t

index

)

This function sets the EMACTiva driver.

This function must be called before the NDK stack thread is started.

The EMAC_config structure must be present and initialized before this function is called.

bool EMACTiva_isLinkUp

(

uint32_t

index

)

This function returns if the link is up.

Returns

true is the link is up. false if it is down.

int EMACTiva_NIMUInit

(

STKEVENT_Handle

hEvent

)

This function is needed in the NIMUDeviceTable that is required by the NDK.

Variable Documentation

const EMAC_FxnTable EMACTiva_fxnTable

EMACTiva function table.