ksz8851snl.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef KSZ8851SNL_H__
#define KSZ8851SNL_H__

/**************************************************************************/
/**************************************************************************/
#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif


/* Interrupt Enable Register Options */
#define   KSZ8851SNL_INT_LINK_CHANGE     0x8000

#define   KSZ8851SNL_INT_TX_DONE         0x4000

#define   KSZ8851SNL_INT_RX_DONE         0x2000

#define   KSZ8851SNL_INT_RX_OVERRUN      0x0800

#define   KSZ8851SNL_INT_TX_STOPPED      0x0200

#define   KSZ8851SNL_INT_RX_STOPPED      0x0100

#define   KSZ8851SNL_INT_TX_SPACE        0x0040

#define   KSZ8851SNL_INT_RX_WOL_FRAME    0x0020

#define   KSZ8851SNL_INT_MAGIC           0x0010

#define   KSZ8851SNL_INT_LINKUP          0x0008

#define   KSZ8851SNL_INT_ENERGY          0x0004

#define   KSZ8851SNL_INT_SPI_ERROR       0x0002

#define   KSZ8851SNL_INT_ENABLE_MASK     (KSZ8851SNL_INT_RX_DONE | \
                                          KSZ8851SNL_INT_RX_STOPPED | \
                                          KSZ8851SNL_INT_TX_STOPPED | \
                                          KSZ8851SNL_INT_LINK_CHANGE | \
                                          KSZ8851SNL_INT_SPI_ERROR)

typedef struct KSZ8851SLN_mib_s
{
  uint32_t RxByteCnt;
  uint32_t RxUndersizePktCnt;
  uint32_t RxFragmentsCnt;
  uint32_t RxOversizeCnt;
  uint32_t RxJabbersCnt;
  uint32_t RxSymbolErrorCnt;
  uint32_t RxCRCErrorCnt;
  uint32_t RxPausePktsCnt;
  uint32_t RxBroadcastCnt;
  uint32_t RxMulticastCnt;
  uint32_t RxUnicastCnt;
  uint32_t TxByteCnt;
  uint32_t TxPausePktsCnt;
  uint32_t TxBroadcastPktsCnt;
  uint32_t TxMulticastPktsCnt;
  uint32_t TxUnicastPktsCnt;
  uint32_t TxDeferredCnt;
  uint32_t TxTotalCollisionCnt;
} KSZ8851SLN_mib_t;


void     KSZ8851SNL_Init(void);
void     KSZ8851SNL_Enable(void);
uint16_t KSZ8851SNL_Receive(uint16_t length, uint8_t *buffer);
bool     KSZ8851SNL_TransmitBegin(uint16_t length);
void     KSZ8851SNL_Transmit(uint16_t length, const uint8_t *buffer);
void     KSZ8851SNL_TransmitEnd(uint16_t length);

void     KSZ8851SNL_MacAddressGet(uint8_t *macAddress);
void     KSZ8851SNL_PMECRStatusClear(uint16_t flags);
void     KSZ8851SNL_FrameCounterSet(void);
uint16_t KSZ8851SNL_FrameCounterGet(void);
void     KSZ8851SNL_IntEnable(void);
void     KSZ8851SNL_IntDisable(void);
void     KSZ8851SNL_IntClear(uint16_t flags);
uint16_t KSZ8851SNL_IntGet(void);
uint16_t KSZ8851SNL_RXQCRGet(void);
uint16_t KSZ8851SNL_PHYStatusGet(void);
void     KSZ8851SNL_TxQueueReset(void);
void     KSZ8851SNL_RxQueueReset(void);

void     KSZ8851SNL_RegistersDump(void);
void     KSZ8851SNL_AllRegistersDump(void);
void     KSZ8851SNL_MIBCountersDump(void);
void     KSZ8851SNL_MIBCountersUpdate(void);
uint16_t KSZ8851SNL_FrameCounterGet(void);

#ifdef __cplusplus
}
#endif

#endif