xref: /illumos-gate/usr/src/uts/intel/io/vmm/io/vrtc.h (revision fdad6fbf87b201fdb96a704fc41fa8be1e4efbc8)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2014 Neel Natu (neel@freebsd.org)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /*
30  * This file and its contents are supplied under the terms of the
31  * Common Development and Distribution License ("CDDL"), version 1.0.
32  * You may only use this file in accordance with the terms of version
33  * 1.0 of the CDDL.
34  *
35  * A full copy of the text of the CDDL should have accompanied this
36  * source.  A copy of the CDDL is also available via the Internet at
37  * http://www.illumos.org/license/CDDL.
38  */
39 /* This file is dual-licensed; see usr/src/contrib/bhyve/LICENSE */
40 
41 /*
42  * Copyright 2018 Joyent, Inc.
43  * Copyright 2023 Oxide Computer Company
44  */
45 
46 #ifndef _VRTC_H_
47 #define	_VRTC_H_
48 
49 #include <isa/isareg.h>
50 
51 struct vrtc;
52 
53 struct vrtc *vrtc_init(struct vm *vm);
54 void vrtc_cleanup(struct vrtc *vrtc);
55 void vrtc_reset(struct vrtc *vrtc);
56 
57 void vrtc_get_time(struct vm *vm, timespec_t *);
58 int vrtc_set_time(struct vm *vm, const timespec_t *);
59 int vrtc_nvram_write(struct vm *vm, int offset, uint8_t value);
60 int vrtc_nvram_read(struct vm *vm, int offset, uint8_t *retval);
61 
62 int vrtc_addr_handler(void *arg, bool in, uint16_t port, uint8_t bytes,
63     uint32_t *val);
64 int vrtc_data_handler(void *arg, bool in, uint16_t port, uint8_t bytes,
65     uint32_t *val);
66 
67 void vrtc_localize_resources(struct vrtc *);
68 void vrtc_pause(struct vrtc *);
69 void vrtc_resume(struct vrtc *);
70 
71 #endif
72