Hilscher netX microcontroller driver  V0.0.5.0
Documentation of the netX driver package
netx_drv_eth_xpic.h File Reference

Ethernet xpic mac peripheral module driver. More...

#include "netx_drv.h"
#include "netx_drv_eth_xpic_def.h"
#include <stdbool.h>
Include dependency graph for netx_drv_eth_xpic.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  DRV_ETH_XPIC_CONFIG_T
 

Macros

#define HAL_ETHXPIC_VERSION_MAJOR   2
 
#define HAL_ETHXPIC_VERSION_MINOR   0
 
#define HAL_ETHXPIC_VERSION_BUILD   0
 
#define HAL_ETHXPIC_VERSION_REVISION   0
 

Enumerations

enum  DRV_ETH_XPIC_RESULT {
  DRV_ETH_XPIC_OK = 0,
  DRV_ETH_XPIC_NOT_INITIALIZED,
  DRV_ETH_XPIC_NOT_RUNNING,
  DRV_ETH_XPIC_INVALID_ARG,
  DRV_ETH_XPIC_NO_FRAME_AVAILABLE,
  DRV_ETH_XPIC_INVALID_HANDLE
}
 
enum  DRV_ETH_XPIC_PARAM {
  DRV_ETH_XPIC_PARAM_IRQ_MASK = 0,
  DRV_ETH_XPIC_PARAM_VLAN_PRIORITIZATION,
  DRV_ETH_XPIC_PARAM_DSCP_PRIORITIZATION,
  DRV_ETH_XPIC_PROMISC_MODE,
  DRV_ETH_XPIC_CONNECTION_STATE
}
 

Functions

DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_Reset (void *pvUser)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_Initialize (DRV_ETH_XPIC_CONFIG_T const *ptConfig, void *pvUser)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_SetMacAddr (uint8_t const *pabMacAdr)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_GetMacAddr (uint8_t *pabMacAdr)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_Start (void *pvUser)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_GetConfirmIrq (uint32_t *pulIrq)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_GetFrame (ETH_FRAMEBUF_T **pptFrame)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_Send (ETH_FRAMEBUF_T *ptFrame, bool fConfirm, bool fHiPriority)
 
unsigned int DRV_ETH_Xpic_GetSendCnfFillLevel (void)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_GetSendCnf (ETH_FRAMEBUF_T **pptFrame, ETH_XPIC_CNF_ERR *pErrorCode)
 
unsigned int DRV_ETH_Xpic_GetRecvFillLevel (bool fHiPriority)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_Recv (ETH_FRAMEBUF_T **pptFrame, bool fHiPriority)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_ReleaseFrame (ETH_FRAMEBUF_T *ptFrame)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_SetParam (DRV_ETH_XPIC_PARAM eParam, uint32_t ulValue)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_GetParam (DRV_ETH_XPIC_PARAM eParam, uint32_t *pulValue)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_GetCounters (XPIC_SHM_CNT_T *ptMacCounter)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_ReadPhyReg (unsigned int uMiimuPreamble, unsigned int uMiimuMdcFreq, unsigned int uMiimuRtaField, unsigned int uMiimuPhyAddr, unsigned int uMiimuReqAddr, uint16_t *pusData, void *pvUser)
 
DRV_ETH_XPIC_RESULT DRV_ETH_Xpic_WritePhyReg (unsigned int uMiimuPreamble, unsigned int uMiimuMdcFreq, unsigned int uMiimuPhyAddr, unsigned int uMiimuReqAddr, uint16_t usData, void *pvUser)
 

Detailed Description

Ethernet xpic mac peripheral module driver.

Revision
4646
Date
2018-12-19 08:47:36 +0100 (Mi, 19 Dez 2018)
Note
Exclusion of Liability for this demo software: The following software is intended for and must only be used for reference and in an evaluation laboratory environment. It is provided without charge and is subject to alterations. There is no warranty for the software, to the extent permitted by applicable law. Except when otherwise stated in writing the copyright holders and/or other parties provide the software "as is" without warranty of any kind, either expressed or implied. Please refer to the Agreement in README_DISCLAIMER.txt, provided together with this file! By installing or otherwise using the software, you accept the terms of this Agreement. If you do not agree to the terms of this Agreement, then do not install or use the Software!

Definition in file netx_drv_eth_xpic.h.