[J-u-boot.git] / include / usb_ether.h

/*
 * Copyright (c) 2011 The Chromium OS Authors.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#ifndef __USB_ETHER_H__
#define __USB_ETHER_H__

#include <net.h>

/*
 *	IEEE 802.3 Ethernet magic constants.  The frame sizes omit the preamble
 *	and FCS/CRC (frame check sequence).
 */
#define ETH_ALEN	6		/* Octets in one ethernet addr	 */
#define ETH_HLEN	14		/* Total octets in header.	 */
#define ETH_ZLEN	60		/* Min. octets in frame sans FCS */
#define ETH_DATA_LEN	1500		/* Max. octets in payload	 */
#define ETH_FRAME_LEN	PKTSIZE_ALIGN	/* Max. octets in frame sans FCS */

/* TODO([email protected]): Remove @pusb_dev when all boards use CONFIG_DM_ETH */
struct ueth_data {
	/* eth info */
#ifdef CONFIG_DM_ETH
	uint8_t *rxbuf;
	int rxsize;
	int rxlen;			/* Total bytes available in rxbuf */
	int rxptr;			/* Current position in rxbuf */
#else
	struct eth_device eth_dev;	/* used with eth_register */
	/* driver private */
	void *dev_priv;
#endif
	int phy_id;			/* mii phy id */

	/* usb info */
	struct usb_device *pusb_dev;	/* this usb_device */
	unsigned char	ifnum;		/* interface number */
	unsigned char	ep_in;		/* in endpoint */
	unsigned char	ep_out;		/* out ....... */
	unsigned char	ep_int;		/* interrupt . */
	unsigned char	subclass;	/* as in overview */
	unsigned char	protocol;	/* .............. */
	unsigned char	irqinterval;	/* Intervall for IRQ Pipe */
};

#ifdef CONFIG_DM_ETH
/**
 * usb_ether_register() - register a new USB ethernet device
 *
 * This selects the correct USB interface and figures out the endpoints to use.
 *
 * @dev:	USB device
 * @ss:		Place to put USB ethernet data
 * @rxsize:	Maximum size to allocate for the receive buffer
 * @return 0 if OK, -ve on error
 */
int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize);

/**
 * usb_ether_deregister() - deregister a USB ethernet device
 *
 * @ueth:	USB Ethernet device
 * @return 0
 */
int usb_ether_deregister(struct ueth_data *ueth);

/**
 * usb_ether_receive() - recieve a packet from the bulk in endpoint
 *
 * The packet is stored in the internal buffer ready for processing.
 *
 * @ueth:	USB Ethernet device
 * @rxsize:	Maximum size to receive
 * @return 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is
 * larger than the size passed ot usb_ether_register(), other -ve on error
 */
int usb_ether_receive(struct ueth_data *ueth, int rxsize);

/**
 * usb_ether_get_rx_bytes() - obtain bytes from the internal packet buffer
 *
 * This should be called repeatedly to obtain packet data until it returns 0.
 * After each packet is processed, call usb_ether_advance_rxbuf() to move to
 * the next one.
 *
 * @ueth:	USB Ethernet device
 * @ptrp:	Returns a pointer to the start of the next packet if there is
 *		one available
 * @return number of bytes available, or 0 if none
 */
int usb_ether_get_rx_bytes(struct ueth_data *ueth, uint8_t **ptrp);

/**
 * usb_ether_advance_rxbuf() - Advance to the next packet in the internal buffer
 *
 * After processing the data returned by usb_ether_get_rx_bytes(), call this
 * function to move to the next packet. You must specify the number of bytes
 * you have processed in @num_bytes.
 *
 * @ueth:	USB Ethernet device
 * @num_bytes:	Number of bytes to skip, or -1 to skip all bytes
 */
void usb_ether_advance_rxbuf(struct ueth_data *ueth, int num_bytes);
#else
/*
 * Function definitions for each USB ethernet driver go here
 * (declaration is unconditional, compilation is conditional)
 */
void asix_eth_before_probe(void);
int asix_eth_probe(struct usb_device *dev, unsigned int ifnum,
		      struct ueth_data *ss);
