1/************************************************************************* 2SPDX-License-Identifier: BSD-3-Clause 3 4Copyright (c) 2003-2007 Cavium Networks (support@cavium.com). All rights 5reserved. 6 7 8Redistribution and use in source and binary forms, with or without 9modification, are permitted provided that the following conditions are 10met: 11 12 * Redistributions of source code must retain the above copyright 13 notice, this list of conditions and the following disclaimer. 14 15 * Redistributions in binary form must reproduce the above 16 copyright notice, this list of conditions and the following 17 disclaimer in the documentation and/or other materials provided 18 with the distribution. 19 20 * Neither the name of Cavium Networks nor the names of 21 its contributors may be used to endorse or promote products 22 derived from this software without specific prior written 23 permission. 24 25This Software, including technical data, may be subject to U.S. export control laws, including the U.S. Export Administration Act and its associated regulations, and may be subject to export or import regulations in other countries. 26 27TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 28AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 29 30*************************************************************************/ 31/* $FreeBSD$ */ 32 33/** 34 * @file 35 * External interface for the Cavium Octeon ethernet driver. 36 * 37 * $Id: cavium-ethernet.h 41589 2009-03-19 19:58:58Z cchavva $ 38 * 39 */ 40#ifndef CAVIUM_ETHERNET_H 41#define CAVIUM_ETHERNET_H 42 43#include <sys/taskqueue.h> 44#include <net/if_media.h> 45#include <net/ifq.h> 46 47/** 48 * This is the definition of the Ethernet driver's private 49 * driver state stored in ifp->if_softc. 50 */ 51typedef struct { 52 /* XXX FreeBSD device softcs must start with an ifnet pointer. */ 53 struct ifnet *ifp; 54 55 int port; /* PKO hardware output port */ 56 int queue; /* PKO hardware queue for the port */ 57 int fau; /* Hardware fetch and add to count outstanding tx buffers */ 58 int imode; /* Type of port. This is one of the enums in cvmx_helper_interface_mode_t */ 59#if 0 60 struct ifnet_stats stats; /* Device statistics */ 61#endif 62 uint64_t link_info; /* Last negotiated link state */ 63 void (*poll)(struct ifnet *ifp); /* Called periodically to check link status */ 64 65 /* 66 * FreeBSD additions. 67 */ 68 device_t dev; 69 device_t miibus; 70 71 int (*open)(struct ifnet *ifp); 72 int (*stop)(struct ifnet *ifp); 73 74 int (*init)(struct ifnet *ifp); 75 void (*uninit)(struct ifnet *ifp); 76 77 uint8_t mac[6]; 78 int phy_id; 79 const char *phy_device; 80 int (*mdio_read)(struct ifnet *, int, int); 81 void (*mdio_write)(struct ifnet *, int, int, int); 82 83 struct ifqueue tx_free_queue[16]; 84 85 int need_link_update; 86 struct task link_task; 87 struct ifmedia media; 88 int if_flags; 89 90 struct mtx tx_mtx; 91} cvm_oct_private_t; 92 93 94/** 95 * Free a work queue entry received in a intercept callback. 96 * 97 * @param work_queue_entry 98 * Work queue entry to free 99 * @return Zero on success, Negative on failure. 100 */ 101int cvm_oct_free_work(void *work_queue_entry); 102 103#endif 104