sys/contrib/octeon-sdk/cvmx-gmx.h

   1 /***********************license start***************
   2  * Copyright (c) 2003-2010  Cavium Inc. (support@cavium.com). All rights
   3  * reserved.
   4  *
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met:
   9  *
  10  *   * Redistributions of source code must retain the above copyright
  11  *     notice, this list of conditions and the following disclaimer.
  12  *
  13  *   * Redistributions in binary form must reproduce the above
  14  *     copyright notice, this list of conditions and the following
  15  *     disclaimer in the documentation and/or other materials provided
  16  *     with the distribution.
  17
  18  *   * Neither the name of Cavium Inc. nor the names of
  19  *     its contributors may be used to endorse or promote products
  20  *     derived from this software without specific prior written
  21  *     permission.
  22
  23  * This Software, including technical data, may be subject to U.S. export  control
  24  * laws, including the U.S. Export Administration Act and its  associated
  25  * regulations, and may be subject to export or import  regulations in other
  26  * countries.
  27
  28  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
  29  * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
  30  * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
  31  * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
  32  * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
  33  * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
  34  * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
  35  * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
  36  * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK ARISING OUT OF USE OR
  37  * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
  38  ***********************license end**************************************/
  39
  40
  41
  42
  43
  44
  45
  46 /**
  47  * @file
  48  *
  49  * Interface to the GMX hardware.
  50  *
  51  * <hr>$Revision: 70030 $<hr>
  52  */
  53
  54 #ifndef __CVMX_GMX_H__
  55 #define __CVMX_GMX_H__
  56
  57 #ifdef  __cplusplus
  58 extern "C" {
  59 #endif
  60
  61 /* CSR typedefs have been moved to cvmx-gmx-defs.h */
  62
  63 /**
  64  * Disables the sending of flow control (pause) frames on the specified
  65  * RGMII port(s).
  66  *
  67  * @param interface Which interface (0 or 1)
  68  * @param port_mask Mask (4bits) of which ports on the interface to disable
  69  *                  backpressure on.
  70  *                  1 => disable backpressure
  71  *                  0 => enable backpressure
  72  *
  73  * @return 0 on success
  74  *         -1 on error
  75  */
  76
  77 static inline int cvmx_gmx_set_backpressure_override(uint32_t interface, uint32_t port_mask)
  78 {
  79     cvmx_gmxx_tx_ovr_bp_t gmxx_tx_ovr_bp;
  80     /* Check for valid arguments */
  81     if (port_mask & ~0xf || interface & ~0x1)
  82         return(-1);
  83     gmxx_tx_ovr_bp.u64 = 0;
  84     gmxx_tx_ovr_bp.s.en = port_mask; /* Per port Enable back pressure override */
  85     gmxx_tx_ovr_bp.s.ign_full = port_mask; /* Ignore the RX FIFO full when computing BP */
  86     cvmx_write_csr(CVMX_GMXX_TX_OVR_BP(interface), gmxx_tx_ovr_bp.u64);
  87     return(0);
  88
  89 }
  90
  91 #ifdef  __cplusplus
  92 }
  93 #endif
  94
  95 #endif
  96