1232809Sjmallett/***********************license start*************** 2232809Sjmallett * Copyright (c) 2003-2010 Cavium Inc. (support@cavium.com). All rights 3232809Sjmallett * reserved. 4232809Sjmallett * 5232809Sjmallett * 6232809Sjmallett * Redistribution and use in source and binary forms, with or without 7232809Sjmallett * modification, are permitted provided that the following conditions are 8232809Sjmallett * met: 9232809Sjmallett * 10232809Sjmallett * * Redistributions of source code must retain the above copyright 11232809Sjmallett * notice, this list of conditions and the following disclaimer. 12232809Sjmallett * 13232809Sjmallett * * Redistributions in binary form must reproduce the above 14232809Sjmallett * copyright notice, this list of conditions and the following 15232809Sjmallett * disclaimer in the documentation and/or other materials provided 16232809Sjmallett * with the distribution. 17232809Sjmallett 18232809Sjmallett * * Neither the name of Cavium Inc. nor the names of 19232809Sjmallett * its contributors may be used to endorse or promote products 20232809Sjmallett * derived from this software without specific prior written 21232809Sjmallett * permission. 22232809Sjmallett 23232809Sjmallett * This Software, including technical data, may be subject to U.S. export control 24232809Sjmallett * laws, including the U.S. Export Administration Act and its associated 25232809Sjmallett * regulations, and may be subject to export or import regulations in other 26232809Sjmallett * countries. 27232809Sjmallett 28232809Sjmallett * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 29232809Sjmallett * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR 30232809Sjmallett * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO 31232809Sjmallett * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR 32232809Sjmallett * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM 33232809Sjmallett * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE, 34232809Sjmallett * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF 35232809Sjmallett * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR 36232809Sjmallett * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR 37232809Sjmallett * PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 38232809Sjmallett ***********************license end**************************************/ 39232809Sjmallett 40232809Sjmallett/** 41232809Sjmallett * @file 42232809Sjmallett * 43232809Sjmallett * This file contains defines for the ILK interface 44232809Sjmallett 45232809Sjmallett * <hr>$Revision: 49448 $<hr> 46232809Sjmallett * 47232809Sjmallett * 48232809Sjmallett */ 49232809Sjmallett#ifndef __CVMX_ILK_H__ 50232809Sjmallett#define __CVMX_ILK_H__ 51232809Sjmallett 52232809Sjmallett#ifdef __cplusplus 53232809Sjmallettextern "C" { 54232809Sjmallett#endif 55232809Sjmallett 56232809Sjmallett/* CSR typedefs have been moved to cvmx-ilk-defs.h */ 57232809Sjmallett 58232809Sjmallett#define CVMX_ILK_GBL_BASE 5 59232809Sjmallett#define CVMX_ILK_QLM_BASE 1 60232809Sjmallett 61232809Sjmalletttypedef struct 62232809Sjmallett{ 63232809Sjmallett int intf_en : 8; 64232809Sjmallett int lane_en_mask : 8; 65232809Sjmallett int lane_speed : 16; 66232809Sjmallett /* add more here */ 67232809Sjmallett} cvmx_ilk_intf_t; 68232809Sjmallett 69232809Sjmallett#define CVMX_NUM_ILK_INTF 2 70232809Sjmallett#define CVMX_MAX_ILK_LANES 8 71232809Sjmallettextern unsigned char cvmx_ilk_lane_mask[CVMX_NUM_ILK_INTF]; 72232809Sjmallett 73232809Sjmalletttypedef struct 74232809Sjmallett{ 75232809Sjmallett unsigned int pipe; 76232809Sjmallett unsigned int chan; 77232809Sjmallett} cvmx_ilk_pipe_chan_t; 78232809Sjmallett 79232809Sjmallett#define CVMX_ILK_PIPE_BASE 72 80232809Sjmallett#define CVMX_MAX_ILK_PIPES 45 81232809Sjmallett#define CVMX_MAX_ILK_CHANS 8 82232809Sjmallettextern unsigned char cvmx_ilk_chans[CVMX_NUM_ILK_INTF]; 83232809Sjmallettextern unsigned char cvmx_ilk_chan_map[CVMX_NUM_ILK_INTF][CVMX_MAX_ILK_CHANS]; 84232809Sjmallett 85232809Sjmalletttypedef struct 86232809Sjmallett{ 87232809Sjmallett unsigned int chan; 88232809Sjmallett unsigned int pknd; 89232809Sjmallett} cvmx_ilk_chan_pknd_t; 90232809Sjmallett 91232809Sjmallett#define CVMX_ILK_PKND_BASE 20 92232809Sjmallett#define CVMX_MAX_ILK_PKNDS 8 /* must be <45 */ 93232809Sjmallett 94232809Sjmalletttypedef struct 95232809Sjmallett{ 96232809Sjmallett unsigned int *chan_list; /* for discrete channels. or, must be null */ 97232809Sjmallett unsigned int num_chans; 98232809Sjmallett 99232809Sjmallett unsigned int chan_start; /* for continuous channels */ 100232809Sjmallett unsigned int chan_end; 101232809Sjmallett unsigned int chan_step; 102232809Sjmallett 103232809Sjmallett unsigned int clr_on_rd; 104232809Sjmallett} cvmx_ilk_stats_ctrl_t; 105232809Sjmallett 106232809Sjmallett#define CVMX_ILK_MAX_CAL 288 107232809Sjmallett#define CVMX_ILK_TX_MIN_CAL 1 108232809Sjmallett#define CVMX_ILK_RX_MIN_CAL 1 109232809Sjmallett#define CVMX_ILK_CAL_GRP_SZ 8 110232809Sjmallett#define CVMX_ILK_PIPE_BPID_SZ 7 111232809Sjmallett#define CVMX_ILK_ENT_CTRL_SZ 2 112232809Sjmallett#define CVMX_ILK_RX_FIFO_WM 0x200 113232809Sjmallett 114232809Sjmalletttypedef enum 115232809Sjmallett{ 116232809Sjmallett PIPE_BPID = 0, 117232809Sjmallett LINK, 118232809Sjmallett XOFF, 119232809Sjmallett XON 120232809Sjmallett} cvmx_ilk_cal_ent_ctrl_t; 121232809Sjmallett 122232809Sjmalletttypedef struct 123232809Sjmallett{ 124232809Sjmallett unsigned char pipe_bpid; 125232809Sjmallett cvmx_ilk_cal_ent_ctrl_t ent_ctrl; 126232809Sjmallett} cvmx_ilk_cal_entry_t; 127232809Sjmallett 128232809Sjmallett/** Callbacks structure to customize ILK initialization sequence */ 129232809Sjmalletttypedef struct 130232809Sjmallett{ 131232809Sjmallett /** Called to setup rx calendar */ 132232809Sjmallett int (*calendar_setup_rx) (int interface, int cal_depth, 133232809Sjmallett cvmx_ilk_cal_entry_t *pent, int hi_wm, 134232809Sjmallett unsigned char cal_ena); 135232809Sjmallett 136232809Sjmallett /** add more here */ 137232809Sjmallett} cvmx_ilk_callbacks_t; 138232809Sjmallett 139232809Sjmalletttypedef enum 140232809Sjmallett{ 141232809Sjmallett CVMX_ILK_LPBK_DISA = 0, 142232809Sjmallett CVMX_ILK_LPBK_ENA 143232809Sjmallett} cvmx_ilk_lpbk_ena_t; 144232809Sjmallett 145232809Sjmalletttypedef enum 146232809Sjmallett{ 147232809Sjmallett CVMX_ILK_LPBK_INT = 0, 148232809Sjmallett CVMX_ILK_LPBK_EXT 149232809Sjmallett} cvmx_ilk_lpbk_mode_t; 150232809Sjmallett 151232809Sjmallettextern void cvmx_ilk_get_callbacks(cvmx_ilk_callbacks_t * callbacks); 152232809Sjmallettextern void cvmx_ilk_set_callbacks(cvmx_ilk_callbacks_t * new_callbacks); 153232809Sjmallett 154232809Sjmallettextern int cvmx_ilk_start_interface (int interface, unsigned char num_lanes); 155232809Sjmallettextern int cvmx_ilk_set_pipe (int interface, int pipe_base, 156232809Sjmallett unsigned int pipe_len); 157232809Sjmallettextern int cvmx_ilk_tx_set_channel (int interface, cvmx_ilk_pipe_chan_t *pch, 158232809Sjmallett unsigned int num_chs); 159232809Sjmallettextern int cvmx_ilk_rx_set_pknd (int interface, cvmx_ilk_chan_pknd_t *chpknd, 160232809Sjmallett unsigned int num_pknd); 161232809Sjmallettextern int cvmx_ilk_calendar_setup_cb (int interface, int num_ports); 162232809Sjmallettextern int cvmx_ilk_calendar_sync_cb (int interface, int timeout); 163232809Sjmallettextern int cvmx_ilk_enable (int interface); 164232809Sjmallettextern int cvmx_ilk_disable (int interface); 165232809Sjmallettextern int cvmx_ilk_get_intf_ena (int interface); 166232809Sjmallettextern unsigned char cvmx_ilk_bit_count (unsigned char uc); 167232809Sjmallettextern unsigned char cvmx_ilk_get_intf_ln_msk (int interface); 168232809Sjmallettextern int cvmx_ilk_get_chan_info (int interface, unsigned char **chans, 169232809Sjmallett unsigned char *num_chan); 170232809Sjmallettextern void cvmx_ilk_show_stats (int interface, cvmx_ilk_stats_ctrl_t *pstats); 171232809Sjmallettextern int cvmx_ilk_cal_setup_rx (int interface, int cal_depth, 172232809Sjmallett cvmx_ilk_cal_entry_t *pent, int hi_wm, 173232809Sjmallett unsigned char cal_ena); 174232809Sjmallettextern int cvmx_ilk_cal_setup_tx (int interface, int cal_depth, 175232809Sjmallett cvmx_ilk_cal_entry_t *pent, 176232809Sjmallett unsigned char cal_ena); 177232809Sjmallettextern int cvmx_ilk_lpbk (int interface, cvmx_ilk_lpbk_ena_t enable, 178232809Sjmallett cvmx_ilk_lpbk_mode_t mode); 179232809Sjmallett#ifdef __cplusplus 180232809Sjmallett} 181232809Sjmallett#endif 182232809Sjmallett 183232809Sjmallett#endif /* __CVMX_ILK_H__ */ 184