sys/dev/mc146818/mc146818var.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2003 Izumi Tsutsui.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  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  *      $NetBSD: mc146818var.h,v 1.7 2008/05/14 13:29:29 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
  42         u_int sc_flag;                          /* MD flags */
  43 #define MC146818_NO_CENT_ADJUST 0x0001          /* don't adjust century */
  44 #define MC146818_BCD            0x0002          /* use BCD mode */
  45 #define MC146818_12HR           0x0004          /* use AM/PM mode */
  46
  47         /* MD chip register read/write functions */
  48         u_int (*sc_mcread)(device_t dev, u_int reg);
  49         void (*sc_mcwrite)(device_t dev, u_int reg, u_int val);
  50         /* MD century get/set functions */
  51         u_int (*sc_getcent)(device_t dev);
  52         void (*sc_setcent)(device_t dev, u_int cent);
  53 };
  54
  55 /* Default read/write functions */
  56 u_int mc146818_def_read(device_t dev, u_int reg);
  57 void mc146818_def_write(device_t dev, u_int reg, u_int val);
  58
  59 /* Chip attach function */
  60 int mc146818_attach(device_t);
  61
  62 /* Methods for the clock interface */
  63 #ifdef notyet
  64 int mc146818_getsecs(device_t dev, int *secp);
  65 #endif
  66 int mc146818_gettime(device_t dev, struct timespec *ts);
  67 int mc146818_settime(device_t dev, struct timespec *ts);