cvmx-ilk.h revision 232809
12079Siignatyev/***********************license start*************** 22079Siignatyev * Copyright (c) 2003-2010 Cavium Inc. (support@cavium.com). All rights 32079Siignatyev * reserved. 42079Siignatyev * 52079Siignatyev * 62079Siignatyev * Redistribution and use in source and binary forms, with or without 72079Siignatyev * modification, are permitted provided that the following conditions are 82079Siignatyev * met: 92079Siignatyev * 102079Siignatyev * * Redistributions of source code must retain the above copyright 112079Siignatyev * notice, this list of conditions and the following disclaimer. 122079Siignatyev * 132079Siignatyev * * Redistributions in binary form must reproduce the above 142079Siignatyev * copyright notice, this list of conditions and the following 152079Siignatyev * disclaimer in the documentation and/or other materials provided 162079Siignatyev * with the distribution. 172079Siignatyev 182079Siignatyev * * Neither the name of Cavium Inc. nor the names of 192079Siignatyev * its contributors may be used to endorse or promote products 202079Siignatyev * derived from this software without specific prior written 212079Siignatyev * permission. 222079Siignatyev 232079Siignatyev * This Software, including technical data, may be subject to U.S. export control 242079Siignatyev * laws, including the U.S. Export Administration Act and its associated 252079Siignatyev * regulations, and may be subject to export or import regulations in other 262079Siignatyev * countries. 272079Siignatyev 282079Siignatyev * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 292079Siignatyev * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR 302079Siignatyev * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO 312079Siignatyev * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR 322079Siignatyev * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM 332079Siignatyev * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE, 342079Siignatyev * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF 352079Siignatyev * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR 362079Siignatyev * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR 372079Siignatyev * PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 382079Siignatyev ***********************license end**************************************/ 392079Siignatyev 402079Siignatyev/** 412079Siignatyev * @file 422079Siignatyev * 432079Siignatyev * This file contains defines for the ILK interface 442079Siignatyev 452079Siignatyev * <hr>$Revision: 49448 $<hr> 462079Siignatyev * 472079Siignatyev * 482079Siignatyev */ 492079Siignatyev#ifndef __CVMX_ILK_H__ 502079Siignatyev#define __CVMX_ILK_H__ 512079Siignatyev 522079Siignatyev#ifdef __cplusplus 532079Siignatyevextern "C" { 542079Siignatyev#endif 552079Siignatyev 562079Siignatyev/* CSR typedefs have been moved to cvmx-ilk-defs.h */ 572079Siignatyev 582079Siignatyev#define CVMX_ILK_GBL_BASE 5 592079Siignatyev#define CVMX_ILK_QLM_BASE 1 602079Siignatyev 612079Siignatyevtypedef struct 622079Siignatyev{ 632079Siignatyev int intf_en : 8; 642079Siignatyev int lane_en_mask : 8; 652079Siignatyev int lane_speed : 16; 662079Siignatyev /* add more here */ 672079Siignatyev} cvmx_ilk_intf_t; 682079Siignatyev 692079Siignatyev#define CVMX_NUM_ILK_INTF 2 702079Siignatyev#define CVMX_MAX_ILK_LANES 8 712079Siignatyevextern unsigned char cvmx_ilk_lane_mask[CVMX_NUM_ILK_INTF]; 722079Siignatyev 732079Siignatyevtypedef struct 742079Siignatyev{ 752079Siignatyev unsigned int pipe; 762079Siignatyev unsigned int chan; 772079Siignatyev} cvmx_ilk_pipe_chan_t; 782079Siignatyev 792079Siignatyev#define CVMX_ILK_PIPE_BASE 72 802079Siignatyev#define CVMX_MAX_ILK_PIPES 45 812079Siignatyev#define CVMX_MAX_ILK_CHANS 8 822079Siignatyevextern unsigned char cvmx_ilk_chans[CVMX_NUM_ILK_INTF]; 832079Siignatyevextern unsigned char cvmx_ilk_chan_map[CVMX_NUM_ILK_INTF][CVMX_MAX_ILK_CHANS]; 842079Siignatyev 852079Siignatyevtypedef struct 862079Siignatyev{ 872079Siignatyev unsigned int chan; 882079Siignatyev unsigned int pknd; 892079Siignatyev} cvmx_ilk_chan_pknd_t; 902079Siignatyev 912079Siignatyev#define CVMX_ILK_PKND_BASE 20 922079Siignatyev#define CVMX_MAX_ILK_PKNDS 8 /* must be <45 */ 932079Siignatyev 942079Siignatyevtypedef struct 952079Siignatyev{ 962079Siignatyev unsigned int *chan_list; /* for discrete channels. or, must be null */ 972079Siignatyev unsigned int num_chans; 982079Siignatyev 992079Siignatyev unsigned int chan_start; /* for continuous channels */ 1002079Siignatyev unsigned int chan_end; 1012079Siignatyev unsigned int chan_step; 1022079Siignatyev 1032079Siignatyev unsigned int clr_on_rd; 1042079Siignatyev} cvmx_ilk_stats_ctrl_t; 1052079Siignatyev 1062079Siignatyev#define CVMX_ILK_MAX_CAL 288 1072079Siignatyev#define CVMX_ILK_TX_MIN_CAL 1 1082079Siignatyev#define CVMX_ILK_RX_MIN_CAL 1 1092079Siignatyev#define CVMX_ILK_CAL_GRP_SZ 8 1102079Siignatyev#define CVMX_ILK_PIPE_BPID_SZ 7 1112079Siignatyev#define CVMX_ILK_ENT_CTRL_SZ 2 1122079Siignatyev#define CVMX_ILK_RX_FIFO_WM 0x200 1132079Siignatyev 1142079Siignatyevtypedef enum 1152079Siignatyev{ 1162079Siignatyev PIPE_BPID = 0, 1172079Siignatyev LINK, 1182079Siignatyev XOFF, 1192079Siignatyev XON 1202079Siignatyev} cvmx_ilk_cal_ent_ctrl_t; 1212079Siignatyev 1222079Siignatyevtypedef struct 1232079Siignatyev{ 1242079Siignatyev unsigned char pipe_bpid; 1252079Siignatyev cvmx_ilk_cal_ent_ctrl_t ent_ctrl; 1262079Siignatyev} cvmx_ilk_cal_entry_t; 1272079Siignatyev 1282079Siignatyev/** Callbacks structure to customize ILK initialization sequence */ 1292079Siignatyevtypedef struct 1302079Siignatyev{ 1312079Siignatyev /** Called to setup rx calendar */ 1322079Siignatyev int (*calendar_setup_rx) (int interface, int cal_depth, 1332079Siignatyev cvmx_ilk_cal_entry_t *pent, int hi_wm, 1342079Siignatyev unsigned char cal_ena); 1352079Siignatyev 1362079Siignatyev /** add more here */ 1372079Siignatyev} cvmx_ilk_callbacks_t; 1382079Siignatyev 1392079Siignatyevtypedef enum 1402079Siignatyev{ 1412079Siignatyev CVMX_ILK_LPBK_DISA = 0, 1422079Siignatyev CVMX_ILK_LPBK_ENA 1432079Siignatyev} cvmx_ilk_lpbk_ena_t; 1442079Siignatyev 1452079Siignatyevtypedef enum 1462079Siignatyev{ 1472079Siignatyev CVMX_ILK_LPBK_INT = 0, 1482079Siignatyev CVMX_ILK_LPBK_EXT 1492079Siignatyev} cvmx_ilk_lpbk_mode_t; 1502079Siignatyev 1512079Siignatyevextern void cvmx_ilk_get_callbacks(cvmx_ilk_callbacks_t * callbacks); 1522079Siignatyevextern void cvmx_ilk_set_callbacks(cvmx_ilk_callbacks_t * new_callbacks); 1532079Siignatyev 1542079Siignatyevextern int cvmx_ilk_start_interface (int interface, unsigned char num_lanes); 1552079Siignatyevextern int cvmx_ilk_set_pipe (int interface, int pipe_base, 1562079Siignatyev unsigned int pipe_len); 1572079Siignatyevextern int cvmx_ilk_tx_set_channel (int interface, cvmx_ilk_pipe_chan_t *pch, 1582079Siignatyev unsigned int num_chs); 1592079Siignatyevextern int cvmx_ilk_rx_set_pknd (int interface, cvmx_ilk_chan_pknd_t *chpknd, 1602079Siignatyev unsigned int num_pknd); 1612079Siignatyevextern int cvmx_ilk_calendar_setup_cb (int interface, int num_ports); 1622079Siignatyevextern int cvmx_ilk_calendar_sync_cb (int interface, int timeout); 1632079Siignatyevextern int cvmx_ilk_enable (int interface); 1642079Siignatyevextern int cvmx_ilk_disable (int interface); 1652079Siignatyevextern int cvmx_ilk_get_intf_ena (int interface); 1662079Siignatyevextern unsigned char cvmx_ilk_bit_count (unsigned char uc); 1672079Siignatyevextern unsigned char cvmx_ilk_get_intf_ln_msk (int interface); 1682079Siignatyevextern int cvmx_ilk_get_chan_info (int interface, unsigned char **chans, 1692079Siignatyev unsigned char *num_chan); 1702079Siignatyevextern void cvmx_ilk_show_stats (int interface, cvmx_ilk_stats_ctrl_t *pstats); 1712079Siignatyevextern int cvmx_ilk_cal_setup_rx (int interface, int cal_depth, 1722079Siignatyev cvmx_ilk_cal_entry_t *pent, int hi_wm, 1732079Siignatyev unsigned char cal_ena); 1742079Siignatyevextern int cvmx_ilk_cal_setup_tx (int interface, int cal_depth, 1752079Siignatyev cvmx_ilk_cal_entry_t *pent, 1762079Siignatyev unsigned char cal_ena); 1772079Siignatyevextern int cvmx_ilk_lpbk (int interface, cvmx_ilk_lpbk_ena_t enable, 1782079Siignatyev cvmx_ilk_lpbk_mode_t mode); 1792079Siignatyev#ifdef __cplusplus 1802079Siignatyev} 1812079Siignatyev#endif 1822079Siignatyev 1832079Siignatyev#endif /* __CVMX_ILK_H__ */ 1842079Siignatyev