int asix_eth_get_info(struct usb_device *dev, struct ueth_data *ss,
		      struct eth_device *eth);

void ax88179_eth_before_probe(void);
int ax88179_eth_probe(struct usb_device *dev, unsigned int ifnum,
		      struct ueth_data *ss);
int ax88179_eth_get_info(struct usb_device *dev, struct ueth_data *ss,
		      struct eth_device *eth);

void mcs7830_eth_before_probe(void);
int mcs7830_eth_probe(struct usb_device *dev, unsigned int ifnum,
		      struct ueth_data *ss);
int mcs7830_eth_get_info(struct usb_device *dev, struct ueth_data *ss,
			 struct eth_device *eth);

void smsc95xx_eth_before_probe(void);
int smsc95xx_eth_probe(struct usb_device *dev, unsigned int ifnum,
			struct ueth_data *ss);
int smsc95xx_eth_get_info(struct usb_device *dev, struct ueth_data *ss,
			struct eth_device *eth);

void r8152_eth_before_probe(void);
int r8152_eth_probe(struct usb_device *dev, unsigned int ifnum,
		    struct ueth_data *ss);
int r8152_eth_get_info(struct usb_device *dev, struct ueth_data *ss,
		       struct eth_device *eth);
#endif

#endif /* __USB_ETHER_H__ */
Commit	Line	Data
89d48367 SG	1	/*
89d48367 SG	2	* Copyright (c) 2011 The Chromium OS Authors.
89d48367	3	*
1a459660	4	* SPDX-License-Identifier: GPL-2.0+
89d48367 SG	5	*/
	6
	7	#ifndef __USB_ETHER_H__
	8	#define __USB_ETHER_H__
	9
	10	#include <net.h>
	11
	12	/*
	13	* IEEE 802.3 Ethernet magic constants. The frame sizes omit the preamble
	14	* and FCS/CRC (frame check sequence).
	15	*/
	16	#define ETH_ALEN 6 /* Octets in one ethernet addr */
	17	#define ETH_HLEN 14 /* Total octets in header. */
	18	#define ETH_ZLEN 60 /* Min. octets in frame sans FCS */
	19	#define ETH_DATA_LEN 1500 /* Max. octets in payload */
	20	#define ETH_FRAME_LEN PKTSIZE_ALIGN /* Max. octets in frame sans FCS */
