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  * 3. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  *      from: NetBSD: mc146818var.h,v 1.3 2003/11/24 06:20:40 tsutsui Exp
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 struct mc146818_softc {
  32         bus_space_tag_t sc_bst;                 /* bus space tag */
  33         bus_space_handle_t sc_bsh;              /* bus space handle */
  34
  35         struct mtx sc_mtx;                      /* hardware mutex */
  36
  37         u_char sc_rega;                         /* register A */
  38         u_char sc_regb;                         /* register B */
  39
  40         u_int sc_year0;                         /* year counter offset */
  41         u_int sc_flag;                          /* MD flags */
  42 #define MC146818_NO_CENT_ADJUST 0x0001          /* don't adjust century */
  43 #define MC146818_BCD            0x0002          /* use BCD mode */
  44 #define MC146818_12HR           0x0004          /* use AM/PM mode */
  45
  46         /* MD chip register read/write functions */
  47         u_int (*sc_mcread)(device_t, u_int);
  48         void (*sc_mcwrite)(device_t, u_int, u_int);
  49         /* MD century get/set functions */
  50         u_int (*sc_getcent)(device_t);
  51         void (*sc_setcent)(device_t, u_int);
  52 };
  53
  54 /* Default read/write functions */
  55 u_int mc146818_def_read(device_t, u_int);
  56 void mc146818_def_write(device_t, u_int, u_int);
  57
  58 /* Chip attach function */
  59 int mc146818_attach(device_t);
  60
  61 /* Methods for the clock interface */
  62 #ifdef notyet
  63 int mc146818_getsecs(device_t, int *);
  64 #endif
  65 int mc146818_gettime(device_t, struct timespec *);
  66 int mc146818_settime(device_t, struct timespec *);