usb_ethernet.h revision 189528
1/* $FreeBSD: head/sys/dev/usb/net/usb_ethernet.h 189528 2009-03-08 06:56:13Z thompsa $ */ 2/*- 3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27#ifndef _USB2_ETHERNET_H_ 28#define _USB2_ETHERNET_H_ 29 30#include "opt_inet.h" 31 32#include <sys/param.h> 33#include <sys/systm.h> 34#include <sys/mbuf.h> 35#include <sys/socket.h> 36#include <sys/sockio.h> 37#include <sys/limits.h> 38 39#include <net/if.h> 40#include <net/if_arp.h> 41#include <net/if_dl.h> 42#include <net/if_media.h> 43#include <net/if_types.h> 44#include <net/bpf.h> 45#include <net/ethernet.h> 46 47#include "miibus_if.h" 48 49#include <dev/mii/mii.h> 50#include <dev/mii/miivar.h> 51 52struct usb2_ether; 53struct usb2_device_request; 54 55typedef void (usb2_ether_fn_t)(struct usb2_ether *); 56 57struct usb2_ether_methods { 58 usb2_ether_fn_t *ue_attach_post; 59 usb2_ether_fn_t *ue_start; 60 usb2_ether_fn_t *ue_init; 61 usb2_ether_fn_t *ue_stop; 62 usb2_ether_fn_t *ue_setmulti; 63 usb2_ether_fn_t *ue_setpromisc; 64 usb2_ether_fn_t *ue_tick; 65 int (*ue_mii_upd)(struct ifnet *); 66 void (*ue_mii_sts)(struct ifnet *, 67 struct ifmediareq *); 68 int (*ue_ioctl)(struct ifnet *, u_long, caddr_t); 69 70}; 71 72struct usb2_ether_cfg_task { 73 struct usb2_proc_msg hdr; 74 struct usb2_ether *ue; 75}; 76 77struct usb2_ether { 78 /* NOTE: the "ue_ifp" pointer must be first --hps */ 79 struct ifnet *ue_ifp; 80 struct mtx *ue_mtx; 81 const struct usb2_ether_methods *ue_methods; 82 struct sysctl_oid *ue_sysctl_oid; 83 void *ue_sc; 84 struct usb2_device *ue_udev; /* used by usb2_ether_do_request() */ 85 device_t ue_dev; 86 device_t ue_miibus; 87 88 struct usb2_process ue_tq; 89 struct sysctl_ctx_list ue_sysctl_ctx; 90 struct ifqueue ue_rxq; 91 struct usb2_callout ue_watchdog; 92 struct usb2_ether_cfg_task ue_sync_task[2]; 93 struct usb2_ether_cfg_task ue_media_task[2]; 94 struct usb2_ether_cfg_task ue_multi_task[2]; 95 struct usb2_ether_cfg_task ue_promisc_task[2]; 96 struct usb2_ether_cfg_task ue_tick_task[2]; 97 98 int ue_unit; 99 100 /* ethernet address from eeprom */ 101 uint8_t ue_eaddr[ETHER_ADDR_LEN]; 102}; 103 104#define usb2_ether_do_request(ue,req,data,timo) \ 105 usb2_do_request_proc((ue)->ue_udev,&(ue)->ue_tq,req,data,0,NULL,timo) 106 107uint8_t usb2_ether_pause(struct usb2_ether *, unsigned int); 108struct ifnet *usb2_ether_getifp(struct usb2_ether *); 109struct mii_data *usb2_ether_getmii(struct usb2_ether *); 110void *usb2_ether_getsc(struct usb2_ether *); 111int usb2_ether_ifattach(struct usb2_ether *); 112void usb2_ether_ifdetach(struct usb2_ether *); 113int usb2_ether_ioctl(struct ifnet *, u_long, caddr_t); 114struct mbuf *usb2_ether_newbuf(void); 115int usb2_ether_rxmbuf(struct usb2_ether *, struct mbuf *, 116 unsigned int); 117int usb2_ether_rxbuf(struct usb2_ether *, 118 struct usb2_page_cache *, 119 unsigned int, unsigned int); 120void usb2_ether_rxflush(struct usb2_ether *); 121void usb2_ether_ifshutdown(struct usb2_ether *); 122uint8_t usb2_ether_is_gone(struct usb2_ether *); 123#endif /* _USB2_ETHERNET_H_ */ 124