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

   1 /***********************license start***************
   2  *  Copyright (c) 2003-2008 Cavium Networks (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 Networks 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  *  TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
  24  *  AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
  25  *  OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
  26  *  RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
  27  *  REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
  28  *  DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
  29  *  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
  30  *  PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
  31  *  POSSESSION OR CORRESPONDENCE TO DESCRIPTION.  THE ENTIRE RISK ARISING OUT
  32  *  OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
  33  *
  34  *
  35  *  For any questions regarding licensing please contact marketing@caviumnetworks.com
  36  *
  37  ***********************license end**************************************/
  38
  39
  40
  41
  42
  43
  44 /**
  45  * @file
  46  *
  47  * Interface to the GMX hardware.
  48  *
  49  * <hr>$Revision: 41586 $<hr>
  50  */
  51
  52 #ifndef __CVMX_GMX_H__
  53 #define __CVMX_GMX_H__
  54
  55 #ifdef  __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 /* CSR typedefs have been moved to cvmx-csr-*.h */
  60
  61 /**
  62  * Disables the sending of flow control (pause) frames on the specified
  63  * RGMII port(s).
  64  *
  65  * @param interface Which interface (0 or 1)
  66  * @param port_mask Mask (4bits) of which ports on the interface to disable
  67  *                  backpressure on.
  68  *                  1 => disable backpressure
  69  *                  0 => enable backpressure
  70  *
  71  * @return 0 on success
  72  *         -1 on error
  73  */
  74
  75 static inline int cvmx_gmx_set_backpressure_override(uint32_t interface, uint32_t port_mask)
  76 {
  77     cvmx_gmxx_tx_ovr_bp_t gmxx_tx_ovr_bp;
  78     /* Check for valid arguments */
  79     if (port_mask & ~0xf || interface & ~0x1)
  80         return(-1);
  81     gmxx_tx_ovr_bp.u64 = 0;
  82     gmxx_tx_ovr_bp.s.en = port_mask; /* Per port Enable back pressure override */
  83     gmxx_tx_ovr_bp.s.ign_full = port_mask; /* Ignore the RX FIFO full when computing BP */
  84     cvmx_write_csr(CVMX_GMXX_TX_OVR_BP(interface), gmxx_tx_ovr_bp.u64);
  85     return(0);
  86
  87 }
  88
  89 #ifdef  __cplusplus
  90 }
  91 #endif
  92
  93 #endif
  94