[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / asm-mips / time.h
blobe22a2066587160d519892bdc3797b8abf3ba91c1
1 /*
2 * Copyright (C) 2001, 2002, MontaVista Software Inc.
3 * Author: Jun Sun, jsun@mvista.com or jsun@junsun.net
4 * Copyright (c) 2003 Maciej W. Rozycki
6 * include/asm-mips/time.h
7 * header file for the new style time.c file and time services.
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2 of the License, or (at your
12 * option) any later version.
14 * Please refer to Documentation/mips/time.README.
16 #ifndef _ASM_TIME_H
17 #define _ASM_TIME_H
19 #include <linux/interrupt.h>
20 #include <linux/linkage.h>
21 #include <linux/ptrace.h>
22 #include <linux/rtc.h>
25 * RTC ops. By default, they point to no-RTC functions.
26 * rtc_get_time - mktime(year, mon, day, hour, min, sec) in seconds.
27 * rtc_set_time - reverse the above translation and set time to RTC.
28 * rtc_set_mmss - similar to rtc_set_time, but only min and sec need
29 * to be set. Used by RTC sync-up.
31 extern unsigned long (*rtc_get_time)(void);
32 extern int (*rtc_set_time)(unsigned long);
33 extern int (*rtc_set_mmss)(unsigned long);
36 * Timer interrupt functions.
37 * mips_timer_state is needed for high precision timer calibration.
38 * mips_timer_ack may be NULL if the interrupt is self-recoverable.
40 extern int (*mips_timer_state)(void);
41 extern void (*mips_timer_ack)(void);
44 * High precision timer functions.
45 * If mips_hpt_read is NULL, an R4k-compatible timer setup is attempted.
47 extern unsigned int (*mips_hpt_read)(void);
48 extern void (*mips_hpt_init)(unsigned int);
51 * to_tm() converts system time back to (year, mon, day, hour, min, sec).
52 * It is intended to help implement rtc_set_time() functions.
53 * Copied from PPC implementation.
55 extern void to_tm(unsigned long tim, struct rtc_time *tm);
58 * do_gettimeoffset(). By default, this func pointer points to
59 * do_null_gettimeoffset(), which leads to the same resolution as HZ.
60 * Higher resolution versions are available, which give ~1us resolution.
62 extern unsigned long (*do_gettimeoffset)(void);
65 * high-level timer interrupt routines.
67 extern irqreturn_t timer_interrupt(int irq, void *dev_id, struct pt_regs *regs);
70 * the corresponding low-level timer interrupt routine.
72 extern asmlinkage void ll_timer_interrupt(int irq, struct pt_regs *regs);
75 * profiling and process accouting is done separately in local_timer_interrupt
77 extern void local_timer_interrupt(int irq, void *dev_id, struct pt_regs *regs);
78 extern asmlinkage void ll_local_timer_interrupt(int irq, struct pt_regs *regs);
81 * board specific routines required by time_init().
82 * board_time_init is defaulted to NULL and can remain so.
83 * board_timer_setup must be setup properly in machine setup routine.
85 struct irqaction;
86 extern void (*board_time_init)(void);
87 extern void (*board_timer_setup)(struct irqaction *irq);
90 * mips_hpt_frequency - must be set if you intend to use an R4k-compatible
91 * counter as a timer interrupt source; otherwise it can be set up
92 * automagically with an aid of mips_timer_state.
94 extern unsigned int mips_hpt_frequency;
96 #endif /* _ASM_TIME_H */