bmp_eth.c File Reference

Ethernet hardware interface code for BMP LPC1768. More...

#include <string.h>
#include "lpc17xx.h"
#include "lpc17xx_emac.h"
#include "bmp.h"

Data Structures
struct	rx_desc_t
	Ethernet receive descriptor. More...
struct	rx_stat_t
	Ethernet receive status. More...
struct	tx_desc_t
	Ethernet transmit descriptor. More...
struct	tx_stat_t
	Ethernet transmit status. More...

Macros
#define	ETH_RX_BUFS   4
	Number of receive buffers.
#define	ETH_TX_BUFS   3
	Number of transmit buffers.

Functions
uint32_t	eth_rx_rdy (void)
	Is the ethernet hardware ready to receive?
uint32_t	eth_tx_rdy (void)
	Is the ethernet hardware ready to transmit?
void	eth_update_tx (void)
	Select the next transmission buffer.
void	eth_rx_discard (void)
	Discard received packet, releasing buffer for reuse.
void	eth_copy_txbuf (uint32_t *buffer, uint32_t length)
	Copy supplied buffer into transmit hardware.
void	eth_copy_rxbuf (uint32_t *buffer, uint32_t length)
	Copy received message into supplied buffer.
uint32_t	eth_rx_size (void)
	Get size of received data.
static void	rx_desc_init (void)
	Initialise receive descriptors.
static void	tx_desc_init (void)
	Initialise transmit descriptors.
void	configure_eth (const uint8_t *mac_addr)
	Configure the ethernet hardware.

Variables
static rx_desc_t	rx_desc [ETH_RX_BUFS]
	Ethernet receive descriptors.
static rx_stat_t	rx_stat [ETH_RX_BUFS]
	Ethernet receive status.
static uint32_t	rx_buf [ETH_RX_BUFS][EMAC_ETH_MAX_FLEN > > 2]
	Ethernet receive buffers.
static tx_desc_t	tx_desc [ETH_TX_BUFS]
	Ethernet transmit descriptors.
static tx_stat_t	tx_stat [ETH_TX_BUFS]
	Ethernet transmit status.
static uint32_t	tx_buf [ETH_TX_BUFS][EMAC_ETH_MAX_FLEN > > 2]
	Ethernet transmit buffers.

Detailed Description

Ethernet hardware interface code for BMP LPC1768.

Copyright

© The University of Manchester - 2012-2015

Author

Steve Temple, APT Group, School of Computer Science

---

Data Structure Documentation

rx_desc_t

struct rx_desc_t

Ethernet receive descriptor.

Data Fields
event_t *	event	Event and ID must be first in struct.
uint32_t	event_id
uint8_t	state	State variable.
uint8_t	tid	Tx ID of sender.
uint8_t	srce	Source address of sender.
uint8_t	last	Sequence number of last packet in message.
uint8_t	seq	Expected sequence number.
uint8_t	retry	Counts retries for can_close_req.
uint32_t *	buf	Pointer to buffer in SDP message.
sdp_msg_t *	msg	Pointer to SDP message.
uint32_t	Packet	Receive Packet Descriptor.
uint32_t	Ctrl	Receive Control Descriptor.

rx_stat_t

struct rx_stat_t

Ethernet receive status.

Data Fields
uint32_t	Info	Receive Information Status.
uint32_t	HashCRC	Receive Hash CRC Status.

tx_desc_t

struct tx_desc_t

Ethernet transmit descriptor.

Data Fields
event_t *	event	Event and ID must be first in struct.
uint32_t	event_id
uint8_t	state	State variable.
uint8_t	rid	Rx ID at receiver.
uint8_t	tid	Tx ID.
volatile uint8_t	seq	Sequence number for sent DATA packets.
uint8_t	dest	Address of receiver.
uint8_t	rc	Return code.
uint8_t	delay	Packet delay (not used yet)
volatile uint8_t	ack	Ack variable set by interrupt routines.
uint32_t	Packet	Transmit Packet Descriptor.
uint32_t	Ctrl	Transmit Control Descriptor.

tx_stat_t

struct tx_stat_t

Ethernet transmit status.

Data Fields
uint32_t	Info	Transmit Information Status.

Function Documentation

eth_rx_rdy()

uint32_t eth_rx_rdy

(

void

)

Is the ethernet hardware ready to receive?

Returns

true if a packet has been received

eth_tx_rdy()

uint32_t eth_tx_rdy

(

void

)

Is the ethernet hardware ready to transmit?

Returns

true if a packet can be sent now

eth_copy_txbuf()

void eth_copy_txbuf	(	uint32_t *	buffer,
		uint32_t	length
	)

Copy supplied buffer into transmit hardware.

Parameters

[in]	buffer	Buffer to copy the message from
[in]	length	Length of message

eth_copy_rxbuf()

void eth_copy_rxbuf	(	uint32_t *	buffer,
		uint32_t	length
	)

Copy received message into supplied buffer.

Parameters

[out]	buffer	Buffer to copy the message into
[in]	length	Length of message. Buffer must be at least this large.

eth_rx_size()

uint32_t eth_rx_size

(

void

)

Get size of received data.

Returns

Size of message, in bytes

configure_eth()

void configure_eth

(

const uint8_t *

mac_addr

)

Configure the ethernet hardware.

Parameters

[in]

mac_addr

The MAC address to use