lpc17_emac.h

NXPl788上lwip的无操作系统移植,基于Embest开发板

/**********************************************************************
* $Id$		lpc17_emac.h			2011-11-20
*//**
* @file		lpc17_emac.h
* @brief	LPC17 ethernet driver header file for LWIP
* @version	1.0
* @date		20. Nov. 2011
* @author	NXP MCU SW Application Team
* 
* Copyright(C) 2011, NXP Semiconductor
* All rights reserved.
*
***********************************************************************
* Software that is described herein is for illustrative purposes only
* which provides customers with programming information regarding the
* products. This software is supplied "AS IS" without any warranties.
* NXP Semiconductors assumes no responsibility or liability for the
* use of the software, conveys no license or title under any patent,
* copyright, or mask work right to the product. NXP Semiconductors
* reserves the right to make changes in the software without
* notification. NXP Semiconductors also make no representation or
* warranty that such application will be suitable for the specified
* use without further testing or modification.
**********************************************************************/

#ifndef __LPC_EMAC_H
#define __LPC_EMAC_H

#include "lwip/netif.h"
#include "lwip/pbuf.h"
#include "lpc_emac_config.h"
#include "lpc_phy.h"
#include "lpc177x_8x_emac.h"

#ifdef __cplusplus
extern "C"
{
#endif

/** @ingroup lwip_emac_DRIVER
 */

/** \brief  Structure of a TX/RX descriptor
 */
typedef struct
{
	volatile u32_t packet;        /**< Pointer to buffer */
	volatile u32_t control;       /**< Control word */
} LPC_TXRX_DESC_T;

/** \brief  Structure of a RX status entry
 */
typedef struct
{
	volatile u32_t statusinfo;   /**< RX status word */
	volatile u32_t statushashcrc; /**< RX hash CRC */
} LPC_TXRX_STATUS_T;

/** \brief  LPC EMAC driver data structure
 */
struct lpc_enetdata_def {
  //to make address align to 8 bytes
	struct netif *netif;        /**< Reference back to LWIP parent netif */
	LPC_TXRX_STATUS_T prxs[LPC_NUM_BUFF_RXDESCS]; /**< Pointer to RX statuses */
	LPC_TXRX_DESC_T ptxd[LPC_NUM_BUFF_TXDESCS];   /**< Pointer to TX descriptor list */
	LPC_TXRX_STATUS_T ptxs[LPC_NUM_BUFF_TXDESCS]; /**< Pointer to TX statuses */
	LPC_TXRX_DESC_T prxd[LPC_NUM_BUFF_RXDESCS];   /**< Pointer to RX descriptor list */
#if LPC_PBUF_RX_ZEROCOPY
	struct pbuf *rxb[LPC_NUM_BUFF_RXDESCS]; /**< RX pbuf pointer list, zero-copy mode */
	u32_t rx_fill_desc_index; /**< RX descriptor next available index */
	u32_t rx_free_descs; /**< Count of free RX descriptors */
#else
	u32_t lpc_rx_buffs[LPC_NUM_BUFF_RXDESCS][1 + (EMAC_ETH_MAX_FLEN / 4)]; /**< Array of contiguous RX buffers used with copied pbufs */
#endif
#if LPC_PBUF_TX_ZEROCOPY
	struct pbuf *txb[LPC_NUM_BUFF_TXDESCS]; /**< TX pbuf pointer list, zero-copy mode */
	u32_t lpc_last_tx_idx; /**< TX last descriptor index, zero-copy mode */
#else
	u32_t lpc_tx_buffs[LPC_NUM_BUFF_TXDESCS][1 + (EMAC_ETH_MAX_FLEN / 4)]; /**< Array of contiguous TX buffers used with copied pbufs */
#endif
};

/** \brief  netif structure used with this driver, must be allocated in
 *          DMA safe memory
 */
extern struct lpc_enetdata_def lpc_enetdata;

void lpc_enetif_input(struct netif *netif);
s32_t lpc_tx_ready(struct netif *netif);
err_t lpc_enetif_init(struct netif *netif);
#if LPC_PBUF_RX_ZEROCOPY
s32_t lpc_rx_queue(struct netif *netif);
#endif
#if LPC_PBUF_TX_ZEROCOPY
void lpc_tx_reclaim(struct netif *netif);
#endif

/**		  
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif