sys/dev/tsec/if_tsec.h

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