xref: /freebsd-10.3-release/sys/dev/mc146818/mc146818var.h

/*-
 * Copyright (c) 2003 Izumi Tsutsui.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *	from: NetBSD: mc146818var.h,v 1.3 2003/11/24 06:20:40 tsutsui Exp
 *
 * $FreeBSD: head/sys/dev/mc146818/mc146818var.h 201008 2009-12-25 22:53:46Z marius $
 */

struct mc146818_softc {
	bus_space_tag_t	sc_bst;			/* bus space tag */
	bus_space_handle_t sc_bsh;		/* bus space handle */

	struct mtx sc_mtx;			/* hardware mutex */

	u_char sc_rega;				/* register A */
	u_char sc_regb;				/* register B */

	u_int sc_year0;				/* year counter offset */

	u_int sc_flag;				/* MD flags */
#define	MC146818_NO_CENT_ADJUST	0x0001		/* don't adjust century */
#define	MC146818_BCD		0x0002		/* use BCD mode */
#define	MC146818_12HR		0x0004		/* use AM/PM mode */

	/* MD chip register read/write functions */
	u_int (*sc_mcread)(device_t dev, u_int reg);
	void (*sc_mcwrite)(device_t dev, u_int reg, u_int val);
	/* MD century get/set functions */
	u_int (*sc_getcent)(device_t dev);
	void (*sc_setcent)(device_t dev, u_int cent);
};

/* Default read/write functions */
u_int mc146818_def_read(device_t dev, u_int reg);
void mc146818_def_write(device_t dev, u_int reg, u_int val);

/* Chip attach function */
int mc146818_attach(device_t);

/* Methods for the clock interface */
#ifdef notyet
int mc146818_getsecs(device_t dev, int *secp);
#endif
int mc146818_gettime(device_t dev, struct timespec *ts);
int mc146818_settime(device_t dev, struct timespec *ts);