sys/dev/mc146818/mc146818var.h

   1 /*-
   2  * Copyright (c) 2003 Izumi Tsutsui.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  *
  24  *      $NetBSD: mc146818var.h,v 1.7 2008/05/14 13:29:29 tsutsui Exp $
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 struct mc146818_softc {
  30         bus_space_tag_t sc_bst;                 /* bus space tag */
  31         bus_space_handle_t sc_bsh;              /* bus space handle */
  32
  33         struct mtx sc_mtx;                      /* hardware mutex */
  34
  35         u_char sc_rega;                         /* register A */
  36         u_char sc_regb;                         /* register B */
  37
  38         u_int sc_year0;                         /* year counter offset */
  39
  40         u_int sc_flag;                          /* MD flags */
  41 #define MC146818_NO_CENT_ADJUST 0x0001          /* don't adjust century */
  42 #define MC146818_BCD            0x0002          /* use BCD mode */
  43 #define MC146818_12HR           0x0004          /* use AM/PM mode */
  44
  45         /* MD chip register read/write functions */
  46         u_int (*sc_mcread)(device_t dev, u_int reg);
  47         void (*sc_mcwrite)(device_t dev, u_int reg, u_int val);
  48         /* MD century get/set functions */
  49         u_int (*sc_getcent)(device_t dev);
  50         void (*sc_setcent)(device_t dev, u_int cent);
  51 };
  52
  53 /* Default read/write functions */
  54 u_int mc146818_def_read(device_t dev, u_int reg);
  55 void mc146818_def_write(device_t dev, u_int reg, u_int val);
  56
  57 /* Chip attach function */
  58 int mc146818_attach(device_t);
  59
  60 /* Methods for the clock interface */
  61 #ifdef notyet
  62 int mc146818_getsecs(device_t dev, int *secp);
  63 #endif
  64 int mc146818_gettime(device_t dev, struct timespec *ts);
  65 int mc146818_settime(device_t dev, struct timespec *ts);