cvmx-helper-spi.c revision 210311 
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 * Functions for SPI initialization, configuration,
48 * and monitoring.
49 *
50 * <hr>$Revision: 42417 $<hr>
51 */
52#include "cvmx.h"
53#include "cvmx-spi.h"
54#include "cvmx-sysinfo.h"
55#include "cvmx-helper.h"
56
57#ifdef CVMX_ENABLE_PKO_FUNCTIONS
58/* CVMX_HELPER_SPI_TIMEOUT is used to determine how long the SPI initialization
59    routines wait for SPI training. You can override the value using
60    executive-config.h if necessary */
61#ifndef CVMX_HELPER_SPI_TIMEOUT
62#define CVMX_HELPER_SPI_TIMEOUT 10
63#endif
64
65
66/**
67 * @INTERNAL
68 * Probe a SPI interface and determine the number of ports
69 * connected to it. The SPI interface should still be down after
70 * this call.
71 *
72 * @param interface Interface to probe
73 *
74 * @return Number of ports on the interface. Zero to disable.
75 */
76int __cvmx_helper_spi_probe(int interface)
77{
78    int num_ports = 0;
79
80    if ((cvmx_sysinfo_get()->board_type != CVMX_BOARD_TYPE_SIM) &&
81        cvmx_spi4000_is_present(interface))
82    {
83        num_ports = 10;
84    }
85    else
86    {
87        cvmx_pko_reg_crc_enable_t enable;
88        num_ports = 16;
89        /* Unlike the SPI4000, most SPI devices don't automatically
90            put on the L2 CRC. For everything except for the SPI4000
91            have PKO append the L2 CRC to the packet */
92        enable.u64 = cvmx_read_csr(CVMX_PKO_REG_CRC_ENABLE);
93        enable.s.enable |= 0xffff << (interface*16);
94        cvmx_write_csr(CVMX_PKO_REG_CRC_ENABLE, enable.u64);
95    }
96    __cvmx_helper_setup_gmx(interface, num_ports);
97    return num_ports;
98}
99
100
101/**
102 * @INTERNAL
103 * Bringup and enable a SPI interface. After this call packet I/O
104 * should be fully functional. This is called with IPD enabled but
105 * PKO disabled.
106 *
107 * @param interface Interface to bring up
108 *
109 * @return Zero on success, negative on failure
110 */
111int __cvmx_helper_spi_enable(int interface)
112{
113    /* Normally the ethernet L2 CRC is checked and stripped in the GMX block.
114        When you are using SPI, this isn' the case and IPD needs to check
115        the L2 CRC */
116    int num_ports = cvmx_helper_ports_on_interface(interface);
117    int ipd_port;
118    for (ipd_port=interface*16; ipd_port<interface*16+num_ports; ipd_port++)
119    {
120        cvmx_pip_port_cfg_t port_config;
121        port_config.u64 = cvmx_read_csr(CVMX_PIP_PRT_CFGX(ipd_port));
122        port_config.s.crc_en = 1;
123        cvmx_write_csr(CVMX_PIP_PRT_CFGX(ipd_port), port_config.u64);
124    }
125
126    if (cvmx_sysinfo_get()->board_type != CVMX_BOARD_TYPE_SIM)
127    {
128        cvmx_spi_start_interface(interface, CVMX_SPI_MODE_DUPLEX, CVMX_HELPER_SPI_TIMEOUT, num_ports);
129        if (cvmx_spi4000_is_present(interface))
130            cvmx_spi4000_initialize(interface);
131    }
132    return 0;
133}
134
135/**
136 * @INTERNAL
137 * Return the link state of an IPD/PKO port as returned by
138 * auto negotiation. The result of this function may not match
139 * Octeon's link config if auto negotiation has changed since
140 * the last call to cvmx_helper_link_set().
141 *
142 * @param ipd_port IPD/PKO port to query
143 *
144 * @return Link state
145 */
146cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port)
147{
148    cvmx_helper_link_info_t result;
149    int interface = cvmx_helper_get_interface_num(ipd_port);
150    int index = cvmx_helper_get_interface_index_num(ipd_port);
151    result.u64 = 0;
152
153    if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_SIM)
154    {
155        /* The simulator gives you a simulated full duplex link */
156        result.s.link_up = 1;
157        result.s.full_duplex = 1;
158        result.s.speed = 10000;
159    }
160    else if (cvmx_spi4000_is_present(interface))
161    {
162        cvmx_gmxx_rxx_rx_inbnd_t inband = cvmx_spi4000_check_speed(interface, index);
163        result.s.link_up = inband.s.status;
164        result.s.full_duplex = inband.s.duplex;
165        switch (inband.s.speed)
166        {
167            case 0: /* 10 Mbps */
168                result.s.speed = 10;
169                break;
170            case 1: /* 100 Mbps */
171                result.s.speed = 100;
172                break;
173            case 2: /* 1 Gbps */
174                result.s.speed = 1000;
175                break;
176            case 3: /* Illegal */
177                result.s.speed = 0;
178                result.s.link_up = 0;
179                break;
180        }
181    }
182    else
183    {
184        /* For generic SPI we can't determine the link, just return some
185            sane results */
186        result.s.link_up = 1;
187        result.s.full_duplex = 1;
188        result.s.speed = 10000;
189    }
190    return result;
191}
192
193
194/**
195 * @INTERNAL
196 * Configure an IPD/PKO port for the specified link state. This
197 * function does not influence auto negotiation at the PHY level.
198 * The passed link state must always match the link state returned
199 * by cvmx_helper_link_get(). It is normally best to use
200 * cvmx_helper_link_autoconf() instead.
201 *
202 * @param ipd_port  IPD/PKO port to configure
203 * @param link_info The new link state
204 *
205 * @return Zero on success, negative on failure
206 */
207int __cvmx_helper_spi_link_set(int ipd_port, cvmx_helper_link_info_t link_info)
208{
209    /* Nothing to do. If we have a SPI4000 then the setup was already performed
210        by cvmx_spi4000_check_speed(). If not then there isn't any link
211        info */
212    return 0;
213}
214
215#endif /* CVMX_ENABLE_PKO_FUNCTIONS */
216
217