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 /* 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 #define OCTEON_SERIAL_LEN 20 36 /** 37 * Structure describing application specific information. 38 * __cvmx_app_init() populates this from the cvmx boot descriptor. 39 * This structure is private to simple executive applications, so 40 * no versioning is required. 41 * 42 * This structure must be provided with some fields set in order to 43 * use simple executive functions in other applications (Linux kernel, 44 * u-boot, etc.) The cvmx_sysinfo_minimal_initialize() function is 45 * provided to set the required values in these cases. 46 */ 47 struct cvmx_sysinfo { 48 /* System wide variables */ 49 /* installed DRAM in system, in bytes */ 50 uint64_t system_dram_size; 51 52 /* ptr to memory descriptor block */ 53 void *phy_mem_desc_ptr; 54 55 56 /* Application image specific variables */ 57 /* stack top address (virtual) */ 58 uint64_t stack_top; 59 /* heap base address (virtual) */ 60 uint64_t heap_base; 61 /* stack size in bytes */ 62 uint32_t stack_size; 63 /* heap size in bytes */ 64 uint32_t heap_size; 65 /* coremask defining cores running application */ 66 uint32_t core_mask; 67 /* Deprecated, use cvmx_coremask_first_core() to select init core */ 68 uint32_t init_core; 69 70 /* exception base address, as set by bootloader */ 71 uint64_t exception_base_addr; 72 73 /* cpu clock speed in hz */ 74 uint32_t cpu_clock_hz; 75 76 /* dram data rate in hz (data rate = 2 * clock rate */ 77 uint32_t dram_data_rate_hz; 78 79 80 uint16_t board_type; 81 uint8_t board_rev_major; 82 uint8_t board_rev_minor; 83 uint8_t mac_addr_base[6]; 84 uint8_t mac_addr_count; 85 char board_serial_number[OCTEON_SERIAL_LEN]; 86 /* 87 * Several boards support compact flash on the Octeon boot 88 * bus. The CF memory spaces may be mapped to different 89 * addresses on different boards. These values will be 0 if 90 * CF is not present. Note that these addresses are physical 91 * addresses, and it is up to the application to use the 92 * proper addressing mode (XKPHYS, KSEG0, etc.) 93 */ 94 uint64_t compact_flash_common_base_addr; 95 uint64_t compact_flash_attribute_base_addr; 96 /* 97 * Base address of the LED display (as on EBT3000 board) This 98 * will be 0 if LED display not present. Note that this 99 * address is a physical address, and it is up to the 100 * application to use the proper addressing mode (XKPHYS, 101 * KSEG0, etc.) 102 */ 103 uint64_t led_display_base_addr; 104 /* DFA reference clock in hz (if applicable)*/ 105 uint32_t dfa_ref_clock_hz; 106 /* configuration flags from bootloader */ 107 uint32_t bootloader_config_flags; 108 109 /* Uart number used for console */ 110 uint8_t console_uart_num; 111 }; 112 113 /** 114 * This function returns the system/board information as obtained 115 * by the bootloader. 116 * 117 * 118 * Returns Pointer to the boot information structure 119 * 120 */ 121 122 extern struct cvmx_sysinfo *cvmx_sysinfo_get(void); 123 124 /** 125 * This function is used in non-simple executive environments (such as 126 * Linux kernel, u-boot, etc.) to configure the minimal fields that 127 * are required to use simple executive files directly. 128 * 129 * Locking (if required) must be handled outside of this 130 * function 131 * 132 * @phy_mem_desc_ptr: Pointer to global physical memory descriptor 133 * (bootmem descriptor) @board_type: Octeon board 134 * type enumeration 135 * 136 * @board_rev_major: 137 * Board major revision 138 * @board_rev_minor: 139 * Board minor revision 140 * @cpu_clock_hz: 141 * CPU clock freqency in hertz 142 * 143 * Returns 0: Failure 144 * 1: success 145 */ 146 extern int cvmx_sysinfo_minimal_initialize(void *phy_mem_desc_ptr, 147 uint16_t board_type, 148 uint8_t board_rev_major, 149 uint8_t board_rev_minor, 150 uint32_t cpu_clock_hz); 151 152 #endif /* __CVMX_SYSINFO_H__ */ 153