89d48367	21
c8c2797c	22	/* TODO([email protected]): Remove @pusb_dev when all boards use CONFIG_DM_ETH */
89d48367 SG	23	struct ueth_data {
89d48367 SG	24	/* eth info */
c8c2797c SG	25	#ifdef CONFIG_DM_ETH
	26	uint8_t *rxbuf;
	27	int rxsize;
	28	int rxlen; /* Total bytes available in rxbuf */
	29	int rxptr; /* Current position in rxbuf */
	30	#else
	31	struct eth_device eth_dev; /* used with eth_register */
	32	/* driver private */
	33	void *dev_priv;
	34	#endif
	35	int phy_id; /* mii phy id */
89d48367 SG	36
	37	/* usb info */
	38	struct usb_device pusb_dev; / this usb_device */
c8c2797c SG	39	unsigned char ifnum; /* interface number */
	40	unsigned char ep_in; /* in endpoint */
	41	unsigned char ep_out; /* out ....... */
	42	unsigned char ep_int; /* interrupt . */
	43	unsigned char subclass; /* as in overview */
	44	unsigned char protocol; /* .............. */
89d48367	45	unsigned char irqinterval; /* Intervall for IRQ Pipe */
89d48367 SG	46	};
89d48367 SG	47
c8c2797c SG	48	#ifdef CONFIG_DM_ETH
	49	/**
	50	* usb_ether_register() - register a new USB ethernet device
	51	*
	52	* This selects the correct USB interface and figures out the endpoints to use.
	53	*
	54	* @dev: USB device
	55	* @ss: Place to put USB ethernet data
	56	* @rxsize: Maximum size to allocate for the receive buffer
	57	* @return 0 if OK, -ve on error
	58	*/
	59	int usb_ether_register(struct udevice dev, struct ueth_data ueth, int rxsize);
	60
	61	/**
	62	* usb_ether_deregister() - deregister a USB ethernet device
	63	*
	64	* @ueth: USB Ethernet device
	65	* @return 0
	66	*/
	67	int usb_ether_deregister(struct ueth_data *ueth);
	68
	69	/**
	70	* usb_ether_receive() - recieve a packet from the bulk in endpoint
	71	*
	72	* The packet is stored in the internal buffer ready for processing.
	73	*
	74	* @ueth: USB Ethernet device
	75	* @rxsize: Maximum size to receive
	76	* @return 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is
	77	* larger than the size passed ot usb_ether_register(), other -ve on error
	78	*/
	79	int usb_ether_receive(struct ueth_data *ueth, int rxsize);
	80
	81	/**
	82	* usb_ether_get_rx_bytes() - obtain bytes from the internal packet buffer
	83	*
	84	* This should be called repeatedly to obtain packet data until it returns 0.
	85	* After each packet is processed, call usb_ether_advance_rxbuf() to move to
	86	* the next one.
	87	*
	88	* @ueth: USB Ethernet device
	89	* @ptrp: Returns a pointer to the start of the next packet if there is
	90	* one available
	91	* @return number of bytes available, or 0 if none
	92	*/
	93	int usb_ether_get_rx_bytes(struct ueth_data ueth, uint8_t *ptrp);
	94
	95	/**
	96	* usb_ether_advance_rxbuf() - Advance to the next packet in the internal buffer
	97	*
	98	* After processing the data returned by usb_ether_get_rx_bytes(), call this
	99	* function to move to the next packet. You must specify the number of bytes
	100	* you have processed in @num_bytes.
	101	*
	102	* @ueth: USB Ethernet device
	103	* @num_bytes: Number of bytes to skip, or -1 to skip all bytes
	104	*/
	105	void usb_ether_advance_rxbuf(struct ueth_data *ueth, int num_bytes);
	106	#else
89d48367	107	/*
440a5742 GS	108	* Function definitions for each USB ethernet driver go here
440a5742 GS	109	* (declaration is unconditional, compilation is conditional)
89d48367	110	*/
9b70e007 SG	111	void asix_eth_before_probe(void);
	112	int asix_eth_probe(struct usb_device *dev, unsigned int ifnum,
	113	struct ueth_data *ss);
	114	int asix_eth_get_info(struct usb_device dev, struct ueth_data ss,
	115	struct eth_device *eth);
89d48367	116
e9954b86 RG	117	void ax88179_eth_before_probe(void);
	118	int ax88179_eth_probe(struct usb_device *dev, unsigned int ifnum,
	119	struct ueth_data *ss);
	120	int ax88179_eth_get_info(struct usb_device dev, struct ueth_data ss,
	121	struct eth_device *eth);
	122
df4fb1c3 GS	123	void mcs7830_eth_before_probe(void);
	124	int mcs7830_eth_probe(struct usb_device *dev, unsigned int ifnum,
	125	struct ueth_data *ss);
	126	int mcs7830_eth_get_info(struct usb_device dev, struct ueth_data ss,
	127	struct eth_device *eth);
	128
291391be SG	129	void smsc95xx_eth_before_probe(void);
	130	int smsc95xx_eth_probe(struct usb_device *dev, unsigned int ifnum,
	131	struct ueth_data *ss);
	132	int smsc95xx_eth_get_info(struct usb_device dev, struct ueth_data ss,
	133	struct eth_device *eth);
9dc8ba19 TC	134
	135	void r8152_eth_before_probe(void);
	136	int r8152_eth_probe(struct usb_device *dev, unsigned int ifnum,
	137	struct ueth_data *ss);
	138	int r8152_eth_get_info(struct usb_device dev, struct ueth_data ss,
	139	struct eth_device *eth);
c8c2797c	140	#endif
291391be	141
89d48367	142	#endif /* __USB_ETHER_H__ */