EMACSnow.h File Reference

Detailed Description

EMACSnow Driver.

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

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

#include <ti/drivers/emac/EMACSnow.h>

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

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

• Diags_USER1 mask logs basic information
• Diags_USER2 mask logs more detailed information

  ---

#include <stdint.h>
#include <ti/sysbios/knl/Swi.h>
#include <ti/sysbios/family/arm/m3/Hwi.h>
#include <ti/drivers/EMAC.h>
#include <ti/ndk/inc/stkmain.h>

Include dependency graph for EMACSnow.h:

Go to the source code of this file.

Data Structures
struct	EMACSnow_HWAttrs
	EMACSnow Hardware attributes. More...
struct	EMACSnow_Object
	EMACSnow Object. More...

Macros
#define	ti_sysbios_family_arm_m3_Hwi__nolocalnames
#define	_INCLUDE_NIMU_CODE

Typedefs
typedef struct EMACSnow_HWAttrs	EMACSnow_HWAttrs
	EMACSnow Hardware attributes. More...
typedef struct EMACSnow_Object	EMACSnow_Object
	EMACSnow Object. More...

Functions
void	EMACSnow_init (uint32_t index)
	This function initializes the EMACSnow driver. More...
bool	EMACSnow_isLinkUp (uint32_t index)
	This function sets the EMACSnow driver. More...
int	EMACSnow_NIMUInit (STKEVENT_Handle hEvent)
	This function is needed in the NIMUDeviceTable that is required by the NDK. More...

Variables
const EMAC_FxnTable	EMACSnow_fxnTable
	EMACSnow function table. More...

Macro Definition Documentation

#define ti_sysbios_family_arm_m3_Hwi__nolocalnames

#define _INCLUDE_NIMU_CODE

Typedef Documentation

typedef struct EMACSnow_HWAttrs EMACSnow_HWAttrs

EMACSnow 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 EMACSnow_Object EMACSnow_Object

EMACSnow Object.

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

Function Documentation

void EMACSnow_init

(

uint32_t

index

)

This function initializes the EMACSnow driver.

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

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

bool EMACSnow_isLinkUp

(

uint32_t

index

)

This function sets the EMACSnow driver.

This function returns if the link is up

Returns

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

int EMACSnow_NIMUInit

(

STKEVENT_Handle

hEvent

)

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

Variable Documentation

const EMAC_FxnTable EMACSnow_fxnTable

EMACSnow function table.