4948f4b8d5
Executive is a library that can be used by standalone applications and kernels to abstract access to Octeon SoC and board-specific hardware and facilities. The FreeBSD port to Octeon will be updated to use this where possible.
167 lines
5.9 KiB
C
167 lines
5.9 KiB
C
/***********************license start***************
|
|
* Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights
|
|
* reserved.
|
|
*
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are
|
|
* met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* * Redistributions in binary form must reproduce the above
|
|
* copyright notice, this list of conditions and the following
|
|
* disclaimer in the documentation and/or other materials provided
|
|
* with the distribution.
|
|
*
|
|
* * Neither the name of Cavium Networks nor the names of
|
|
* its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written
|
|
* permission.
|
|
*
|
|
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
|
|
* AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
|
|
* OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
|
|
* RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
|
|
* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
|
|
* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
|
|
* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
|
|
* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
|
|
* POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT
|
|
* OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
|
|
*
|
|
*
|
|
* For any questions regarding licensing please contact marketing@caviumnetworks.com
|
|
*
|
|
***********************license end**************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* This module provides system/board information obtained by the bootloader.
|
|
*
|
|
* <hr>$Revision: 41586 $<hr>
|
|
*
|
|
*/
|
|
|
|
|
|
#ifndef __CVMX_SYSINFO_H__
|
|
#define __CVMX_SYSINFO_H__
|
|
|
|
#include "cvmx-app-init.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define OCTEON_SERIAL_LEN 20
|
|
/**
|
|
* Structure describing application specific information.
|
|
* __cvmx_app_init() populates this from the cvmx boot descriptor.
|
|
* This structure is private to simple executive applications, so
|
|
* no versioning is required.
|
|
*
|
|
* This structure must be provided with some fields set in order to use
|
|
* simple executive functions in other applications (Linux kernel, u-boot, etc.)
|
|
* The cvmx_sysinfo_minimal_initialize() function is provided to set the required values
|
|
* in these cases.
|
|
*
|
|
*
|
|
*/
|
|
typedef struct {
|
|
/* System wide variables */
|
|
uint64_t system_dram_size; /**< installed DRAM in system, in bytes */
|
|
void *phy_mem_desc_ptr; /**< ptr to memory descriptor block */
|
|
|
|
/* Application image specific variables */
|
|
uint64_t stack_top; /**< stack top address (virtual) */
|
|
uint64_t heap_base; /**< heap base address (virtual) */
|
|
uint32_t stack_size; /**< stack size in bytes */
|
|
uint32_t heap_size; /**< heap size in bytes */
|
|
uint32_t core_mask; /**< coremask defining cores running application */
|
|
uint32_t init_core; /**< Deprecated, use cvmx_coremask_first_core() to select init core */
|
|
uint64_t exception_base_addr; /**< exception base address, as set by bootloader */
|
|
uint32_t cpu_clock_hz; /**< cpu clock speed in hz */
|
|
uint32_t dram_data_rate_hz; /**< dram data rate in hz (data rate = 2 * clock rate */
|
|
|
|
uint16_t board_type;
|
|
uint8_t board_rev_major;
|
|
uint8_t board_rev_minor;
|
|
uint8_t mac_addr_base[6];
|
|
uint8_t mac_addr_count;
|
|
char board_serial_number[OCTEON_SERIAL_LEN];
|
|
/* Several boards support compact flash on the Octeon boot bus. The CF
|
|
** memory spaces may be mapped to different addresses on different boards.
|
|
** These values will be 0 if CF is not present.
|
|
** Note that these addresses are physical addresses, and it is up to the application
|
|
** to use the proper addressing mode (XKPHYS, KSEG0, etc.)*/
|
|
uint64_t compact_flash_common_base_addr;
|
|
uint64_t compact_flash_attribute_base_addr;
|
|
/* Base address of the LED display (as on EBT3000 board)
|
|
** This will be 0 if LED display not present.
|
|
** Note that this address is a physical address, and it is up to the application
|
|
** to use the proper addressing mode (XKPHYS, KSEG0, etc.)*/
|
|
uint64_t led_display_base_addr;
|
|
uint32_t dfa_ref_clock_hz; /**< DFA reference clock in hz (if applicable)*/
|
|
uint32_t bootloader_config_flags; /**< configuration flags from bootloader */
|
|
uint8_t console_uart_num; /** < Uart number used for console */
|
|
} cvmx_sysinfo_t;
|
|
|
|
|
|
/**
|
|
* This function returns the system/board information as obtained
|
|
* by the bootloader.
|
|
*
|
|
*
|
|
* @return Pointer to the boot information structure
|
|
*
|
|
*/
|
|
|
|
extern cvmx_sysinfo_t * cvmx_sysinfo_get(void);
|
|
|
|
|
|
/**
|
|
* This function is used in non-simple executive environments (such as Linux kernel, u-boot, etc.)
|
|
* to configure the minimal fields that are required to use
|
|
* simple executive files directly.
|
|
*
|
|
* Locking (if required) must be handled outside of this
|
|
* function
|
|
*
|
|
* @param phy_mem_desc_ptr
|
|
* Pointer to global physical memory descriptor (bootmem descriptor)
|
|
* @param board_type Octeon board type enumeration
|
|
*
|
|
* @param board_rev_major
|
|
* Board major revision
|
|
* @param board_rev_minor
|
|
* Board minor revision
|
|
* @param cpu_clock_hz
|
|
* CPU clock freqency in hertz
|
|
*
|
|
* @return 0: Failure
|
|
* 1: success
|
|
*/
|
|
extern int cvmx_sysinfo_minimal_initialize(void *phy_mem_desc_ptr, uint16_t board_type, uint8_t board_rev_major,
|
|
uint8_t board_rev_minor, uint32_t cpu_clock_hz);
|
|
|
|
#ifdef CVMX_BUILD_FOR_LINUX_USER
|
|
/**
|
|
* Initialize the sysinfo structure when running on
|
|
* Octeon under Linux userspace
|
|
*/
|
|
extern void cvmx_sysinfo_linux_userspace_initialize(void);
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __CVMX_SYSINFO_H__ */
|