source: rtems-libbsd/freebsd/sys/dev/tsec/if_tsec.h @ 75b706f

5-freebsd-12
Last change on this file since 75b706f was 75b706f, checked in by Sebastian Huber <sebastian.huber@…>, on Dec 9, 2016 at 1:19:03 PM

Update to FreeBSD head 2016-12-10

Git mirror commit 80c55f08a05ab3b26a73b226ccb56adc3122a55c.

  • Property mode set to 100644
File size: 11.9 KB
Line 
1/*-
2 * Copyright (C) 2006-2007 Semihalf, Piotr Kruszynski
3 * 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 ``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.
24 *
25 * $FreeBSD$
26 */
27
28#ifndef _IF_TSEC_H
29#define _IF_TSEC_H
30
31#include <dev/ofw/openfirm.h>
32
33#define TSEC_RX_NUM_DESC        256
34#define TSEC_TX_NUM_DESC        256
35
36/* Interrupt Coalescing types */
37#define TSEC_IC_RX              0
38#define TSEC_IC_TX              1
39
40/* eTSEC ID */
41#define TSEC_ETSEC_ID           0x0124
42
43/* Frame sizes */
44#define TSEC_MIN_FRAME_SIZE     64
45#define TSEC_MAX_FRAME_SIZE     9600
46
47struct tsec_softc {
48        /* XXX MII bus requires that struct ifnet is first!!! */
49        struct ifnet    *tsec_ifp;
50       
51        struct mtx      transmit_lock;  /* transmitter lock */
52        struct mtx      receive_lock;   /* receiver lock */
53
54#ifndef __rtems__
55        phandle_t       node;
56#endif /* __rtems__ */
57        device_t        dev;
58        device_t        tsec_miibus;
59        struct mii_data *tsec_mii;      /* MII media control */
60        int             tsec_link;
61
62        bus_dma_tag_t   tsec_tx_dtag;   /* TX descriptors tag */
63        bus_dmamap_t    tsec_tx_dmap;   /* TX descriptors map */
64        struct tsec_desc *tsec_tx_vaddr;/* vadress of TX descriptors */
65        uint32_t        tsec_tx_raddr;  /* real address of TX descriptors */
66
67        bus_dma_tag_t   tsec_rx_dtag;   /* RX descriptors tag */
68        bus_dmamap_t    tsec_rx_dmap;   /* RX descriptors map */
69        struct tsec_desc *tsec_rx_vaddr; /* vadress of RX descriptors */
70        uint32_t        tsec_rx_raddr;  /* real address of RX descriptors */
71
72        bus_dma_tag_t   tsec_tx_mtag;   /* TX mbufs tag */
73        bus_dma_tag_t   tsec_rx_mtag;   /* TX mbufs tag */
74
75        struct rx_data_type {
76                bus_dmamap_t    map;    /* mbuf map */
77                struct mbuf     *mbuf;
78                uint32_t        paddr;  /* DMA address of buffer */
79        } rx_data[TSEC_RX_NUM_DESC];
80
81        uint32_t        tx_cur_desc_cnt;
82        uint32_t        tx_dirty_desc_cnt;
83        uint32_t        rx_cur_desc_cnt;
84
85        struct resource *sc_rres;       /* register resource */
86        int             sc_rrid;        /* register rid */
87        struct {
88                bus_space_tag_t bst;
89                bus_space_handle_t bsh;
90        } sc_bas;
91
92        struct resource *sc_transmit_ires;
93        void            *sc_transmit_ihand;
94        int             sc_transmit_irid;
95        struct resource *sc_receive_ires;
96        void            *sc_receive_ihand;
97        int             sc_receive_irid;
98        struct resource *sc_error_ires;
99        void            *sc_error_ihand;
100        int             sc_error_irid;
101
102        int             tsec_if_flags;
103        int             is_etsec;
104
105        /* Watchdog and MII tick related */
106        struct callout  tsec_callout;
107        int             tsec_watchdog;
108
109        /* TX maps */
110        bus_dmamap_t    tx_map_data[TSEC_TX_NUM_DESC];
111
112        /* unused TX maps data */
113        uint32_t        tx_map_unused_get_cnt;
114        uint32_t        tx_map_unused_put_cnt;
115        bus_dmamap_t    *tx_map_unused_data[TSEC_TX_NUM_DESC];
116
117        /* used TX maps data */
118        uint32_t        tx_map_used_get_cnt;
119        uint32_t        tx_map_used_put_cnt;
120        bus_dmamap_t    *tx_map_used_data[TSEC_TX_NUM_DESC];
121       
122        /* mbufs in TX queue */
123        uint32_t        tx_mbuf_used_get_cnt;
124        uint32_t        tx_mbuf_used_put_cnt;
125        struct mbuf     *tx_mbuf_used_data[TSEC_TX_NUM_DESC];
126
127        /* interrupt coalescing */
128        struct mtx      ic_lock;
129        uint32_t        rx_ic_time;     /* RW, valid values 0..65535 */
130        uint32_t        rx_ic_count;    /* RW, valid values 0..255 */
131        uint32_t        tx_ic_time;
132        uint32_t        tx_ic_count;
133
134        /* currently received frame */
135        struct mbuf     *frame;
136
137        int             phyaddr;
138        bus_space_tag_t phy_bst;
139        bus_space_handle_t phy_bsh;
140        int             phy_regoff;
141};
142
143/* interface to get/put generic objects */
144#define TSEC_CNT_INIT(cnt, wrap) ((cnt) = ((wrap) - 1))
145
146#define TSEC_INC(count, wrap) (count = ((count) + 1) & ((wrap) - 1))
147
148#define TSEC_GET_GENERIC(hand, tab, count, wrap) \
149                ((hand)->tab[TSEC_INC((hand)->count, wrap)])
150
151#define TSEC_PUT_GENERIC(hand, tab, count, wrap, val)   \
152                ((hand)->tab[TSEC_INC((hand)->count, wrap)] = val)
153
154#define TSEC_BACK_GENERIC(sc, count, wrap) do {                 \
155                if ((sc)->count > 0)                            \
156                        (sc)->count--;                          \
157                else                                            \
158                        (sc)->count = (wrap) - 1;               \
159} while (0)
160
161/* TX maps interface */
162#define TSEC_TX_MAP_CNT_INIT(sc) do {                                           \
163                TSEC_CNT_INIT((sc)->tx_map_unused_get_cnt, TSEC_TX_NUM_DESC);   \
164                TSEC_CNT_INIT((sc)->tx_map_unused_put_cnt, TSEC_TX_NUM_DESC);   \
165                TSEC_CNT_INIT((sc)->tx_map_used_get_cnt, TSEC_TX_NUM_DESC);     \
166                TSEC_CNT_INIT((sc)->tx_map_used_put_cnt, TSEC_TX_NUM_DESC);     \
167} while (0)
168
169/* interface to get/put unused TX maps */
170#define TSEC_ALLOC_TX_MAP(sc)                                                   \
171                TSEC_GET_GENERIC(sc, tx_map_unused_data, tx_map_unused_get_cnt, \
172                TSEC_TX_NUM_DESC)
173
174#define TSEC_FREE_TX_MAP(sc, val)                                               \
175                TSEC_PUT_GENERIC(sc, tx_map_unused_data, tx_map_unused_put_cnt, \
176                TSEC_TX_NUM_DESC, val)
177
178/* interface to get/put used TX maps */
179#define TSEC_GET_TX_MAP(sc)                                                     \
180                TSEC_GET_GENERIC(sc, tx_map_used_data, tx_map_used_get_cnt,     \
181                TSEC_TX_NUM_DESC)
182
183#define TSEC_PUT_TX_MAP(sc, val)                                                \
184                TSEC_PUT_GENERIC(sc, tx_map_used_data, tx_map_used_put_cnt,     \
185                TSEC_TX_NUM_DESC, val)
186
187/* interface to get/put TX mbufs in send queue */
188#define TSEC_TX_MBUF_CNT_INIT(sc) do {                                          \
189                TSEC_CNT_INIT((sc)->tx_mbuf_used_get_cnt, TSEC_TX_NUM_DESC);    \
190                TSEC_CNT_INIT((sc)->tx_mbuf_used_put_cnt, TSEC_TX_NUM_DESC);    \
191} while (0)
192
193#define TSEC_GET_TX_MBUF(sc)                                                    \
194                TSEC_GET_GENERIC(sc, tx_mbuf_used_data, tx_mbuf_used_get_cnt,   \
195                TSEC_TX_NUM_DESC)
196
197#define TSEC_PUT_TX_MBUF(sc, val)                                               \
198                TSEC_PUT_GENERIC(sc, tx_mbuf_used_data, tx_mbuf_used_put_cnt,   \
199                TSEC_TX_NUM_DESC, val)
200
201#define TSEC_EMPTYQ_TX_MBUF(sc) \
202                ((sc)->tx_mbuf_used_get_cnt == (sc)->tx_mbuf_used_put_cnt)
203
204/* interface for manage tx tsec_desc */
205#define TSEC_TX_DESC_CNT_INIT(sc) do {                                          \
206                TSEC_CNT_INIT((sc)->tx_cur_desc_cnt, TSEC_TX_NUM_DESC);         \
207                TSEC_CNT_INIT((sc)->tx_dirty_desc_cnt, TSEC_TX_NUM_DESC);       \
208} while (0)
209
210#define TSEC_GET_CUR_TX_DESC(sc)                                                \
211                &TSEC_GET_GENERIC(sc, tsec_tx_vaddr, tx_cur_desc_cnt,           \
212                TSEC_TX_NUM_DESC)
213
214#define TSEC_GET_DIRTY_TX_DESC(sc)                                              \
215                &TSEC_GET_GENERIC(sc, tsec_tx_vaddr, tx_dirty_desc_cnt,         \
216                TSEC_TX_NUM_DESC)
217
218#define TSEC_BACK_DIRTY_TX_DESC(sc) \
219                TSEC_BACK_GENERIC(sc, tx_dirty_desc_cnt, TSEC_TX_NUM_DESC)
220
221#define TSEC_CUR_DIFF_DIRTY_TX_DESC(sc) \
222                ((sc)->tx_cur_desc_cnt != (sc)->tx_dirty_desc_cnt)
223
224#define TSEC_FREE_TX_DESC(sc)                                           \
225                (((sc)->tx_cur_desc_cnt < (sc)->tx_dirty_desc_cnt) ?    \
226                ((sc)->tx_dirty_desc_cnt - (sc)->tx_cur_desc_cnt - 1)   \
227                :                                                       \
228                (TSEC_TX_NUM_DESC - (sc)->tx_cur_desc_cnt               \
229                + (sc)->tx_dirty_desc_cnt - 1))
230
231/* interface for manage rx tsec_desc */
232#define TSEC_RX_DESC_CNT_INIT(sc) do {                                  \
233                TSEC_CNT_INIT((sc)->rx_cur_desc_cnt, TSEC_RX_NUM_DESC); \
234} while (0)
235
236#define TSEC_GET_CUR_RX_DESC(sc)                                        \
237                &TSEC_GET_GENERIC(sc, tsec_rx_vaddr, rx_cur_desc_cnt,   \
238                TSEC_RX_NUM_DESC)
239
240#define TSEC_BACK_CUR_RX_DESC(sc) \
241                TSEC_BACK_GENERIC(sc, rx_cur_desc_cnt, TSEC_RX_NUM_DESC)
242
243#define TSEC_GET_CUR_RX_DESC_CNT(sc) \
244                ((sc)->rx_cur_desc_cnt)
245
246/* init all counters (for init only!) */
247#define TSEC_TX_RX_COUNTERS_INIT(sc) do {       \
248                TSEC_TX_MAP_CNT_INIT(sc);       \
249                TSEC_TX_MBUF_CNT_INIT(sc);      \
250                TSEC_TX_DESC_CNT_INIT(sc);      \
251                TSEC_RX_DESC_CNT_INIT(sc);      \
252} while (0)
253
254/* read/write bus functions */
255#define TSEC_READ(sc, reg)              \
256                bus_space_read_4((sc)->sc_bas.bst, (sc)->sc_bas.bsh, (reg))
257#define TSEC_WRITE(sc, reg, val)        \
258                bus_space_write_4((sc)->sc_bas.bst, (sc)->sc_bas.bsh, (reg), (val))
259
260extern struct mtx tsec_phy_mtx;
261#define TSEC_PHY_LOCK(sc)       mtx_lock(&tsec_phy_mtx)
262#define TSEC_PHY_UNLOCK(sc)     mtx_unlock(&tsec_phy_mtx)
263#define TSEC_PHY_READ(sc, reg)          \
264                bus_space_read_4((sc)->phy_bst, (sc)->phy_bsh, \
265                        (reg) + (sc)->phy_regoff)
266#define TSEC_PHY_WRITE(sc, reg, val)    \
267                bus_space_write_4((sc)->phy_bst, (sc)->phy_bsh, \
268                        (reg) + (sc)->phy_regoff, (val))
269
270/* Lock for transmitter */
271#define TSEC_TRANSMIT_LOCK(sc) do {                                     \
272                mtx_assert(&(sc)->receive_lock, MA_NOTOWNED);           \
273                mtx_lock(&(sc)->transmit_lock);                         \
274} while (0)
275
276#define TSEC_TRANSMIT_UNLOCK(sc)        mtx_unlock(&(sc)->transmit_lock)
277#define TSEC_TRANSMIT_LOCK_ASSERT(sc)   mtx_assert(&(sc)->transmit_lock, MA_OWNED)
278
279/* Lock for receiver */
280#define TSEC_RECEIVE_LOCK(sc) do {                                      \
281                mtx_assert(&(sc)->transmit_lock, MA_NOTOWNED);          \
282                mtx_lock(&(sc)->receive_lock);                          \
283} while (0)
284
285#define TSEC_RECEIVE_UNLOCK(sc)         mtx_unlock(&(sc)->receive_lock)
286#define TSEC_RECEIVE_LOCK_ASSERT(sc)    mtx_assert(&(sc)->receive_lock, MA_OWNED)
287
288/* Lock for interrupts coalescing */
289#define TSEC_IC_LOCK(sc) do {                                           \
290                mtx_assert(&(sc)->ic_lock, MA_NOTOWNED);                \
291                mtx_lock(&(sc)->ic_lock);                               \
292} while (0)
293
294#define TSEC_IC_UNLOCK(sc)              mtx_unlock(&(sc)->ic_lock)
295#define TSEC_IC_LOCK_ASSERT(sc)         mtx_assert(&(sc)->ic_lock, MA_OWNED)
296
297/* Global tsec lock (with all locks) */
298#define TSEC_GLOBAL_LOCK(sc) do {                                       \
299                if ((mtx_owned(&(sc)->transmit_lock) ? 1 : 0) !=        \
300                        (mtx_owned(&(sc)->receive_lock) ? 1 : 0)) {     \
301                        panic("tsec deadlock possibility detection!");  \
302                }                                                       \
303                mtx_lock(&(sc)->transmit_lock);                         \
304                mtx_lock(&(sc)->receive_lock);                          \
305} while (0)
306
307#define TSEC_GLOBAL_UNLOCK(sc) do {             \
308                TSEC_RECEIVE_UNLOCK(sc);        \
309                TSEC_TRANSMIT_UNLOCK(sc);       \
310} while (0)
311
312#define TSEC_GLOBAL_LOCK_ASSERT(sc) do {        \
313                TSEC_TRANSMIT_LOCK_ASSERT(sc);  \
314                TSEC_RECEIVE_LOCK_ASSERT(sc);   \
315} while (0)
316
317/* From global to {transmit,receive} */
318#define TSEC_GLOBAL_TO_TRANSMIT_LOCK(sc) do {   \
319                mtx_unlock(&(sc)->receive_lock);\
320} while (0)
321
322#define TSEC_GLOBAL_TO_RECEIVE_LOCK(sc) do {    \
323                mtx_unlock(&(sc)->transmit_lock);\
324} while (0)
325
326struct tsec_desc {
327        volatile uint16_t       flags;  /* descriptor flags */
328        volatile uint16_t       length; /* buffer length */
329        volatile uint32_t       bufptr; /* buffer pointer */
330};
331
332#define TSEC_READ_RETRY 10000
333#define TSEC_READ_DELAY 100
334
335/* Structures and defines for TCP/IP Off-load */
336struct tsec_tx_fcb {
337        volatile uint16_t       flags;
338        volatile uint8_t        l4_offset;
339        volatile uint8_t        l3_offset;
340        volatile uint16_t       ph_chsum;
341        volatile uint16_t       vlan;
342};
343
344struct tsec_rx_fcb {
345        volatile uint16_t       flags;
346        volatile uint8_t        rq_index;
347        volatile uint8_t        protocol;
348        volatile uint16_t       unused;
349        volatile uint16_t       vlan;
350};
351
352#define TSEC_CHECKSUM_FEATURES  (CSUM_IP | CSUM_TCP | CSUM_UDP)
353
354#define TSEC_TX_FCB_IP4         TSEC_TX_FCB_L3_IS_IP
355#define TSEC_TX_FCB_IP6         (TSEC_TX_FCB_L3_IS_IP | TSEC_TX_FCB_L3_IS_IP6)
356
357#define TSEC_TX_FCB_TCP         TSEC_TX_FCB_L4_IS_TCP_UDP
358#define TSEC_TX_FCB_UDP         (TSEC_TX_FCB_L4_IS_TCP_UDP | TSEC_TX_FCB_L4_IS_UDP)
359
360#define TSEC_RX_FCB_IP_CSUM_CHECKED(flags)                                      \
361                ((flags & (TSEC_RX_FCB_IP_FOUND | TSEC_RX_FCB_IP6_FOUND |       \
362                TSEC_RX_FCB_IP_CSUM | TSEC_RX_FCB_PARSE_ERROR))                 \
363                 == (TSEC_RX_FCB_IP_FOUND | TSEC_RX_FCB_IP_CSUM))
364
365#define TSEC_RX_FCB_TCP_UDP_CSUM_CHECKED(flags)                                 \
366                ((flags & (TSEC_RX_FCB_TCP_UDP_FOUND | TSEC_RX_FCB_TCP_UDP_CSUM \
367                | TSEC_RX_FCB_PARSE_ERROR))                                     \
368                == (TSEC_RX_FCB_TCP_UDP_FOUND | TSEC_RX_FCB_TCP_UDP_CSUM))
369
370/* Prototypes */
371extern devclass_t tsec_devclass;
372
373int     tsec_attach(struct tsec_softc *sc);
374int     tsec_detach(struct tsec_softc *sc);
375
376void    tsec_error_intr(void *arg);
377void    tsec_receive_intr(void *arg);
378void    tsec_transmit_intr(void *arg);
379
380int     tsec_miibus_readreg(device_t dev, int phy, int reg);
381int     tsec_miibus_writereg(device_t dev, int phy, int reg, int value);
382void    tsec_miibus_statchg(device_t dev);
383int     tsec_resume(device_t dev); /* XXX */
384int     tsec_shutdown(device_t dev);
385int     tsec_suspend(device_t dev); /* XXX */
386
387void    tsec_get_hwaddr(struct tsec_softc *sc, uint8_t *addr);
388
389#endif /* _IF_TSEC_H */
Note: See TracBrowser for help on using the repository browser.