1 /* $OpenBSD: clock_subr.h,v 1.8 2022/10/12 13:39:50 kettenis 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 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * Interface to time-of-day clock devices. 35 * 36 * todr_gettime: convert time-of-day clock into a `struct timeval' 37 * todr_settime: set time-of-day clock from a `struct timeval' 38 * 39 * (this is probably not so useful:) 40 * todr_setwen: provide a machine-dependent TOD clock write-enable callback 41 * function which takes one boolean argument: 42 * 1 to enable writes; 0 to disable writes. 43 */ 44 struct todr_chip_handle { 45 void *cookie; /* Device specific data */ 46 void *bus_cookie; /* Bus specific data */ 47 48 int todr_quality; 49 int (*todr_gettime)(struct todr_chip_handle *, struct timeval *); 50 int (*todr_settime)(struct todr_chip_handle *, struct timeval *); 51 int (*todr_setwen)(struct todr_chip_handle *, int); 52 }; 53 typedef struct todr_chip_handle *todr_chip_handle_t; 54 55 #define todr_gettime(ct, t) ((*(ct)->todr_gettime)(ct, t)) 56 #define todr_settime(ct, t) ((*(ct)->todr_settime)(ct, t)) 57 #define todr_wenable(ct, v) if ((ct)->todr_setwen) \ 58 ((*(ct)->todr_setwen)(ct, v)) 59 60 void todr_attach(struct todr_chip_handle *); 61