1210284Sjmallett/***********************license start*************** 2215990Sjmallett * Copyright (c) 2003-2010 Cavium Networks (support@cavium.com). All rights 3215990Sjmallett * reserved. 4210284Sjmallett * 5210284Sjmallett * 6215990Sjmallett * Redistribution and use in source and binary forms, with or without 7215990Sjmallett * modification, are permitted provided that the following conditions are 8215990Sjmallett * met: 9210284Sjmallett * 10215990Sjmallett * * Redistributions of source code must retain the above copyright 11215990Sjmallett * notice, this list of conditions and the following disclaimer. 12210284Sjmallett * 13215990Sjmallett * * Redistributions in binary form must reproduce the above 14215990Sjmallett * copyright notice, this list of conditions and the following 15215990Sjmallett * disclaimer in the documentation and/or other materials provided 16215990Sjmallett * with the distribution. 17210284Sjmallett 18215990Sjmallett * * Neither the name of Cavium Networks nor the names of 19215990Sjmallett * its contributors may be used to endorse or promote products 20215990Sjmallett * derived from this software without specific prior written 21215990Sjmallett * permission. 22210284Sjmallett 23215990Sjmallett * This Software, including technical data, may be subject to U.S. export control 24215990Sjmallett * laws, including the U.S. Export Administration Act and its associated 25215990Sjmallett * regulations, and may be subject to export or import regulations in other 26215990Sjmallett * countries. 27210284Sjmallett 28215990Sjmallett * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 29215990Sjmallett * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS OR 30215990Sjmallett * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO 31215990Sjmallett * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR 32215990Sjmallett * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM 33215990Sjmallett * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE, 34215990Sjmallett * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF 35215990Sjmallett * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR 36215990Sjmallett * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR 37215990Sjmallett * PERFORMANCE OF THE SOFTWARE LIES WITH YOU. 38215990Sjmallett ***********************license end**************************************/ 39210284Sjmallett 40210284Sjmallett 41210284Sjmallett/** 42210284Sjmallett * @file 43210284Sjmallett * 44210284Sjmallett * This module provides system/board information obtained by the bootloader. 45210284Sjmallett * 46215990Sjmallett * <hr>$Revision: 49448 $<hr> 47210284Sjmallett * 48210284Sjmallett */ 49210284Sjmallett 50210284Sjmallett 51210284Sjmallett#ifndef __CVMX_SYSINFO_H__ 52210284Sjmallett#define __CVMX_SYSINFO_H__ 53210284Sjmallett 54215990Sjmallett#ifndef CVMX_BUILD_FOR_LINUX_KERNEL 55210284Sjmallett#include "cvmx-app-init.h" 56215990Sjmallett#endif 57210284Sjmallett 58210284Sjmallett#ifdef __cplusplus 59210284Sjmallettextern "C" { 60210284Sjmallett#endif 61210284Sjmallett 62210284Sjmallett#define OCTEON_SERIAL_LEN 20 63210284Sjmallett/** 64210284Sjmallett * Structure describing application specific information. 65210284Sjmallett * __cvmx_app_init() populates this from the cvmx boot descriptor. 66215990Sjmallett * This structure is private to simple executive applications, so no 67215990Sjmallett * versioning is required. 68210284Sjmallett * 69215990Sjmallett * This structure must be provided with some fields set in order to 70215990Sjmallett * use simple executive functions in other applications (Linux kernel, 71215990Sjmallett * u-boot, etc.) The cvmx_sysinfo_minimal_initialize() function is 72215990Sjmallett * provided to set the required values in these cases. 73210284Sjmallett * 74210284Sjmallett */ 75215990Sjmallettstruct cvmx_sysinfo { 76215990Sjmallett /* System wide variables */ 77215990Sjmallett uint64_t system_dram_size; /**< installed DRAM in system, in bytes */ 78215990Sjmallett uint64_t phy_mem_desc_addr; /**< Address of the memory descriptor block */ 79210284Sjmallett 80215990Sjmallett /* Application image specific variables */ 81215990Sjmallett uint64_t stack_top; /**< stack top address (virtual) */ 82215990Sjmallett uint64_t heap_base; /**< heap base address (virtual) */ 83215990Sjmallett uint32_t stack_size; /**< stack size in bytes */ 84215990Sjmallett uint32_t heap_size; /**< heap size in bytes */ 85215990Sjmallett uint32_t core_mask; /**< coremask defining cores running application */ 86215990Sjmallett uint32_t init_core; /**< Deprecated, use cvmx_coremask_first_core() to select init core */ 87215990Sjmallett uint64_t exception_base_addr; /**< exception base address, as set by bootloader */ 88215990Sjmallett uint32_t cpu_clock_hz; /**< cpu clock speed in hz */ 89215990Sjmallett uint32_t dram_data_rate_hz; /**< dram data rate in hz (data rate = 2 * clock rate */ 90210284Sjmallett 91215990Sjmallett uint16_t board_type; 92215990Sjmallett uint8_t board_rev_major; 93215990Sjmallett uint8_t board_rev_minor; 94215990Sjmallett uint8_t mac_addr_base[6]; 95215990Sjmallett uint8_t mac_addr_count; 96215990Sjmallett char board_serial_number[OCTEON_SERIAL_LEN]; 97215990Sjmallett /* 98215990Sjmallett * Several boards support compact flash on the Octeon boot 99215990Sjmallett * bus. The CF memory spaces may be mapped to different 100215990Sjmallett * addresses on different boards. These values will be 0 if 101215990Sjmallett * CF is not present. Note that these addresses are physical 102215990Sjmallett * addresses, and it is up to the application to use the 103215990Sjmallett * proper addressing mode (XKPHYS, KSEG0, etc.) 104215990Sjmallett */ 105215990Sjmallett uint64_t compact_flash_common_base_addr; 106215990Sjmallett uint64_t compact_flash_attribute_base_addr; 107215990Sjmallett /* 108215990Sjmallett * Base address of the LED display (as on EBT3000 board) This 109215990Sjmallett * will be 0 if LED display not present. Note that this 110215990Sjmallett * address is a physical address, and it is up to the 111215990Sjmallett * application to use the proper addressing mode (XKPHYS, 112215990Sjmallett * KSEG0, etc.) 113215990Sjmallett */ 114215990Sjmallett uint64_t led_display_base_addr; 115215990Sjmallett uint32_t dfa_ref_clock_hz; /**< DFA reference clock in hz (if applicable)*/ 116215990Sjmallett uint32_t bootloader_config_flags; /**< configuration flags from bootloader */ 117215990Sjmallett uint8_t console_uart_num; /** < Uart number used for console */ 118215990Sjmallett}; 119210284Sjmallett 120215990Sjmallett#ifndef CVMX_BUILD_FOR_LINUX_KERNEL 121215990Sjmalletttypedef struct cvmx_sysinfo cvmx_sysinfo_t; 122215990Sjmallett#endif 123210284Sjmallett 124210284Sjmallett/** 125210284Sjmallett * This function returns the system/board information as obtained 126210284Sjmallett * by the bootloader. 127210284Sjmallett * 128210284Sjmallett * 129210284Sjmallett * @return Pointer to the boot information structure 130210284Sjmallett * 131210284Sjmallett */ 132210284Sjmallett 133215990Sjmallettextern struct cvmx_sysinfo *cvmx_sysinfo_get(void); 134210284Sjmallett 135215990Sjmallett#ifndef CVMX_BUILD_FOR_LINUX_KERNEL 136210284Sjmallett/** 137210284Sjmallett * This function is used in non-simple executive environments (such as Linux kernel, u-boot, etc.) 138210284Sjmallett * to configure the minimal fields that are required to use 139210284Sjmallett * simple executive files directly. 140210284Sjmallett * 141210284Sjmallett * Locking (if required) must be handled outside of this 142210284Sjmallett * function 143210284Sjmallett * 144215990Sjmallett * @param phy_mem_desc_addr 145215990Sjmallett * Address of the global physical memory descriptor (bootmem 146215990Sjmallett * descriptor) 147210284Sjmallett * @param board_type Octeon board type enumeration 148210284Sjmallett * 149210284Sjmallett * @param board_rev_major 150210284Sjmallett * Board major revision 151210284Sjmallett * @param board_rev_minor 152210284Sjmallett * Board minor revision 153210284Sjmallett * @param cpu_clock_hz 154210284Sjmallett * CPU clock freqency in hertz 155210284Sjmallett * 156210284Sjmallett * @return 0: Failure 157210284Sjmallett * 1: success 158210284Sjmallett */ 159215990Sjmallettextern int cvmx_sysinfo_minimal_initialize(uint64_t phy_mem_desc_addr, uint16_t board_type, uint8_t board_rev_major, 160210284Sjmallett uint8_t board_rev_minor, uint32_t cpu_clock_hz); 161215990Sjmallett#endif 162210284Sjmallett 163210284Sjmallett#ifdef CVMX_BUILD_FOR_LINUX_USER 164210284Sjmallett/** 165210284Sjmallett * Initialize the sysinfo structure when running on 166210284Sjmallett * Octeon under Linux userspace 167210284Sjmallett */ 168210284Sjmallettextern void cvmx_sysinfo_linux_userspace_initialize(void); 169210284Sjmallett#endif 170210284Sjmallett 171210284Sjmallett#ifdef __cplusplus 172210284Sjmallett} 173210284Sjmallett#endif 174210284Sjmallett 175210284Sjmallett#endif /* __CVMX_SYSINFO_H__ */ 176