3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #ifndef _USB_ETHERNET_H_
32 #define _USB_ETHERNET_H_
36 #include <sys/param.h>
37 #include <sys/systm.h>
39 #include <sys/socket.h>
40 #include <sys/sockio.h>
41 #include <sys/limits.h>
44 #include <net/if_var.h>
45 #include <net/if_arp.h>
46 #include <net/if_dl.h>
47 #include <net/if_media.h>
48 #include <net/if_types.h>
51 #include <net/ethernet.h>
55 struct usb_device_request;
57 typedef void (uether_fn_t)(struct usb_ether *);
59 struct usb_ether_methods {
60 uether_fn_t *ue_attach_post;
61 uether_fn_t *ue_start;
64 uether_fn_t *ue_setmulti;
65 uether_fn_t *ue_setpromisc;
67 int (*ue_mii_upd)(struct ifnet *);
68 void (*ue_mii_sts)(struct ifnet *,
70 int (*ue_ioctl)(struct ifnet *, u_long, caddr_t);
71 int (*ue_attach_post_sub)(struct usb_ether *);
74 struct usb_ether_cfg_task {
75 struct usb_proc_msg hdr;
80 /* NOTE: the "ue_ifp" pointer must be first --hps */
83 const struct usb_ether_methods *ue_methods;
84 struct sysctl_oid *ue_sysctl_oid;
86 struct usb_device *ue_udev; /* used by uether_do_request() */
90 struct usb_process ue_tq;
91 struct sysctl_ctx_list ue_sysctl_ctx;
92 struct ifqueue ue_rxq;
93 struct usb_callout ue_watchdog;
94 struct usb_ether_cfg_task ue_sync_task[2];
95 struct usb_ether_cfg_task ue_media_task[2];
96 struct usb_ether_cfg_task ue_multi_task[2];
97 struct usb_ether_cfg_task ue_promisc_task[2];
98 struct usb_ether_cfg_task ue_tick_task[2];
102 /* ethernet address from eeprom */
103 uint8_t ue_eaddr[ETHER_ADDR_LEN];
106 #define uether_do_request(ue,req,data,timo) \
107 usbd_do_request_proc((ue)->ue_udev,&(ue)->ue_tq,req,data,0,NULL,timo)
109 uint8_t uether_pause(struct usb_ether *, unsigned int);
110 struct ifnet *uether_getifp(struct usb_ether *);
111 struct mii_data *uether_getmii(struct usb_ether *);
112 void *uether_getsc(struct usb_ether *);
113 int uether_ifattach(struct usb_ether *);
114 void uether_ifattach_wait(struct usb_ether *);
115 void uether_ifdetach(struct usb_ether *);
116 int uether_ifmedia_upd(struct ifnet *);
117 void uether_init(void *);
118 int uether_ioctl(struct ifnet *, u_long, caddr_t);
119 struct mbuf *uether_newbuf(void);
120 int uether_rxmbuf(struct usb_ether *, struct mbuf *,
122 int uether_rxbuf(struct usb_ether *,
123 struct usb_page_cache *,
124 unsigned int, unsigned int);
125 void uether_rxflush(struct usb_ether *);
126 uint8_t uether_is_gone(struct usb_ether *);
127 void uether_start(struct ifnet *);
128 #endif /* _USB_ETHERNET_H_ */