clock_subr.h 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. /* $OpenBSD: clock_subr.h,v 1.5 2008/06/26 05:42:14 ray Exp $ */
  2. /* $NetBSD: clock_subr.h,v 1.2 1997/03/15 18:11:17 is Exp $ */
  3. /*-
  4. * Copyright (c) 1996 The NetBSD Foundation, Inc.
  5. * All rights reserved.
  6. *
  7. * This code is derived from software contributed to The NetBSD Foundation
  8. * by Gordon W. Ross
  9. *
  10. * Redistribution and use in source and binary forms, with or without
  11. * modification, are permitted provided that the following conditions
  12. * are met:
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in the
  17. * documentation and/or other materials provided with the distribution.
  18. *
  19. * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20. * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21. * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23. * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29. * POSSIBILITY OF SUCH DAMAGE.
  30. */
  31. /*
  32. * Interface to time-of-day clock devices.
  33. *
  34. * todr_gettime: convert time-of-day clock into a `struct timeval'
  35. * todr_settime: set time-of-day clock from a `struct timeval'
  36. * todr_getcal: get current TOD clock calibration value in ppm
  37. * todr_setcal: set calibration value in ppm in TOD clock
  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. int (*todr_gettime)(struct todr_chip_handle *, struct timeval *);
  48. int (*todr_settime)(struct todr_chip_handle *, struct timeval *);
  49. int (*todr_getcal)(struct todr_chip_handle *, int *);
  50. int (*todr_setcal)(struct todr_chip_handle *, int);
  51. int (*todr_setwen)(struct todr_chip_handle *, int);
  52. };
  53. typedef struct todr_chip_handle *todr_chip_handle_t;
  54. #define todr_gettime(ct, t) ((*(ct)->todr_gettime)(ct, t))
  55. #define todr_settime(ct, t) ((*(ct)->todr_settime)(ct, t))
  56. #define todr_getcal(ct, vp) ((*(ct)->todr_gettime)(ct, vp))
  57. #define todr_setcal(ct, v) ((*(ct)->todr_settime)(ct, v))
  58. #define todr_wenable(ct, v) if ((ct)->todr_setwen) \
  59. ((*(ct)->todr_setwen)(ct, v))