drivers/staging/octeon/cvmx-helper-spi.c

   1 /***********************license start***************
   2  * Author: Cavium Networks
   3  *
   4  * Contact: support@caviumnetworks.com
   5  * This file is part of the OCTEON SDK
   6  *
   7  * Copyright (c) 2003-2008 Cavium Networks
   8  *
   9  * This file is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License, Version 2, as
  11  * published by the Free Software Foundation.
  12  *
  13  * This file is distributed in the hope that it will be useful, but
  14  * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty
  15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
  16  * NONINFRINGEMENT.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this file; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  22  * or visit http://www.gnu.org/licenses/.
  23  *
  24  * This file may also be available under a different license from Cavium.
  25  * Contact Cavium Networks for more information
  26  ***********************license end**************************************/
  27
  28 void __cvmx_interrupt_gmxx_enable(int interface);
  29 void __cvmx_interrupt_spxx_int_msk_enable(int index);
  30 void __cvmx_interrupt_stxx_int_msk_enable(int index);
  31
  32 /*
  33  * Functions for SPI initialization, configuration,
  34  * and monitoring.
  35  */
  36 #include <asm/octeon/octeon.h>
  37
  38 #include "cvmx-config.h"
  39 #include "cvmx-spi.h"
  40 #include "cvmx-helper.h"
  41
  42 #include "cvmx-pip-defs.h"
  43 #include "cvmx-pko-defs.h"
  44
  45 /*
  46  * CVMX_HELPER_SPI_TIMEOUT is used to determine how long the SPI
  47  * initialization routines wait for SPI training. You can override the
  48  * value using executive-config.h if necessary.
  49  */
  50 #ifndef CVMX_HELPER_SPI_TIMEOUT
  51 #define CVMX_HELPER_SPI_TIMEOUT 10
  52 #endif
  53
  54 /**
  55  * Probe a SPI interface and determine the number of ports
  56  * connected to it. The SPI interface should still be down after
  57  * this call.
  58  *
  59  * @interface: Interface to probe
  60  *
  61  * Returns Number of ports on the interface. Zero to disable.
  62  */
  63 int __cvmx_helper_spi_probe(int interface)
  64 {
  65         int num_ports = 0;
  66
  67         if ((cvmx_sysinfo_get()->board_type != CVMX_BOARD_TYPE_SIM) &&
  68             cvmx_spi4000_is_present(interface)) {
  69                 num_ports = 10;
  70         } else {
  71                 union cvmx_pko_reg_crc_enable enable;
  72                 num_ports = 16;
  73                 /*
  74                  * Unlike the SPI4000, most SPI devices don't
  75                  * automatically put on the L2 CRC. For everything
  76                  * except for the SPI4000 have PKO append the L2 CRC
  77                  * to the packet.
  78                  */
  79                 enable.u64 = cvmx_read_csr(CVMX_PKO_REG_CRC_ENABLE);
  80                 enable.s.enable |= 0xffff << (interface * 16);
  81                 cvmx_write_csr(CVMX_PKO_REG_CRC_ENABLE, enable.u64);
  82         }
  83         __cvmx_helper_setup_gmx(interface, num_ports);
  84         return num_ports;
  85 }
  86
  87 /**
  88  * Bringup and enable a SPI interface. After this call packet I/O
  89  * should be fully functional. This is called with IPD enabled but
  90  * PKO disabled.
  91  *
  92  * @interface: Interface to bring up
  93  *
  94  * Returns Zero on success, negative on failure
  95  */
  96 int __cvmx_helper_spi_enable(int interface)
  97 {
  98         /*
  99          * Normally the ethernet L2 CRC is checked and stripped in the
 100          * GMX block.  When you are using SPI, this isn' the case and
 101          * IPD needs to check the L2 CRC.
 102          */
 103         int num_ports = cvmx_helper_ports_on_interface(interface);
 104         int ipd_port;
 105         for (ipd_port = interface * 16; ipd_port < interface * 16 + num_ports;
 106              ipd_port++) {
 107                 union cvmx_pip_prt_cfgx port_config;
 108                 port_config.u64 = cvmx_read_csr(CVMX_PIP_PRT_CFGX(ipd_port));
 109                 port_config.s.crc_en = 1;
 110                 cvmx_write_csr(CVMX_PIP_PRT_CFGX(ipd_port), port_config.u64);
 111         }
 112
 113         if (cvmx_sysinfo_get()->board_type != CVMX_BOARD_TYPE_SIM) {
 114                 cvmx_spi_start_interface(interface, CVMX_SPI_MODE_DUPLEX,
 115                                          CVMX_HELPER_SPI_TIMEOUT, num_ports);
 116                 if (cvmx_spi4000_is_present(interface))
 117                         cvmx_spi4000_initialize(interface);
 118         }
 119         __cvmx_interrupt_spxx_int_msk_enable(interface);
 120         __cvmx_interrupt_stxx_int_msk_enable(interface);
 121         __cvmx_interrupt_gmxx_enable(interface);
 122         return 0;
 123 }
 124
 125 /**
 126  * Return the link state of an IPD/PKO port as returned by
 127  * auto negotiation. The result of this function may not match
 128  * Octeon's link config if auto negotiation has changed since
 129  * the last call to cvmx_helper_link_set().
 130  *
 131  * @ipd_port: IPD/PKO port to query
 132  *
 133  * Returns Link state
 134  */
 135 cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port)
 136 {
 137         cvmx_helper_link_info_t result;
 138         int interface = cvmx_helper_get_interface_num(ipd_port);
 139         int index = cvmx_helper_get_interface_index_num(ipd_port);
 140         result.u64 = 0;
 141
 142         if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_SIM) {
 143                 /* The simulator gives you a simulated full duplex link */
 144                 result.s.link_up = 1;
 145                 result.s.full_duplex = 1;
 146                 result.s.speed = 10000;
 147         } else if (cvmx_spi4000_is_present(interface)) {
 148                 union cvmx_gmxx_rxx_rx_inbnd inband =
 149                     cvmx_spi4000_check_speed(interface, index);
 150                 result.s.link_up = inband.s.status;
 151                 result.s.full_duplex = inband.s.duplex;
 152                 switch (inband.s.speed) {
 153                 case 0: /* 10 Mbps */
 154                         result.s.speed = 10;
 155                         break;
 156                 case 1: /* 100 Mbps */
 157                         result.s.speed = 100;
 158                         break;
 159                 case 2: /* 1 Gbps */
 160                         result.s.speed = 1000;
 161                         break;
 162                 case 3: /* Illegal */
 163                         result.s.speed = 0;
 164                         result.s.link_up = 0;
 165                         break;
 166                 }
 167         } else {
 168                 /* For generic SPI we can't determine the link, just return some
 169                    sane results */
 170                 result.s.link_up = 1;
 171                 result.s.full_duplex = 1;
 172                 result.s.speed = 10000;
 173         }
 174         return result;
 175 }
 176
 177 /**
 178  * Configure an IPD/PKO port for the specified link state. This
 179  * function does not influence auto negotiation at the PHY level.
 180  * The passed link state must always match the link state returned
 181  * by cvmx_helper_link_get(). It is normally best to use
 182  * cvmx_helper_link_autoconf() instead.
 183  *
 184  * @ipd_port:  IPD/PKO port to configure
 185  * @link_info: The new link state
 186  *
 187  * Returns Zero on success, negative on failure
 188  */
 189 int __cvmx_helper_spi_link_set(int ipd_port, cvmx_helper_link_info_t link_info)
 190 {
 191         /* Nothing to do. If we have a SPI4000 then the setup was already performed
 192            by cvmx_spi4000_check_speed(). If not then there isn't any link
 193            info */
 194         return 0;
 195 }