freebsd-skq/sys/contrib/octeon-sdk/cvmx-rtc.h
Juli Mallett 04b6fa8330 Merge Cavium Octeon SDK 2.0 Simple Executive; this brings some fixes and new
facilities as well as support for the Octeon 2 family of SoCs.

XXX Note that with our antediluvian assembler, we can't support some Octeon 2
    instructions and fall back to using the old ones instead.
2010-11-28 08:18:16 +00:00

163 lines
4.4 KiB
C

/***********************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
*/
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__ */