2 * Copyright (C) 2006-2007 Semihalf, Piotr Kruszynski
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
17 * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
19 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
21 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
22 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #include <dev/ofw/openfirm.h>
33 #define TSEC_RX_NUM_DESC 256
34 #define TSEC_TX_NUM_DESC 256
36 /* Interrupt Coalescing types */
41 #define TSEC_ETSEC_ID 0x0124
44 #define TSEC_MIN_FRAME_SIZE 64
45 #define TSEC_MAX_FRAME_SIZE 9600
48 /* XXX MII bus requires that struct ifnet is first!!! */
49 struct ifnet *tsec_ifp;
51 struct mtx transmit_lock; /* transmitter lock */
52 struct mtx receive_lock; /* receiver lock */
57 struct mii_data *tsec_mii; /* MII media control */
60 bus_dma_tag_t tsec_tx_dtag; /* TX descriptors tag */
61 bus_dmamap_t tsec_tx_dmap; /* TX descriptors map */
62 struct tsec_desc *tsec_tx_vaddr;/* vadress of TX descriptors */
63 uint32_t tsec_tx_raddr; /* real adress of TX descriptors */
65 bus_dma_tag_t tsec_rx_dtag; /* RX descriptors tag */
66 bus_dmamap_t tsec_rx_dmap; /* RX descriptors map */
67 struct tsec_desc *tsec_rx_vaddr; /* vadress of RX descriptors */
68 uint32_t tsec_rx_raddr; /* real adress of RX descriptors */
70 bus_dma_tag_t tsec_tx_mtag; /* TX mbufs tag */
71 bus_dma_tag_t tsec_rx_mtag; /* TX mbufs tag */
74 bus_dmamap_t map; /* mbuf map */
76 uint32_t paddr; /* DMA addres of buffer */
77 } rx_data[TSEC_RX_NUM_DESC];
79 uint32_t tx_cur_desc_cnt;
80 uint32_t tx_dirty_desc_cnt;
81 uint32_t rx_cur_desc_cnt;
83 struct resource *sc_rres; /* register resource */
84 int sc_rrid; /* register rid */
87 bus_space_handle_t bsh;
90 struct resource *sc_transmit_ires;
91 void *sc_transmit_ihand;
93 struct resource *sc_receive_ires;
94 void *sc_receive_ihand;
96 struct resource *sc_error_ires;
103 /* Watchdog and MII tick related */
104 struct callout tsec_callout;
108 bus_dmamap_t tx_map_data[TSEC_TX_NUM_DESC];
110 /* unused TX maps data */
111 uint32_t tx_map_unused_get_cnt;
112 uint32_t tx_map_unused_put_cnt;
113 bus_dmamap_t *tx_map_unused_data[TSEC_TX_NUM_DESC];
115 /* used TX maps data */
116 uint32_t tx_map_used_get_cnt;
117 uint32_t tx_map_used_put_cnt;
118 bus_dmamap_t *tx_map_used_data[TSEC_TX_NUM_DESC];
120 /* mbufs in TX queue */
121 uint32_t tx_mbuf_used_get_cnt;
122 uint32_t tx_mbuf_used_put_cnt;
123 struct mbuf *tx_mbuf_used_data[TSEC_TX_NUM_DESC];
125 /* interrupt coalescing */
127 uint32_t rx_ic_time; /* RW, valid values 0..65535 */
128 uint32_t rx_ic_count; /* RW, valid values 0..255 */
130 uint32_t tx_ic_count;
132 /* currently received frame */
136 struct tsec_softc *phy_sc;
139 /* interface to get/put generic objects */
140 #define TSEC_CNT_INIT(cnt, wrap) ((cnt) = ((wrap) - 1))
142 #define TSEC_INC(count, wrap) (count = ((count) + 1) & ((wrap) - 1))
144 #define TSEC_GET_GENERIC(hand, tab, count, wrap) \
145 ((hand)->tab[TSEC_INC((hand)->count, wrap)])
147 #define TSEC_PUT_GENERIC(hand, tab, count, wrap, val) \
148 ((hand)->tab[TSEC_INC((hand)->count, wrap)] = val)
150 #define TSEC_BACK_GENERIC(sc, count, wrap) do { \
151 if ((sc)->count > 0) \
154 (sc)->count = (wrap) - 1; \
157 /* TX maps interface */
158 #define TSEC_TX_MAP_CNT_INIT(sc) do { \
159 TSEC_CNT_INIT((sc)->tx_map_unused_get_cnt, TSEC_TX_NUM_DESC); \
160 TSEC_CNT_INIT((sc)->tx_map_unused_put_cnt, TSEC_TX_NUM_DESC); \
161 TSEC_CNT_INIT((sc)->tx_map_used_get_cnt, TSEC_TX_NUM_DESC); \
162 TSEC_CNT_INIT((sc)->tx_map_used_put_cnt, TSEC_TX_NUM_DESC); \
165 /* interface to get/put unused TX maps */
166 #define TSEC_ALLOC_TX_MAP(sc) \
167 TSEC_GET_GENERIC(sc, tx_map_unused_data, tx_map_unused_get_cnt, \
170 #define TSEC_FREE_TX_MAP(sc, val) \
171 TSEC_PUT_GENERIC(sc, tx_map_unused_data, tx_map_unused_put_cnt, \
172 TSEC_TX_NUM_DESC, val)
174 /* interface to get/put used TX maps */
175 #define TSEC_GET_TX_MAP(sc) \
176 TSEC_GET_GENERIC(sc, tx_map_used_data, tx_map_used_get_cnt, \
179 #define TSEC_PUT_TX_MAP(sc, val) \
180 TSEC_PUT_GENERIC(sc, tx_map_used_data, tx_map_used_put_cnt, \
181 TSEC_TX_NUM_DESC, val)
183 /* interface to get/put TX mbufs in send queue */
184 #define TSEC_TX_MBUF_CNT_INIT(sc) do { \
185 TSEC_CNT_INIT((sc)->tx_mbuf_used_get_cnt, TSEC_TX_NUM_DESC); \
186 TSEC_CNT_INIT((sc)->tx_mbuf_used_put_cnt, TSEC_TX_NUM_DESC); \
189 #define TSEC_GET_TX_MBUF(sc) \
190 TSEC_GET_GENERIC(sc, tx_mbuf_used_data, tx_mbuf_used_get_cnt, \
193 #define TSEC_PUT_TX_MBUF(sc, val) \
194 TSEC_PUT_GENERIC(sc, tx_mbuf_used_data, tx_mbuf_used_put_cnt, \
195 TSEC_TX_NUM_DESC, val)
197 #define TSEC_EMPTYQ_TX_MBUF(sc) \
198 ((sc)->tx_mbuf_used_get_cnt == (sc)->tx_mbuf_used_put_cnt)
200 /* interface for manage tx tsec_desc */
201 #define TSEC_TX_DESC_CNT_INIT(sc) do { \
202 TSEC_CNT_INIT((sc)->tx_cur_desc_cnt, TSEC_TX_NUM_DESC); \
203 TSEC_CNT_INIT((sc)->tx_dirty_desc_cnt, TSEC_TX_NUM_DESC); \
206 #define TSEC_GET_CUR_TX_DESC(sc) \
207 &TSEC_GET_GENERIC(sc, tsec_tx_vaddr, tx_cur_desc_cnt, \
210 #define TSEC_GET_DIRTY_TX_DESC(sc) \
211 &TSEC_GET_GENERIC(sc, tsec_tx_vaddr, tx_dirty_desc_cnt, \
214 #define TSEC_BACK_DIRTY_TX_DESC(sc) \
215 TSEC_BACK_GENERIC(sc, tx_dirty_desc_cnt, TSEC_TX_NUM_DESC)
217 #define TSEC_CUR_DIFF_DIRTY_TX_DESC(sc) \
218 ((sc)->tx_cur_desc_cnt != (sc)->tx_dirty_desc_cnt)
220 #define TSEC_FREE_TX_DESC(sc) \
221 (((sc)->tx_cur_desc_cnt < (sc)->tx_dirty_desc_cnt) ? \
222 ((sc)->tx_dirty_desc_cnt - (sc)->tx_cur_desc_cnt - 1) \
224 (TSEC_TX_NUM_DESC - (sc)->tx_cur_desc_cnt \
225 + (sc)->tx_dirty_desc_cnt - 1))
227 /* interface for manage rx tsec_desc */
228 #define TSEC_RX_DESC_CNT_INIT(sc) do { \
229 TSEC_CNT_INIT((sc)->rx_cur_desc_cnt, TSEC_RX_NUM_DESC); \
232 #define TSEC_GET_CUR_RX_DESC(sc) \
233 &TSEC_GET_GENERIC(sc, tsec_rx_vaddr, rx_cur_desc_cnt, \
236 #define TSEC_BACK_CUR_RX_DESC(sc) \
237 TSEC_BACK_GENERIC(sc, rx_cur_desc_cnt, TSEC_RX_NUM_DESC)
239 #define TSEC_GET_CUR_RX_DESC_CNT(sc) \
240 ((sc)->rx_cur_desc_cnt)
242 /* init all counters (for init only!) */
243 #define TSEC_TX_RX_COUNTERS_INIT(sc) do { \
244 TSEC_TX_MAP_CNT_INIT(sc); \
245 TSEC_TX_MBUF_CNT_INIT(sc); \
246 TSEC_TX_DESC_CNT_INIT(sc); \
247 TSEC_RX_DESC_CNT_INIT(sc); \
250 /* read/write bus functions */
251 #define TSEC_READ(sc, reg) \
252 bus_space_read_4((sc)->sc_bas.bst, (sc)->sc_bas.bsh, (reg))
253 #define TSEC_WRITE(sc, reg, val) \
254 bus_space_write_4((sc)->sc_bas.bst, (sc)->sc_bas.bsh, (reg), (val))
256 /* Lock for transmitter */
257 #define TSEC_TRANSMIT_LOCK(sc) do { \
258 mtx_assert(&(sc)->receive_lock, MA_NOTOWNED); \
259 mtx_lock(&(sc)->transmit_lock); \
262 #define TSEC_TRANSMIT_UNLOCK(sc) mtx_unlock(&(sc)->transmit_lock)
263 #define TSEC_TRANSMIT_LOCK_ASSERT(sc) mtx_assert(&(sc)->transmit_lock, MA_OWNED)
265 /* Lock for receiver */
266 #define TSEC_RECEIVE_LOCK(sc) do { \
267 mtx_assert(&(sc)->transmit_lock, MA_NOTOWNED); \
268 mtx_lock(&(sc)->receive_lock); \
271 #define TSEC_RECEIVE_UNLOCK(sc) mtx_unlock(&(sc)->receive_lock)
272 #define TSEC_RECEIVE_LOCK_ASSERT(sc) mtx_assert(&(sc)->receive_lock, MA_OWNED)
274 /* Lock for interrupts coalescing */
275 #define TSEC_IC_LOCK(sc) do { \
276 mtx_assert(&(sc)->ic_lock, MA_NOTOWNED); \
277 mtx_lock(&(sc)->ic_lock); \
280 #define TSEC_IC_UNLOCK(sc) mtx_unlock(&(sc)->ic_lock)
281 #define TSEC_IC_LOCK_ASSERT(sc) mtx_assert(&(sc)->ic_lock, MA_OWNED)
283 /* Global tsec lock (with all locks) */
284 #define TSEC_GLOBAL_LOCK(sc) do { \
285 if ((mtx_owned(&(sc)->transmit_lock) ? 1 : 0) != \
286 (mtx_owned(&(sc)->receive_lock) ? 1 : 0)) { \
287 panic("tsec deadlock possibility detection!"); \
289 mtx_lock(&(sc)->transmit_lock); \
290 mtx_lock(&(sc)->receive_lock); \
293 #define TSEC_GLOBAL_UNLOCK(sc) do { \
294 TSEC_RECEIVE_UNLOCK(sc); \
295 TSEC_TRANSMIT_UNLOCK(sc); \
298 #define TSEC_GLOBAL_LOCK_ASSERT(sc) do { \
299 TSEC_TRANSMIT_LOCK_ASSERT(sc); \
300 TSEC_RECEIVE_LOCK_ASSERT(sc); \
303 /* From global to {transmit,receive} */
304 #define TSEC_GLOBAL_TO_TRANSMIT_LOCK(sc) do { \
305 mtx_unlock(&(sc)->receive_lock);\
308 #define TSEC_GLOBAL_TO_RECEIVE_LOCK(sc) do { \
309 mtx_unlock(&(sc)->transmit_lock);\
313 volatile uint16_t flags; /* descriptor flags */
314 volatile uint16_t length; /* buffer length */
315 volatile uint32_t bufptr; /* buffer pointer */
318 #define TSEC_READ_RETRY 10000
319 #define TSEC_READ_DELAY 100
321 /* Structures and defines for TCP/IP Off-load */
323 volatile uint16_t flags;
324 volatile uint8_t l4_offset;
325 volatile uint8_t l3_offset;
326 volatile uint16_t ph_chsum;
327 volatile uint16_t vlan;
331 volatile uint16_t flags;
332 volatile uint8_t rq_index;
333 volatile uint8_t protocol;
334 volatile uint16_t unused;
335 volatile uint16_t vlan;
338 #define TSEC_CHECKSUM_FEATURES (CSUM_IP | CSUM_TCP | CSUM_UDP)
340 #define TSEC_TX_FCB_IP4 TSEC_TX_FCB_L3_IS_IP
341 #define TSEC_TX_FCB_IP6 (TSEC_TX_FCB_L3_IS_IP | TSEC_TX_FCB_L3_IS_IP6)
343 #define TSEC_TX_FCB_TCP TSEC_TX_FCB_L4_IS_TCP_UDP
344 #define TSEC_TX_FCB_UDP (TSEC_TX_FCB_L4_IS_TCP_UDP | TSEC_TX_FCB_L4_IS_UDP)
346 #define TSEC_RX_FCB_IP_CSUM_CHECKED(flags) \
347 ((flags & (TSEC_RX_FCB_IP_FOUND | TSEC_RX_FCB_IP6_FOUND | \
348 TSEC_RX_FCB_IP_CSUM | TSEC_RX_FCB_PARSE_ERROR)) \
349 == (TSEC_RX_FCB_IP_FOUND | TSEC_RX_FCB_IP_CSUM))
351 #define TSEC_RX_FCB_TCP_UDP_CSUM_CHECKED(flags) \
352 ((flags & (TSEC_RX_FCB_TCP_UDP_FOUND | TSEC_RX_FCB_TCP_UDP_CSUM \
353 | TSEC_RX_FCB_PARSE_ERROR)) \
354 == (TSEC_RX_FCB_TCP_UDP_FOUND | TSEC_RX_FCB_TCP_UDP_CSUM))
357 extern devclass_t tsec_devclass;
359 int tsec_attach(struct tsec_softc *sc);
360 int tsec_detach(struct tsec_softc *sc);
362 void tsec_error_intr(void *arg);
363 void tsec_receive_intr(void *arg);
364 void tsec_transmit_intr(void *arg);
366 int tsec_miibus_readreg(device_t dev, int phy, int reg);
367 int tsec_miibus_writereg(device_t dev, int phy, int reg, int value);
368 void tsec_miibus_statchg(device_t dev);
369 int tsec_resume(device_t dev); /* XXX */
370 int tsec_shutdown(device_t dev);
371 int tsec_suspend(device_t dev); /* XXX */
373 void tsec_get_hwaddr(struct tsec_softc *sc, uint8_t *addr);
375 #endif /* _IF_TSEC_H */