xref: /freebsd/sys/amd64/vmm/io/vrtc.h (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
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  * $FreeBSD$
29  */
30 
31 #ifndef _VRTC_H_
32 #define	_VRTC_H_
33 
34 #include <isa/isareg.h>
35 
36 struct vrtc;
37 struct vm_snapshot_meta;
38 
39 struct vrtc *vrtc_init(struct vm *vm);
40 void vrtc_cleanup(struct vrtc *vrtc);
41 void vrtc_reset(struct vrtc *vrtc);
42 
43 time_t vrtc_get_time(struct vm *vm);
44 int vrtc_set_time(struct vm *vm, time_t secs);
45 int vrtc_nvram_write(struct vm *vm, int offset, uint8_t value);
46 int vrtc_nvram_read(struct vm *vm, int offset, uint8_t *retval);
47 
48 int vrtc_addr_handler(struct vm *vm, bool in, int port, int bytes,
49     uint32_t *val);
50 int vrtc_data_handler(struct vm *vm, bool in, int port, int bytes,
51     uint32_t *val);
52 
53 #ifdef BHYVE_SNAPSHOT
54 int vrtc_snapshot(struct vrtc *vrtc, struct vm_snapshot_meta *meta);
55 #endif
56 
57 #endif
58