freebsd-nq/sys/contrib/octeon-sdk/cvmx-rtc.h

163 lines
4.4 KiB
C
Raw Normal View History

/***********************license start***************
* Copyright (c) 2003-2010 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.
* This Software, including technical data, may be subject to U.S. export control
* laws, including the U.S. Export Administration Act and its associated
* regulations, and may be subject to export or import regulations in other
* countries.
* 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.
***********************license end**************************************/
/**
* @file
*
* This file provides support for real time clocks on some boards
*
* <hr>$Revision: 49448 $<hr>
*
*/
#ifndef __CVMX_RTC_H__
#define __CVMX_RTC_H__
#include "cvmx-sysinfo.h"
#include "cvmx-thunder.h"
#include "cvmx-cn3010-evb-hs5.h"
/**
* Supported RTC options
*/
typedef enum
{
CVMX_RTC_READ = 0x1, /**< Device supports read access */
CVMX_RTC_WRITE = 0x2, /**< Device supports write access */
CVMX_RTC_TIME_EPOCH = 0x10, /**< Time stored as seconds from epoch */
CVMX_RTC_TIME_CAL = 0x20, /**< Time stored as calendar */
} cvmx_rtc_options_t;
/**
* Return options supported by the RTC device
*
* @return Supported options, or 0 if RTC is not supported
*/
Update the port of FreeBSD to Cavium Octeon to use the Cavium Simple Executive library: o) Increase inline unit / large function growth limits for MIPS to accommodate the needs of the Simple Executive, which uses a shocking amount of inlining. o) Remove TARGET_OCTEON and use CPU_CNMIPS to do things required by cnMIPS and the Octeon SoC. o) Add OCTEON_VENDOR_LANNER to use Lanner's allocation of vendor-specific board numbers, specifically to support the MR320. o) Add OCTEON_BOARD_CAPK_0100ND to hard-wire configuration for the CAPK-0100nd, which improperly uses an evaluation board's board number and breaks board detection at runtime. This board is sold by Portwell as the CAM-0100. o) Add support for the RTC available on some Octeon boards. o) Add support for the Octeon PCI bus. Note that rman_[sg]et_virtual for IO ports can not work unless building for n64. o) Clean up the CompactFlash driver to use Simple Executive macros and structures where possible (it would be advisable to use the Simple Executive API to set the PIO mode, too, but that is not done presently.) Also use structures from FreeBSD's ATA layer rather than structures copied from Linux. o) Print available Octeon SoC features on boot. o) Add support for the Octeon timecounter. o) Use the Simple Executive's routines rather than local copies for doing reads and writes to 64-bit addresses and use its macros for various device addresses rather than using local copies. o) Rename octeon_board_real to octeon_is_simulation to reduce differences with Cavium-provided code originally written for Linux. Also make it use the same simplified test that the Simple Executive and Linux both use rather than our complex one. o) Add support for the Octeon CIU, which is the main interrupt unit, as a bus to use normal interrupt allocation and setup routines. o) Use the Simple Executive's bootmem facility to allocate physical memory for the kernel, rather than assuming we know which addresses we can steal. NB: This may reduce the amount of RAM the kernel reports you as having if you are leaving large temporary allocations made by U-Boot allocated when starting FreeBSD. o) Add a port of the Cavium-provided Ethernet driver for Linux. This changes Ethernet interface naming from rgmxN to octeN. The new driver has vast improvements over the old one, both in performance and functionality, but does still have some features which have not been ported entirely and there may be unimplemented code that can be hit in everyday use. I will make every effort to correct those as they are reported. o) Support loading the kernel on non-contiguous cores. o) Add very conservative support for harvesting randomness from the Octeon random number device. o) Turn SMP on by default. o) Clean up the style of the Octeon kernel configurations a little and make them compile with -march=octeon. o) Add support for the Lanner MR320 and the CAPK-0100nd to the Simple Executive. o) Modify the Simple Executive to build on FreeBSD and to build without executive-config.h or cvmx-config.h. In the future we may want to revert part of these changes and supply executive-config.h and cvmx-config.h and access to the options contained in those files via kernel configuration files. o) Modify the Simple Executive USB routines to support getting and setting of the USB PID.
2010-07-20 19:25:11 +00:00
static inline cvmx_rtc_options_t cvmx_rtc_supported(void)
{
static int supported = -1;
if (supported < 0) {
switch (cvmx_sysinfo_get()->board_type)
{
case CVMX_BOARD_TYPE_THUNDER:
supported = CVMX_RTC_READ | CVMX_RTC_WRITE | CVMX_RTC_TIME_EPOCH;
break;
case CVMX_BOARD_TYPE_EBH3000:
case CVMX_BOARD_TYPE_CN3010_EVB_HS5:
supported = CVMX_RTC_READ | CVMX_RTC_WRITE | CVMX_RTC_TIME_CAL;
break;
default:
supported = 0;
break;
}
#ifdef CVMX_RTC_DEBUG
cvmx_dprintf("Board type: %s, RTC support: 0x%x\n",
cvmx_board_type_to_string(cvmx_sysinfo_get()->board_type),
supported);
#endif
}
return (cvmx_rtc_options_t) supported;
}
/**
* Read time from RTC device.
*
* Time is expressed in seconds from epoch (Jan 1 1970 at 00:00:00 UTC)
*
* @return Time in seconds or 0 if RTC is not supported
*/
static inline uint32_t cvmx_rtc_read(void)
{
switch (cvmx_sysinfo_get()->board_type)
{
case CVMX_BOARD_TYPE_THUNDER:
return cvmx_rtc_ds1374_read();
break;
case CVMX_BOARD_TYPE_EBH3000:
case CVMX_BOARD_TYPE_CN3010_EVB_HS5:
return cvmx_rtc_ds1337_read();
break;
default:
return 0;
break;
}
}
/**
* Write time to the RTC device
*
* @param time Number of seconds from epoch (Jan 1 1970 at 00:00:00 UTC)
*
* @return Zero on success or device-specific error on failure.
*/
static inline uint32_t cvmx_rtc_write(uint32_t time)
{
switch (cvmx_sysinfo_get()->board_type)
{
case CVMX_BOARD_TYPE_THUNDER:
return cvmx_rtc_ds1374_write(time);
break;
case CVMX_BOARD_TYPE_EBH3000:
case CVMX_BOARD_TYPE_CN3010_EVB_HS5:
return cvmx_rtc_ds1337_write(time);
break;
default:
return 0;
break;
}
}
#endif /* __CVMX_RTC_H__ */