sys/sys/clock.h

   1 /*-
   2  * Copyright (c) 1996 The NetBSD Foundation, Inc.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to The NetBSD Foundation
   6  * by Gordon W. Ross
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *        This product includes software developed by the NetBSD
  19  *        Foundation, Inc. and its contributors.
  20  * 4. Neither the name of The NetBSD Foundation nor the names of its
  21  *    contributors may be used to endorse or promote products derived
  22  *    from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  25  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  26  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  27  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  28  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  *
  36  *      $NetBSD: clock_subr.h,v 1.7 2000/10/03 13:41:07 tsutsui Exp $
  37  *
  38  *
  39  * This file is the central clearing-house for calendrical issues.
  40  *
  41  * In general the kernel does not know about minutes, hours, days, timezones,
  42  * daylight savings time, leap-years and such.  All that is theoretically a
  43  * matter for userland only.
  44  *
  45  * Parts of kernel code does however care: badly designed filesystems store
  46  * timestamps in local time and RTC chips sometimes track time in a local
  47  * timezone instead of UTC and so on.
  48  *
  49  * All that code should go here for service.
  50  *
  51  * $FreeBSD$
  52  */
  53
  54 #ifndef _SYS_CLOCK_H_
  55 #define _SYS_CLOCK_H_
  56
  57 #ifdef _KERNEL          /* No user serviceable parts */
  58
  59 /*
  60  * Timezone info from settimeofday(2), usually not used
  61  */
  62 extern int tz_minuteswest;
  63 extern int tz_dsttime;
  64
  65 int utc_offset(void);
  66
  67 /*
  68  * Structure to hold the values typically reported by time-of-day clocks.
  69  * This can be passed to the generic conversion functions to be converted
  70  * to a struct timespec.
  71  */
  72 struct clocktime {
  73         int     year;                   /* year (4 digit year) */
  74         int     mon;                    /* month (1 - 12) */
  75         int     day;                    /* day (1 - 31) */
  76         int     hour;                   /* hour (0 - 23) */
  77         int     min;                    /* minute (0 - 59) */
  78         int     sec;                    /* second (0 - 59) */
  79         int     dow;                    /* day of week (0 - 6; 0 = Sunday) */
  80         long    nsec;                   /* nano seconds */
  81 };
  82
  83 int clock_ct_to_ts(struct clocktime *, struct timespec *);
  84 void clock_ts_to_ct(struct timespec *, struct clocktime *);
  85 void clock_register(device_t, long);
  86
  87 /*
  88  * BCD to decimal and decimal to BCD.
  89  */
  90 #define FROMBCD(x)      bcd2bin(x)
  91 #define TOBCD(x)        bin2bcd(x)
  92
  93 /* Some handy constants. */
  94 #define SECDAY          (24 * 60 * 60)
  95 #define SECYR           (SECDAY * 365)
  96
  97 /* Traditional POSIX base year */
  98 #define POSIX_BASE_YEAR 1970
  99
 100 void timespec2fattime(struct timespec *tsp, int utc, u_int16_t *ddp, u_int16_t *dtp, u_int8_t *dhp);
 101 void fattime2timespec(unsigned dd, unsigned dt, unsigned dh, int utc, struct timespec *tsp);
 102
 103 #endif /* _KERNEL */
 104
 105 #endif /* !_SYS_CLOCK_H_ */