Return to clock_subr.h CVS log

Up to [local] / sys / dev

Annotation of sys/dev/clock_subr.h, Revision 1.1

1.1     ! nbrk        1: /*     $OpenBSD: clock_subr.h,v 1.4 2006/06/19 15:13:35 deraadt Exp $  */
        !             2: /*     $NetBSD: clock_subr.h,v 1.2 1997/03/15 18:11:17 is Exp $        */
        !             3:
        !             4: /*-
        !             5:  * Copyright (c) 1996 The NetBSD Foundation, Inc.
        !             6:  * All rights reserved.
        !             7:  *
        !             8:  * This code is derived from software contributed to The NetBSD Foundation
        !             9:  * by Gordon W. Ross
        !            10:  *
        !            11:  * Redistribution and use in source and binary forms, with or without
        !            12:  * modification, are permitted provided that the following conditions
        !            13:  * are met:
        !            14:  * 1. Redistributions of source code must retain the above copyright
        !            15:  *    notice, this list of conditions and the following disclaimer.
        !            16:  * 2. Redistributions in binary form must reproduce the above copyright
        !            17:  *    notice, this list of conditions and the following disclaimer in the
        !            18:  *    documentation and/or other materials provided with the distribution.
        !            19:  * 3. All advertising materials mentioning features or use of this software
        !            20:  *    must display the following acknowledgement:
        !            21:  *        This product includes software developed by the NetBSD
        !            22:  *        Foundation, Inc. and its contributors.
        !            23:  * 4. Neither the name of The NetBSD Foundation nor the names of its
        !            24:  *    contributors may be used to endorse or promote products derived
        !            25:  *    from this software without specific prior written permission.
        !            26:  *
        !            27:  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
        !            28:  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
        !            29:  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
        !            30:  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
        !            31:  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
        !            32:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        !            33:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        !            34:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        !            35:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
        !            36:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        !            37:  * POSSIBILITY OF SUCH DAMAGE.
        !            38:  */
        !            39:
        !            40: /*
        !            41:  * Interface to time-of-day clock devices.
        !            42:  *
        !            43:  * todr_gettime: convert time-of-day clock into a `struct timeval'
        !            44:  * todr_settime: set time-of-day clock from a `struct timeval'
        !            45:  * todr_getcal: get current TOD clock calibration value in ppm
        !            46:  * todr_setcal: set calibration value in ppm in TOD clock
        !            47:  *
        !            48:  * (this is probably not so useful:)
        !            49:  * todr_setwen: provide a machine-dependent TOD clock write-enable callback
        !            50:  *              function which takes one boolean argument:
        !            51:  *                      1 to enable writes; 0 to disable writes.
        !            52:  */
        !            53: struct todr_chip_handle {
        !            54:        void    *cookie;        /* Device specific data */
        !            55:        void    *bus_cookie;    /* Bus specific data */
        !            56:
        !            57:        int     (*todr_gettime)(struct todr_chip_handle *, struct timeval *);
        !            58:        int     (*todr_settime)(struct todr_chip_handle *, struct timeval *);
        !            59:        int     (*todr_getcal)(struct todr_chip_handle *, int *);
        !            60:        int     (*todr_setcal)(struct todr_chip_handle *, int);
        !            61:        int     (*todr_setwen)(struct todr_chip_handle *, int);
        !            62: };
        !            63: typedef struct todr_chip_handle *todr_chip_handle_t;
        !            64:
        !            65: #define todr_gettime(ct, t)    ((*(ct)->todr_gettime)(ct, t))
        !            66: #define todr_settime(ct, t)    ((*(ct)->todr_settime)(ct, t))
        !            67: #define todr_getcal(ct, vp)    ((*(ct)->todr_gettime)(ct, vp))
        !            68: #define todr_setcal(ct, v)     ((*(ct)->todr_settime)(ct, v))
        !            69: #define todr_wenable(ct, v)    if ((ct)->todr_setwen) \
        !            70:                                        ((*(ct)->todr_setwen)(ct, v))
        !            71: