arch/mips/include/asm/octeon/cvmx-sysinfo.h

   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-2016 Cavium, Inc.
   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 /*
  29  * This module provides system/board information obtained by the bootloader.
  30  */
  31
  32 #ifndef __CVMX_SYSINFO_H__
  33 #define __CVMX_SYSINFO_H__
  34
  35 #include "cvmx-coremask.h"
  36
  37 #define OCTEON_SERIAL_LEN 20
  38 /**
  39  * Structure describing application specific information.
  40  * __cvmx_app_init() populates this from the cvmx boot descriptor.
  41  * This structure is private to simple executive applications, so
  42  * no versioning is required.
  43  *
  44  * This structure must be provided with some fields set in order to
  45  * use simple executive functions in other applications (Linux kernel,
  46  * u-boot, etc.)  The cvmx_sysinfo_minimal_initialize() function is
  47  * provided to set the required values in these cases.
  48  */
  49 struct cvmx_sysinfo {
  50         /* System wide variables */
  51         /* installed DRAM in system, in bytes */
  52         uint64_t system_dram_size;
  53
  54         /* ptr to memory descriptor block */
  55         uint64_t phy_mem_desc_addr;
  56
  57         /* Application image specific variables */
  58         /* stack top address (virtual) */
  59         uint64_t stack_top;
  60         /* heap base address (virtual) */
  61         uint64_t heap_base;
  62         /* stack size in bytes */
  63         uint32_t stack_size;
  64         /* heap size in bytes */
  65         uint32_t heap_size;
  66         /* coremask defining cores running application */
  67         struct cvmx_coremask core_mask;
  68         /* Deprecated, use cvmx_coremask_first_core() to select init core */
  69         uint32_t init_core;
  70
  71         /* exception base address, as set by bootloader */
  72         uint64_t exception_base_addr;
  73
  74         /* cpu clock speed in hz */
  75         uint32_t cpu_clock_hz;
  76
  77         /* dram data rate in hz (data rate = 2 * clock rate */
  78         uint32_t dram_data_rate_hz;
  79
  80
  81         uint16_t board_type;
  82         uint8_t board_rev_major;
  83         uint8_t board_rev_minor;
  84         uint8_t mac_addr_base[6];
  85         uint8_t mac_addr_count;
  86         char board_serial_number[OCTEON_SERIAL_LEN];
  87         /*
  88          * Several boards support compact flash on the Octeon boot
  89          * bus.  The CF memory spaces may be mapped to different
  90          * addresses on different boards.  These values will be 0 if
  91          * CF is not present.  Note that these addresses are physical
  92          * addresses, and it is up to the application to use the
  93          * proper addressing mode (XKPHYS, KSEG0, etc.)
  94          */
  95         uint64_t compact_flash_common_base_addr;
  96         uint64_t compact_flash_attribute_base_addr;
  97         /*
  98          * Base address of the LED display (as on EBT3000 board) This
  99          * will be 0 if LED display not present.  Note that this
 100          * address is a physical address, and it is up to the
 101          * application to use the proper addressing mode (XKPHYS,
 102          * KSEG0, etc.)
 103          */
 104         uint64_t led_display_base_addr;
 105         /* DFA reference clock in hz (if applicable)*/
 106         uint32_t dfa_ref_clock_hz;
 107         /* configuration flags from bootloader */
 108         uint32_t bootloader_config_flags;
 109
 110         /* Uart number used for console */
 111         uint8_t console_uart_num;
 112 };
 113
 114 /**
 115  * This function returns the system/board information as obtained
 116  * by the bootloader.
 117  *
 118  *
 119  * Returns  Pointer to the boot information structure
 120  *
 121  */
 122
 123 extern struct cvmx_sysinfo *cvmx_sysinfo_get(void);
 124
 125 #endif /* __CVMX_SYSINFO_H__ */