1 /* $NetBSD: bcmgenetvar.h,v 1.6 2024/10/04 10:41:58 skrll Exp $ */
2 
3 /*-
4  * Copyright (c) 2020 Jared McNeill <jmcneill@invisible.ca>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * 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
26  * SUCH DAMAGE.
27  */
28 
29 /*
30  * Broadcom GENETv5
31  */
32 
33 #ifndef _BCMGENETVAR_H
34 #define _BCMGENETVAR_H
35 
36 #include <dev/ic/bcmgenetreg.h>
37 
38 enum genet_phy_mode {
39           GENET_PHY_MODE_RGMII,
40           GENET_PHY_MODE_RGMII_ID,
41           GENET_PHY_MODE_RGMII_TXID,
42           GENET_PHY_MODE_RGMII_RXID,
43 };
44 
45 struct genet_bufmap {
46           bus_dmamap_t                  map;
47           struct mbuf                   *mbuf;
48 };
49 
50 struct genet_ring {
51           bus_dma_tag_t                 buf_tag;
52           struct genet_bufmap buf_map[GENET_DMA_DESC_COUNT];
53           u_int                         next, queued;
54           uint32_t            cidx, pidx;
55 };
56 
57 struct genet_softc {
58           device_t            sc_dev;
59           bus_space_tag_t               sc_bst;
60           bus_space_handle_t  sc_bsh;
61           bus_dma_tag_t                 sc_dmat;
62           int                           sc_phy_id;
63           enum genet_phy_mode sc_phy_mode;
64 
65           struct ethercom               sc_ec;
66           struct mii_data               sc_mii;
67           callout_t           sc_stat_ch;
68           kmutex_t            sc_lock;
69           kmutex_t            sc_txlock;
70 
71           u_short                       sc_if_flags;
72           bool                          sc_txrunning;
73 
74           struct genet_ring   sc_tx;
75           struct genet_ring   sc_rx;
76 
77           krndsource_t                  sc_rndsource;
78 };
79 
80 int       genet_attach(struct genet_softc *);
81 int       genet_intr(void *);
82 
83 #endif /* !_BCMGENETVAR_H */
84