freebsd-dev/sys/i386/include/clock.h

/*-
 * Kernel interface to machine-dependent clock driver.
 * Garrett Wollman, September 1994.
 * This file is in the public domain.
 *
 * $FreeBSD$
 */

#ifndef _MACHINE_CLOCK_H_
#define	_MACHINE_CLOCK_H_

#ifdef _KERNEL
/*
 * i386 to clock driver interface.
 * XXX large parts of the driver and its interface are misplaced.
 */
extern int	adjkerntz;
extern int	clkintr_pending;
extern int	disable_rtc_set;
extern int	pscnt;
extern int	psdiv;
extern int	statclock_disable;
extern u_int	timer_freq;
extern int	timer0_max_count;
extern uint64_t	tsc_freq;
extern int	tsc_is_broken;
extern int	wall_cmos_clock;

/*
 * Driver to clock driver interface.
 */
struct clockframe;

int	acquire_timer2(int mode);
int	release_timer2(void);
#ifndef PC98
int	rtcin(int val);
#else
int	acquire_timer1(int mode);
int	release_timer1(void);
#endif
#ifndef BURN_BRIDGES
int	acquire_timer0(int rate, void (*function)(struct clockframe *frame));
int	release_timer0(void);
#endif
int	sysbeep(int pitch, int period);
void	timer_restore(void);
void	init_TSC(void);
void	init_TSC_tc(void);

#endif /* _KERNEL */

#endif /* !_MACHINE_CLOCK_H_ */
/* -> /*- for copyright notices, minor format tweaks as necessary 2005-01-06 22:18:23 +00:00			`/*-`
Redo Kernel NTP PLL support, kernel side. This code is mostly taken from the 1.1 port (which was in turn taken from Dave Mills's kern.tar.Z example). A few significant differences: 1) ntp_gettime() is now a MIB variable rather than a system call. A few fiddles are done in libc to make it behave the same. 2) mono_time does not participate in the PLL adjustments. 3) A new interface has been defined (in <machine/clock.h>) for doing possibly machine-dependent things around the time of the clock update. This is used in Pentium kernels to disable interrupts, set `time', and reset the CPU cycle counter as quickly as possible to avoid jitter in microtime(). Measurements show an apparent resolution of a bit more than 8.14usec, which is reasonable given system-call overhead. 1994-09-18 20:40:01 +00:00			`* Kernel interface to machine-dependent clock driver.`
			`* Garrett Wollman, September 1994.`
			`* This file is in the public domain.`
Fix Pentium CPU rate diagnosis: - Don't print out meaningless iCOMP numbers, those are for droids. - Use a shorter wait to determine clock rate to avoid deficiencies in DELAY(). - Use a fixed-point representation with 8 bits of fraction to store the rate and rationalize the variable name. It would be possible to use even more fraction if it turns out to be worthwhile (I rather doubt it). The question of source code arrangement remains unaddressed. 1995-11-29 19:57:22 +00:00			`*`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`* $FreeBSD$`
Redo Kernel NTP PLL support, kernel side. This code is mostly taken from the 1.1 port (which was in turn taken from Dave Mills's kern.tar.Z example). A few significant differences: 1) ntp_gettime() is now a MIB variable rather than a system call. A few fiddles are done in libc to make it behave the same. 2) mono_time does not participate in the PLL adjustments. 3) A new interface has been defined (in <machine/clock.h>) for doing possibly machine-dependent things around the time of the clock update. This is used in Pentium kernels to disable interrupts, set `time', and reset the CPU cycle counter as quickly as possible to avoid jitter in microtime(). Measurements show an apparent resolution of a bit more than 8.14usec, which is reasonable given system-call overhead. 1994-09-18 20:40:01 +00:00			`*/`

			`#ifndef _MACHINE_CLOCK_H_`
