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 * File defining functions for working with different Octeon
50 * models.
51 *
52 * <hr>$Revision: 70030 $<hr>
53 */
54#ifdef CVMX_BUILD_FOR_LINUX_KERNEL
55#include <asm/octeon/octeon.h>
56#include <asm/octeon/cvmx-clock.h>
57#else
58#include "cvmx.h"
59#include "cvmx-pow.h"
60#include "cvmx-warn.h"
61#endif
62
63#if defined(CVMX_BUILD_FOR_LINUX_USER) || defined(CVMX_BUILD_FOR_STANDALONE) || defined(CVMX_BUILD_FOR_FREEBSD_KERNEL)
64#if !defined(CVMX_BUILD_FOR_FREEBSD_KERNEL)
65#include <octeon-app-init.h>
66#endif
67#include "cvmx-sysinfo.h"
68
69/**
70 * This function checks to see if the software is compatible with the
71 * chip it is running on.  This is called in the application startup code
72 * and does not need to be called directly by the application.
73 * Does not return if software is incompatible, unless compiled for the
74 * FreeBSD kernel, in which case it returns -1.
75 *
76 * @param chip_id chip id that the software is being run on.
77 *
78 * @return 0: runtime checking or exact version match
79 *         1: chip is newer revision than compiled for, but software will run properly.
80 *        -1: software is incompatible
81 */
82int octeon_model_version_check(uint32_t chip_id __attribute__ ((unused)))
83{
84    //printf("Model Number: %s\n", octeon_model_get_string(chip_id));
85#if !OCTEON_IS_COMMON_BINARY()
86    /* Check for special case of mismarked 3005 samples, and adjust cpuid */
87    if (chip_id == OCTEON_CN3010_PASS1 && (cvmx_read_csr(0x80011800800007B8ull) & (1ull << 34)))
88        chip_id |= 0x10;
89
90    if ((OCTEON_MODEL & 0xffffff) != chip_id)
91    {
92        if (!OCTEON_IS_MODEL((OM_IGNORE_REVISION | chip_id)) || (OCTEON_MODEL & 0xffffff) > chip_id || (((OCTEON_MODEL & 0xffffff) ^ chip_id) & 0x10))
93        {
94            printf("ERROR: Software not configured for this chip\n"
95                   "         Expecting ID=0x%08x, Chip is 0x%08x\n", (OCTEON_MODEL & 0xffffff), (unsigned int)chip_id);
96            if ((OCTEON_MODEL & 0xffffff) > chip_id)
97                printf("Refusing to run on older revision than program was compiled for.\n");
98#if !defined(CVMX_BUILD_FOR_FREEBSD_KERNEL)
99	    exit(-1);
100#else
101	    return(-1);
102#endif
103        }
104        else
105        {
106            printf("\n###################################################\n");
107            printf("WARNING: Software configured for older revision than running on.\n"
108                   "         Compiled for ID=0x%08x, Chip is 0x%08x\n", (OCTEON_MODEL & 0xffffff), (unsigned int)chip_id);
109            printf("###################################################\n\n");
110            return(1);
111        }
112    }
113#endif
114
115    cvmx_warn_if(CVMX_ENABLE_PARAMETER_CHECKING, "Parameter checks are enabled. Expect some performance loss due to the extra checking\n");
116    cvmx_warn_if(CVMX_ENABLE_CSR_ADDRESS_CHECKING, "CSR address checks are enabled. Expect some performance loss due to the extra checking\n");
117    cvmx_warn_if(CVMX_ENABLE_POW_CHECKS, "POW state checks are enabled. Expect some performance loss due to the extra checking\n");
118
119    return(0);
120}
121
122#endif
123/**
124 * Given the chip processor ID from COP0, this function returns a
125 * string representing the chip model number. The string is of the
126 * form CNXXXXpX.X-FREQ-SUFFIX.
127 * - XXXX = The chip model number
128 * - X.X = Chip pass number
129 * - FREQ = Current frequency in Mhz
130 * - SUFFIX = NSP, EXP, SCP, SSP, or CP
131 *
132 * @param chip_id Chip ID
133 *
134 * @return Model string
135 */
136const char *octeon_model_get_string(uint32_t chip_id)
137{
138    static char         buffer[32];
139    return octeon_model_get_string_buffer(chip_id,buffer);
140}
141
142/* Version of octeon_model_get_string() that takes buffer as argument, as
143** running early in u-boot static/global variables don't work when running from
144** flash
145*/
146const char *octeon_model_get_string_buffer(uint32_t chip_id, char * buffer)
147{
148    const char *        family;
149    const char *        core_model;
150    char                pass[4];
151#ifndef CVMX_BUILD_FOR_UBOOT
152    int                 clock_mhz;
153#endif
154    const char *        suffix;
155    cvmx_l2d_fus3_t     fus3;
156    int                 num_cores;
157    cvmx_mio_fus_dat2_t fus_dat2;
158    cvmx_mio_fus_dat3_t fus_dat3;
159    char fuse_model[10];
160    uint32_t fuse_data = 0;
161
162    fus3.u64 = 0;
163    if (OCTEON_IS_MODEL(OCTEON_CN3XXX) || OCTEON_IS_MODEL(OCTEON_CN5XXX))
164        fus3.u64 = cvmx_read_csr(CVMX_L2D_FUS3);
165    fus_dat2.u64 = cvmx_read_csr(CVMX_MIO_FUS_DAT2);
166    fus_dat3.u64 = cvmx_read_csr(CVMX_MIO_FUS_DAT3);
167    num_cores = cvmx_pop(cvmx_read_csr(CVMX_CIU_FUSE));
168
169    /* Make sure the non existent devices look disabled */
170    switch ((chip_id >> 8) & 0xff)
171    {
172        case 6: /* CN50XX */
173        case 2: /* CN30XX */
174            fus_dat3.s.nodfa_dte = 1;
175            fus_dat3.s.nozip = 1;
176            break;
177        case 4: /* CN57XX or CN56XX */
178            fus_dat3.s.nodfa_dte = 1;
179            break;
180        default:
181            break;
182    }
183
184    /* Make a guess at the suffix */
185    /* NSP = everything */
186    /* EXP = No crypto */
187    /* SCP = No DFA, No zip */
188    /* CP = No DFA, No crypto, No zip */
189    if (fus_dat3.s.nodfa_dte)
190    {
191        if (fus_dat2.s.nocrypto)
192            suffix = "CP";
193        else
194            suffix = "SCP";
195    }
196    else if (fus_dat2.s.nocrypto)
197        suffix = "EXP";
198    else
199        suffix = "NSP";
200
201    /* Assume pass number is encoded using <5:3><2:0>. Exceptions will be
202        fixed later */
203    sprintf(pass, "%d.%d", (int)((chip_id>>3)&7)+1, (int)chip_id&7);
204
205    /* Use the number of cores to determine the last 2 digits of the model
206        number. There are some exceptions that are fixed later */
207    switch (num_cores)
208    {
209        case 32: core_model = "80"; break;
210        case 24: core_model = "70"; break;
211        case 16: core_model = "60"; break;
212        case 15: core_model = "58"; break;
213        case 14: core_model = "55"; break;
214        case 13: core_model = "52"; break;
215        case 12: core_model = "50"; break;
216        case 11: core_model = "48"; break;
217        case 10: core_model = "45"; break;
218        case  9: core_model = "42"; break;
219        case  8: core_model = "40"; break;
220        case  7: core_model = "38"; break;
221        case  6: core_model = "34"; break;
222        case  5: core_model = "32"; break;
223        case  4: core_model = "30"; break;
224        case  3: core_model = "25"; break;
225        case  2: core_model = "20"; break;
226        case  1: core_model = "10"; break;
227        default: core_model = "XX"; break;
228    }
229
230    /* Now figure out the family, the first two digits */
231    switch ((chip_id >> 8) & 0xff)
232    {
233        case 0: /* CN38XX, CN37XX or CN36XX */
234            if (fus3.cn38xx.crip_512k)
235            {
236                /* For some unknown reason, the 16 core one is called 37 instead of 36 */
237                if (num_cores >= 16)
238                    family = "37";
239                else
240                    family = "36";
241            }
242            else
243                family = "38";
244            /* This series of chips didn't follow the standard pass numbering */
245            switch (chip_id & 0xf)
246            {
247                case 0: strcpy(pass, "1.X"); break;
248                case 1: strcpy(pass, "2.X"); break;
249                case 3: strcpy(pass, "3.X"); break;
250                default:strcpy(pass, "X.X"); break;
251            }
252            break;
253        case 1: /* CN31XX or CN3020 */
254            if ((chip_id & 0x10) || fus3.cn31xx.crip_128k)
255                family = "30";
256            else
257                family = "31";
258            /* This series of chips didn't follow the standard pass numbering */
259            switch (chip_id & 0xf)
260            {
261                case 0: strcpy(pass, "1.0"); break;
262                case 2: strcpy(pass, "1.1"); break;
263                default:strcpy(pass, "X.X"); break;
264            }
265            break;
266        case 2: /* CN3010 or CN3005 */
267            family = "30";
268            /* A chip with half cache is an 05 */
269            if (fus3.cn30xx.crip_64k)
270                core_model = "05";
271            /* This series of chips didn't follow the standard pass numbering */
272            switch (chip_id & 0xf)
273            {
274                case 0: strcpy(pass, "1.0"); break;
275                case 2: strcpy(pass, "1.1"); break;
276                default:strcpy(pass, "X.X"); break;
277            }
278            break;
279        case 3: /* CN58XX */
280            family = "58";
281            /* Special case. 4 core, half cache (CP with half cache) */
282            if ((num_cores == 4) && fus3.cn58xx.crip_1024k && !strncmp(suffix, "CP", 2))
283                core_model = "29";
284
285            /* Pass 1 uses different encodings for pass numbers */
286            if ((chip_id & 0xFF)< 0x8)
287            {
288                switch (chip_id & 0x3)
289                {
290                    case 0: strcpy(pass, "1.0"); break;
291                    case 1: strcpy(pass, "1.1"); break;
292                    case 3: strcpy(pass, "1.2"); break;
293                    default:strcpy(pass, "1.X"); break;
294                }
295            }
296            break;
297        case 4: /* CN57XX, CN56XX, CN55XX, CN54XX */
298            if (fus_dat2.cn56xx.raid_en)
299            {
300                if (fus3.cn56xx.crip_1024k)
301                    family = "55";
302                else
303                    family = "57";
304                if (fus_dat2.cn56xx.nocrypto)
305                    suffix = "SP";
306                else
307                    suffix = "SSP";
308            }
309            else
310            {
311                if (fus_dat2.cn56xx.nocrypto)
312                    suffix = "CP";
313                else
314                {
315                    suffix = "NSP";
316                    if (fus_dat3.s.nozip)
317                        suffix = "SCP";
318
319                    if (fus_dat3.s.bar2_en)
320                        suffix = "NSPB2";
321                }
322                if (fus3.cn56xx.crip_1024k)
323                    family = "54";
324                else
325                    family = "56";
326            }
327            break;
328        case 6: /* CN50XX */
329            family = "50";
330            break;
331        case 7: /* CN52XX */
332            if (fus3.cn52xx.crip_256k)
333                family = "51";
334            else
335                family = "52";
336            break;
337	case 0x93: /* CN61XX */
338            family = "61";
339            if (fus_dat3.cn61xx.nozip)
340                suffix = "SCP";
341            else
342                suffix = "AAP";
343            break;
344	case 0x90: /* CN63XX */
345            family = "63";
346            if (fus_dat3.s.l2c_crip == 2)
347                family = "62";
348            if (num_cores == 6)  /* Other core counts match generic */
349                core_model = "35";
350            if (fus_dat2.cn63xx.nocrypto)
351                suffix = "CP";
352            else if (fus_dat2.cn63xx.dorm_crypto)
353                suffix = "DAP";
354            else if (fus_dat3.cn63xx.nozip)
355                suffix = "SCP";
356            else
357                suffix = "AAP";
358            break;
359	case 0x92: /* CN66XX */
360            family = "66";
361            if (num_cores == 6)  /* Other core counts match generic */
362                core_model = "35";
363            if (fus_dat2.cn66xx.nocrypto && fus_dat2.cn66xx.dorm_crypto)
364                suffix = "AP";
365            if (fus_dat2.cn66xx.nocrypto)
366                suffix = "CP";
367            else if (fus_dat2.cn66xx.dorm_crypto)
368                suffix = "DAP";
369            else if (fus_dat3.cn66xx.nozip && fus_dat2.cn66xx.raid_en)
370                suffix = "SCP";
371            else if (!fus_dat2.cn66xx.raid_en)
372                suffix = "HAP";
373            else
374                suffix = "AAP";
375            break;
376        case 0x91: /* CN68XX */
377            family = "68";
378            if (fus_dat2.cn68xx.nocrypto && fus_dat3.cn68xx.nozip)
379                suffix = "CP";
380            else if (fus_dat2.cn68xx.dorm_crypto)
381                suffix = "DAP";
382            else if (fus_dat3.cn68xx.nozip)
383                suffix = "SCP";
384            else if (fus_dat2.cn68xx.nocrypto)
385                suffix = "SP";
386            else if (!fus_dat2.cn68xx.raid_en)
387                suffix = "HAP";
388            else
389                suffix = "AAP";
390            break;
391	case 0x94: /* CNF71XX */
392            family = "F71";
393            if (fus_dat3.cnf71xx.nozip)
394                suffix = "SCP";
395            else
396                suffix = "AAP";
397            break;
398        default:
399            family = "XX";
400            core_model = "XX";
401            strcpy(pass, "X.X");
402            suffix = "XXX";
403            break;
404    }
405
406#ifndef CVMX_BUILD_FOR_UBOOT
407    clock_mhz = cvmx_clock_get_rate(CVMX_CLOCK_RCLK) / 1000000;
408#endif
409
410    if (family[0] != '3')
411    {
412        int fuse_base = 384/8;
413        if (family[0] == '6')
414            fuse_base = 832/8;
415
416        /* Check for model in fuses, overrides normal decode */
417        /* This is _not_ valid for Octeon CN3XXX models */
418        fuse_data |= cvmx_fuse_read_byte(fuse_base + 3);
419        fuse_data = fuse_data << 8;
420        fuse_data |= cvmx_fuse_read_byte(fuse_base + 2);
421        fuse_data = fuse_data << 8;
422        fuse_data |= cvmx_fuse_read_byte(fuse_base + 1);
423        fuse_data = fuse_data << 8;
424        fuse_data |= cvmx_fuse_read_byte(fuse_base);
425        if (fuse_data & 0x7ffff)
426        {
427            int model = fuse_data & 0x3fff;
428            int suffix = (fuse_data >> 14) & 0x1f;
429            if (suffix && model)  /* Have both number and suffix in fuses, so both */
430            {
431                sprintf(fuse_model, "%d%c",model, 'A' + suffix - 1);
432                core_model = "";
433                family = fuse_model;
434            }
435            else if (suffix && !model)   /* Only have suffix, so add suffix to 'normal' model number */
436            {
437                sprintf(fuse_model, "%s%c", core_model, 'A' + suffix - 1);
438                core_model = fuse_model;
439            }
440            else /* Don't have suffix, so just use model from fuses */
441            {
442                sprintf(fuse_model, "%d",model);
443                core_model = "";
444                family = fuse_model;
445            }
446        }
447    }
448#ifdef CVMX_BUILD_FOR_UBOOT
449    sprintf(buffer, "CN%s%s-%s pass %s", family, core_model, suffix, pass);
450#else
451    sprintf(buffer, "CN%s%sp%s-%d-%s", family, core_model, pass, clock_mhz, suffix);
452#endif
453    return buffer;
454}
455