xref: /freebsd/sys/powerpc/ps3/if_glcreg.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (C) 2010 Nathan Whitehorn
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 TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef _POWERPC_PS3_IF_GLCREG_H
29 #define _POWERPC_PS3_IF_GLCREG_H
30 
31 #define GLC_MAX_TX_PACKETS	128
32 #define GLC_MAX_RX_PACKETS	128
33 
34 struct glc_dmadesc;
35 
36 /*
37  * software state for transmit job mbufs (may be elements of mbuf chains)
38  */
39 
40 struct glc_txsoft {
41 	struct mbuf *txs_mbuf;		/* head of our mbuf chain */
42 	bus_dmamap_t txs_dmamap;	/* our DMA map */
43 	int txs_firstdesc;		/* first descriptor in packet */
44 	int txs_lastdesc;		/* last descriptor in packet */
45 
46 	int txs_ndescs;			/* number of descriptors */
47 	STAILQ_ENTRY(glc_txsoft) txs_q;
48 };
49 
50 STAILQ_HEAD(glc_txsq, glc_txsoft);
51 
52 /*
53  * software state for receive jobs
54  */
55 struct glc_rxsoft {
56 	struct mbuf *rxs_mbuf;		/* head of our mbuf chain */
57 	bus_dmamap_t rxs_dmamap;	/* our DMA map */
58 
59 	int rxs_desc_slot;		/* DMA descriptor for this packet */
60 	bus_addr_t rxs_desc;
61 
62 	bus_dma_segment_t segment;
63 };
64 
65 struct glc_softc {
66 	if_t		sc_ifp;
67 	device_t	sc_self;
68 	struct mtx	sc_mtx;
69 	u_char		sc_enaddr[ETHER_ADDR_LEN];
70 	int		sc_tx_vlan, sc_rx_vlan;
71 	int		sc_ifpflags;
72 
73 	uint64_t	sc_dma_base[5];
74 	bus_dma_tag_t	sc_dmadesc_tag;
75 
76 	int		sc_irqid;
77 	struct resource	*sc_irq;
78 	void		*sc_irqctx;
79 	uint64_t	*sc_hwirq_status;
80 	volatile uint64_t sc_interrupt_status;
81 
82 	struct ifmedia	sc_media;
83 
84 	/* Transmission */
85 
86 	bus_dma_tag_t	sc_txdma_tag;
87 	struct glc_txsoft sc_txsoft[GLC_MAX_TX_PACKETS];
88 	struct glc_dmadesc *sc_txdmadesc;
89 	int		next_txdma_slot, first_used_txdma_slot, bsy_txdma_slots;
90 	bus_dmamap_t	sc_txdmadesc_map;
91 	bus_addr_t	sc_txdmadesc_phys;
92 
93 	struct glc_txsq	sc_txfreeq;
94 	struct glc_txsq	sc_txdirtyq;
95 
96 	/* Reception */
97 
98 	bus_dma_tag_t	sc_rxdma_tag;
99 	struct glc_rxsoft sc_rxsoft[GLC_MAX_RX_PACKETS];
100 	struct glc_dmadesc *sc_rxdmadesc;
101 	int		sc_next_rxdma_slot;
102 	bus_dmamap_t	sc_rxdmadesc_map;
103 	bus_addr_t	sc_rxdmadesc_phys;
104 
105 	int		sc_bus, sc_dev;
106 	int		sc_wdog_timer;
107 	struct callout	sc_tick_ch;
108 };
109 
110 #define GELIC_GET_MAC_ADDRESS   0x0001
111 #define GELIC_GET_LINK_STATUS   0x0002
112 #define GELIC_SET_LINK_MODE     0x0003
113 #define  GELIC_LINK_UP          0x0001
114 #define  GELIC_FULL_DUPLEX      0x0002
115 #define  GELIC_AUTO_NEG         0x0004
116 #define  GELIC_SPEED_10         0x0010
117 #define  GELIC_SPEED_100        0x0020
118 #define  GELIC_SPEED_1000       0x0040
119 #define GELIC_GET_VLAN_ID       0x0004
120 #define  GELIC_VLAN_TX_ETHERNET	0x0002
121 #define  GELIC_VLAN_RX_ETHERNET	0x0012
122 #define  GELIC_VLAN_TX_WIRELESS	0x0003
123 #define  GELIC_VLAN_RX_WIRELESS	0x0013
124 
125 /* Command status code */
126 #define	GELIC_DESCR_OWNED	0xa0000000
127 #define	GELIC_CMDSTAT_DMA_DONE	0x00000000
128 #define	GELIC_CMDSTAT_CHAIN_END	0x00000002
129 #define GELIC_CMDSTAT_CSUM_TCP	0x00020000
130 #define GELIC_CMDSTAT_CSUM_UDP	0x00030000
131 #define GELIC_CMDSTAT_NOIPSEC	0x00080000
132 #define GELIC_CMDSTAT_LAST	0x00040000
133 #define GELIC_RXERRORS		0x7def8000
134 
135 /* RX Data Status codes */
136 #define GELIC_RX_IPCSUM		0x20000000
137 #define GELIC_RX_TCPUDPCSUM	0x10000000
138 
139 /* Interrupt options */
140 #define GELIC_INT_RXDONE	0x0000000000004000UL
141 #define GELIC_INT_RXFRAME	0x1000000000000000UL
142 #define GELIC_INT_TXDONE	0x0080000000000000UL
143 #define GELIC_INT_TX_CHAIN_END	0x0100000000000000UL
144 #define GELIC_INT_PHY		0x0000000020000000UL
145 
146 /* Hardware DMA descriptor. Must be 32-byte aligned */
147 
148 struct glc_dmadesc {
149 	uint32_t paddr;	/* Must be 128 byte aligned for receive */
150 	uint32_t len;
151 	uint32_t next;
152 	uint32_t cmd_stat;
153 	uint32_t result_size;
154 	uint32_t valid_size;
155 	uint32_t data_stat;
156 	uint32_t rxerror;
157 };
158 
159 #endif /* _POWERPC_PS3_IF_GLCREG_H */
160