Declare the full uglyness of the interfaces to the clock driver (except things declared in machine-independent files). 1994-11-05 22:51:17 +00:00			`#define _MACHINE_CLOCK_H_`
Redo Kernel NTP PLL support, kernel side. This code is mostly taken from the 1.1 port (which was in turn taken from Dave Mills's kern.tar.Z example). A few significant differences: 1) ntp_gettime() is now a MIB variable rather than a system call. A few fiddles are done in libc to make it behave the same. 2) mono_time does not participate in the PLL adjustments. 3) A new interface has been defined (in <machine/clock.h>) for doing possibly machine-dependent things around the time of the clock update. This is used in Pentium kernels to disable interrupts, set `time', and reset the CPU cycle counter as quickly as possible to avoid jitter in microtime(). Measurements show an apparent resolution of a bit more than 8.14usec, which is reasonable given system-call overhead. 1994-09-18 20:40:01 +00:00
Change #ifdef KERNEL to #ifdef _KERNEL in the public headers. "KERNEL" is an application space macro and the applications are supposed to be free to use it as they please (but cannot). This is consistant with the other BSD's who made this change quite some time ago. More commits to come. 1999-12-29 04:46:21 +00:00			`#ifdef _KERNEL`
Declare the full uglyness of the interfaces to the clock driver (except things declared in machine-independent files). 1994-11-05 22:51:17 +00:00			`/*`
			`* i386 to clock driver interface.`
Removed vestiges of previous microtime() implementation. 1998-02-25 02:20:30 +00:00			`* XXX large parts of the driver and its interface are misplaced.`
Declare the full uglyness of the interfaces to the clock driver (except things declared in machine-independent files). 1994-11-05 22:51:17 +00:00			`*/`
			`extern int adjkerntz;`
- Move manipulation of td_intr_nesting_level out of assembly interrupt vector stubs and into the C functions they call. - Move disabling and EOIing of interrupt sources out of PIC driver entry points and into intr_execute_handlers(). Intr_execute_handlers() only disables a source for an interrupt if it is a stray interrupt or has threaded handlers. Sources with fast handlers no longer disable (mask) the source while executing the handlers. - Move the setting of clkintr_pending into intr_execute_handlers() and set the variable for any interrupt source with a vector of 0. (Should only be true for IRQ 0.) This fixes clkintr_pending in the NO_MIXED_MODE case. - Implement lapic_eoi() and use it to implement ioapic_eoi_source(). - Rename atpic_sched_ithd() to atpic_handle_intr() since it is used to handle all atpic interrupts and not just threaded ones. Inspired by: peter's changes to amd64 in p4 (1) Requested by: bde (2) 2003-11-12 18:13:57 +00:00			`extern int clkintr_pending;`
Declare the full uglyness of the interfaces to the clock driver (except things declared in machine-independent files). 1994-11-05 22:51:17 +00:00			`extern int disable_rtc_set;`
Split statclock into statclock and profclock, and made the method for driving statclock based on profhz when profiling is enabled MD, since most platforms don't use this anyway. This removes the need for statclock_process, whose only purpose was to subdivide profhz, and gets the profiling clock running outside of sched_lock on platforms that implement suswintr. Also changed the interface for starting and stopping the profiling clock to do just that, instead of changing the rate of statclock, since they can now be separate. Reviewed by: jhb, tmm Tested on: i386, sparc64 2003-02-03 17:53:15 +00:00			`extern int pscnt;`
			`extern int psdiv;`
wash, sort and put in order various nits from the i586_ctr -> tsc commit. Pointed out by: bde 1997-12-28 13:36:09 +00:00			`extern int statclock_disable;`
			`extern u_int timer_freq;`
			`extern int timer0_max_count;`
Make tsc_freq a 64bit quantity. Inspired by: http://www.theinquirer.net/?article=7481 2003-01-29 11:36:39 +00:00			`extern uint64_t tsc_freq;`
Stop the TSC from being used as timecounter on K5/step0 machines. 1999-05-29 06:57:55 +00:00			`extern int tsc_is_broken;`
Added missing extern declaration of timer_freq. Sorted declarations of scalars. 1996-10-17 17:31:25 +00:00			`extern int wall_cmos_clock;`
Declare the full uglyness of the interfaces to the clock driver (except things declared in machine-independent files). 1994-11-05 22:51:17 +00:00
			`/*`
			`* Driver to clock driver interface.`
			`*/`
Improved biasing of i586 clock by adjusting for hardclock() latency. I decided to do this for every hardclock() call instead of lazily in microtime(). The lazy method is simpler but has more overhead if microtime() is called a lot. CPU_THISTICKLEN() is now a no-op and should probably go away. Previously it did nothing directly but had the side effect of setting i586_last_tick for CPU_CLOCKUPDATE() and i586_avg_tick for debugging. CPU_CLOCKUPDATE() now uses a better method and i586_avg_tick is too much trouble to maintain. Reduced nesting of #includes in the usual case. Increased nesting of #includes when CLOCK_HAIR is defined. This is a kludge to get typedefs for inline functions only when the inline functions are used. Normally only kern_clock.c defines this. kern_clock.c can't include the i386 headers directly. Removed unused LOCORE support. 1996-10-25 13:01:56 +00:00			`struct clockframe;`

Remove __P. 2002-03-20 05:48:58 +00:00			`int acquire_timer2(int mode);`
			`int release_timer2(void);`
The Great PC98 Merge. All new code is "#ifdef PC98"ed so this should make no difference to PC/AT (and its clones) users. Ok'd by: core Submitted by: FreeBSD(98) development team 1996-06-14 11:02:28 +00:00			`#ifndef PC98`
Remove __P. 2002-03-20 05:48:58 +00:00			`int rtcin(int val);`
The Great PC98 Merge. All new code is "#ifdef PC98"ed so this should make no difference to PC/AT (and its clones) users. Ok'd by: core Submitted by: FreeBSD(98) development team 1996-06-14 11:02:28 +00:00			`#else`
Remove __P. 2002-03-20 05:48:58 +00:00			`int acquire_timer1(int mode);`
			`int release_timer1(void);`
The Great PC98 Merge. All new code is "#ifdef PC98"ed so this should make no difference to PC/AT (and its clones) users. Ok'd by: core Submitted by: FreeBSD(98) development team 1996-06-14 11:02:28 +00:00			`#endif`
Per TRB vote: restore the aquire_timer0 and associated goo. This will be gone in FreeBSD 6, so put BURN_BRIDGES around it. The TRB also felt that if something better comes along sooner, it can be used to replace this code. Delayed by: BSDcon and subsequent disk crash. 2003-09-24 15:33:33 +00:00			`#ifndef BURN_BRIDGES`
			`int acquire_timer0(int rate, void (function)(struct clockframe frame));`
			`int release_timer0(void);`
			`#endif`
Remove __P. 2002-03-20 05:48:58 +00:00			`int sysbeep(int pitch, int period);`
			`void timer_restore(void);`
i386/i386/tsc.c was repo-copied from i386/isa/clock.c. Remove all the stuff that does not relate to the TSC. Change the calibration to use DELAY(1000000) rather than trying to check it against the CMOS RTC, this drastically increases precision: Using 25 samples on a Athlon 700MHz UP machine I find: stddev min max average CMOS 22200 Hz -74980 Hz 34301 Hz 704928721 Hz DELAY 1805 Hz -1984 Hz 2678 Hz 704937583 Hz (The difference between the two averages is not statistically significant.) expressed in PPM of the frequency: stddev min max CMOS 31.49 PPM -106.37 PPM 48.66 PPM DELAY 2.56 PPM 2.81 PPM 3.80 PPM This code will not be used until a followup commit to sys/isa/clock.c and sys/pc98/pc98/clock.c which will only happen after some field testing. 2003-02-05 09:20:40 +00:00			`void init_TSC(void);`
Dont initialize a TSC timecounter until we know if it is broken or not. 2003-08-06 15:05:27 +00:00			`void init_TSC_tc(void);`
Declare the full uglyness of the interfaces to the clock driver (except things declared in machine-independent files). 1994-11-05 22:51:17 +00:00
Change #ifdef KERNEL to #ifdef _KERNEL in the public headers. "KERNEL" is an application space macro and the applications are supposed to be free to use it as they please (but cannot). This is consistant with the other BSD's who made this change quite some time ago. More commits to come. 1999-12-29 04:46:21 +00:00			`#endif /* _KERNEL */`
Declare the full uglyness of the interfaces to the clock driver (except things declared in machine-independent files). 1994-11-05 22:51:17 +00:00
			`#endif /* !_MACHINE_CLOCK_H_ */`